diff --git a/404.html b/404.html index 3d649c2d..baa98311 100644 --- a/404.html +++ b/404.html @@ -8,13 +8,13 @@ Page Not Found | Compass - +
Skip to main content

Page Not Found

We could not find what you were looking for.

Please contact the owner of the site that linked you to the original URL and let them know their link is broken.

- + \ No newline at end of file diff --git a/assets/js/91c76d4c.cdcf4bf4.js b/assets/js/91c76d4c.cdcf4bf4.js new file mode 100644 index 00000000..e6a75939 --- /dev/null +++ b/assets/js/91c76d4c.cdcf4bf4.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkcompass=self.webpackChunkcompass||[]).push([[960],{3905:function(e,s,t){t.d(s,{Zo:function(){return p},kt:function(){return m}});var a=t(7294);function n(e,s,t){return s in e?Object.defineProperty(e,s,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[s]=t,e}function o(e,s){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);s&&(a=a.filter((function(s){return Object.getOwnPropertyDescriptor(e,s).enumerable}))),t.push.apply(t,a)}return t}function i(e){for(var s=1;s=0||(n[t]=e[t]);return n}(e,s);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var l=a.createContext({}),c=function(e){var s=a.useContext(l),t=s;return e&&(t="function"==typeof e?e(s):i(i({},s),e)),t},p=function(e){var s=c(e.components);return a.createElement(l.Provider,{value:s},e.children)},d={inlineCode:"code",wrapper:function(e){var s=e.children;return a.createElement(a.Fragment,{},s)}},u=a.forwardRef((function(e,s){var t=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,p=r(e,["components","mdxType","originalType","parentName"]),u=c(t),m=n,f=u["".concat(l,".").concat(m)]||u[m]||d[m]||o;return t?a.createElement(f,i(i({ref:s},p),{},{components:t})):a.createElement(f,i({ref:s},p))}));function m(e,s){var t=arguments,n=s&&s.mdxType;if("string"==typeof e||n){var o=t.length,i=new Array(o);i[0]=u;var r={};for(var l in s)hasOwnProperty.call(s,l)&&(r[l]=s[l]);r.originalType=e,r.mdxType="string"==typeof e?e:n,i[1]=r;for(var c=2;ccompass asset",id:"compass-asset",level:2},{value:"compass asset delete <id>",id:"compass-asset-delete-id",level:3},{value:"compass asset edit [flags]",id:"compass-asset-edit-flags",level:3},{value:"compass asset list [flags]",id:"compass-asset-list-flags",level:3},{value:"compass asset star <id>",id:"compass-asset-star-id",level:3},{value:"compass asset stargazers <id> [flags]",id:"compass-asset-stargazers-id-flags",level:3},{value:"compass asset starred [flags]",id:"compass-asset-starred-flags",level:3},{value:"compass asset types [flags]",id:"compass-asset-types-flags",level:3},{value:"compass asset unstar <id>",id:"compass-asset-unstar-id",level:3},{value:"compass asset version <urn> <version>",id:"compass-asset-version-urn-version",level:3},{value:"compass asset versionhistory <id> [flags]",id:"compass-asset-versionhistory-id-flags",level:3},{value:"compass asset view <urn>",id:"compass-asset-view-urn",level:3},{value:"compass completion [bash|zsh|fish|powershell]",id:"compass-completion-bashzshfishpowershell",level:2},{value:"compass config <command>",id:"compass-config-command",level:2},{value:"compass config init",id:"compass-config-init",level:3},{value:"compass config list",id:"compass-config-list",level:3},{value:"compass discussion",id:"compass-discussion",level:2},{value:"compass discussion list [flags]",id:"compass-discussion-list-flags",level:3},{value:"compass discussion post [flags]",id:"compass-discussion-post-flags",level:3},{value:"compass discussion view <id>",id:"compass-discussion-view-id",level:3},{value:"compass lineage <urn>",id:"compass-lineage-urn",level:2},{value:"compass search <text> [flags]",id:"compass-search-text-flags",level:2},{value:"compass server <command>",id:"compass-server-command",level:2},{value:"compass server migrate",id:"compass-server-migrate",level:3},{value:"compass server start",id:"compass-server-start",level:3},{value:"compass version",id:"compass-version",level:2}],u={toc:d};function m(e){var s=e.components,t=(0,n.Z)(e,i);return(0,o.kt)("wrapper",(0,a.Z)({},u,t,{components:s,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"cli"},"CLI"),(0,o.kt)("p",null,'Run "compass config init" to initialize a new configuartion file\nRun "compass help environment" for more information.'),(0,o.kt)("p",null,'Alternatively, make a "compass.yaml" file in the current directory from the example given'),(0,o.kt)("h1",{id:"compass-reference"},"compass reference"),(0,o.kt)("h2",{id:"compass-asset"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass asset")),(0,o.kt)("p",null,"Manage assets"),(0,o.kt)("h3",{id:"compass-asset-delete-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset delete ")),(0,o.kt)("p",null,"delete asset with the given ID"),(0,o.kt)("h3",{id:"compass-asset-edit-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset edit [flags]")),(0,o.kt)("p",null,"upsert a new asset or patch"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-b, --body string filepath to body that has to be upserted\n")),(0,o.kt)("h3",{id:"compass-asset-list-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset list [flags]")),(0,o.kt)("p",null,"lists all assets"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},'-d, --data stringToString filter by field in asset.data (default [])\n-o, --out -o json flag to control output viewing, for json -o json (default "table")\n --page uint32 Page number offset (starts from 0)\n --query string querying by field\n --query_fields string querying by fields\n-s, --services string filter by services\n --size uint32 Size of each page (default 10)\n --sort string sort by certain fields\n --sort_dir string sorting direction (asc / desc)\n-t, --types string filter by types\n')),(0,o.kt)("h3",{id:"compass-asset-star-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset star ")),(0,o.kt)("p",null,"star an asset by id for current user"),(0,o.kt)("h3",{id:"compass-asset-stargazers-id-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset stargazers [flags]")),(0,o.kt)("p",null,"list all stargazers for a given asset id"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"--page uint32 Page number offset (starts from 0)\n--size uint32 Size of each page (default 10)\n")),(0,o.kt)("h3",{id:"compass-asset-starred-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset starred [flags]")),(0,o.kt)("p",null,"list all the starred assets for current user"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},'-o, --out -o json flag to control output viewing, for json -o json (default "table")\n --page uint32 Page number offset (starts from 0)\n --size uint32 Size of each page (default 10)\n')),(0,o.kt)("h3",{id:"compass-asset-types-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset types [flags]")),(0,o.kt)("p",null,"lists all asset types"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-d, --data stringToString filter by field in asset.data (default [])\n --query string filter by specific query\n --query_fields string filter by query field\n-s, --services string filter by services\n-t, --types string filter by types\n")),(0,o.kt)("h3",{id:"compass-asset-unstar-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset unstar ")),(0,o.kt)("p",null,"unstar an asset by id for current user"),(0,o.kt)("h3",{id:"compass-asset-version-urn-version"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset version ")),(0,o.kt)("p",null,"get asset's previous version by urn or id and version number"),(0,o.kt)("h3",{id:"compass-asset-versionhistory-id-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset versionhistory [flags]")),(0,o.kt)("p",null,"get asset version history by id"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"--page uint32 Page number offset (start from 0)\n--size uint32 Size of each page (default 10)\n")),(0,o.kt)("h3",{id:"compass-asset-view-urn"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset view ")),(0,o.kt)("p",null,"view asset for the given ID or URN"),(0,o.kt)("h2",{id:"compass-completion-bashzshfishpowershell"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass completion [bash|zsh|fish|powershell]")),(0,o.kt)("p",null,"Generate shell completion scripts"),(0,o.kt)("h2",{id:"compass-config-command"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass config ")),(0,o.kt)("p",null,"Manage server and client configurations"),(0,o.kt)("h3",{id:"compass-config-init"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass config init")),(0,o.kt)("p",null,"Initialize a new sevrer and client configuration"),(0,o.kt)("h3",{id:"compass-config-list"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass config list")),(0,o.kt)("p",null,"List server and client configuration settings"),(0,o.kt)("h2",{id:"compass-discussion"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass discussion")),(0,o.kt)("p",null,"Manage discussions"),(0,o.kt)("h3",{id:"compass-discussion-list-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass discussion list [flags]")),(0,o.kt)("p",null,"lists all discussions"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},'-o, --out -o json flag to control output viewing, for json -o json (default "table")\n')),(0,o.kt)("h3",{id:"compass-discussion-post-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass discussion post [flags]")),(0,o.kt)("p",null,"post discussions, add "),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-b, --body string filepath to body that has to be upserted\n")),(0,o.kt)("h3",{id:"compass-discussion-view-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass discussion view ")),(0,o.kt)("p",null,"view discussion for the given ID"),(0,o.kt)("h2",{id:"compass-lineage-urn"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass lineage ")),(0,o.kt)("p",null,"observe the lineage of metadata"),(0,o.kt)("h2",{id:"compass-search-text-flags"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass search [flags]")),(0,o.kt)("p",null,"query the metadata available"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-f, --filter string --filter=field_key1:val1,key2:val2,key3:val3 gives exact match for values\n-q, --query string --query=--filter=field_key1:val1 supports fuzzy search\n-r, --rankby string --rankby=\n-s, --size uint32 --size=10 maximum size of response query\n")),(0,o.kt)("h2",{id:"compass-server-command"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass server ")),(0,o.kt)("p",null,"Run compass server"),(0,o.kt)("h3",{id:"compass-server-migrate"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass server migrate")),(0,o.kt)("p",null,"Run storage migration"),(0,o.kt)("h3",{id:"compass-server-start"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass server start")),(0,o.kt)("p",null,"Start server on default port 8080"),(0,o.kt)("h2",{id:"compass-version"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass version")),(0,o.kt)("p",null,"Print version information"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/91c76d4c.f33fdb26.js b/assets/js/91c76d4c.f33fdb26.js deleted file mode 100644 index 4d27a808..00000000 --- a/assets/js/91c76d4c.f33fdb26.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkcompass=self.webpackChunkcompass||[]).push([[960],{3905:function(e,s,t){t.d(s,{Zo:function(){return p},kt:function(){return m}});var a=t(7294);function n(e,s,t){return s in e?Object.defineProperty(e,s,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[s]=t,e}function o(e,s){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);s&&(a=a.filter((function(s){return Object.getOwnPropertyDescriptor(e,s).enumerable}))),t.push.apply(t,a)}return t}function i(e){for(var s=1;s=0||(n[t]=e[t]);return n}(e,s);if(Object.getOwnPropertySymbols){var o=Object.getOwnPropertySymbols(e);for(a=0;a=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(n[t]=e[t])}return n}var l=a.createContext({}),c=function(e){var s=a.useContext(l),t=s;return e&&(t="function"==typeof e?e(s):i(i({},s),e)),t},p=function(e){var s=c(e.components);return a.createElement(l.Provider,{value:s},e.children)},d={inlineCode:"code",wrapper:function(e){var s=e.children;return a.createElement(a.Fragment,{},s)}},u=a.forwardRef((function(e,s){var t=e.components,n=e.mdxType,o=e.originalType,l=e.parentName,p=r(e,["components","mdxType","originalType","parentName"]),u=c(t),m=n,f=u["".concat(l,".").concat(m)]||u[m]||d[m]||o;return t?a.createElement(f,i(i({ref:s},p),{},{components:t})):a.createElement(f,i({ref:s},p))}));function m(e,s){var t=arguments,n=s&&s.mdxType;if("string"==typeof e||n){var o=t.length,i=new Array(o);i[0]=u;var r={};for(var l in s)hasOwnProperty.call(s,l)&&(r[l]=s[l]);r.originalType=e,r.mdxType="string"==typeof e?e:n,i[1]=r;for(var c=2;ccompass asset",id:"compass-asset",level:2},{value:"compass asset delete <id>",id:"compass-asset-delete-id",level:3},{value:"compass asset edit [flags]",id:"compass-asset-edit-flags",level:3},{value:"compass asset list [flags]",id:"compass-asset-list-flags",level:3},{value:"compass asset star <id>",id:"compass-asset-star-id",level:3},{value:"compass asset stargazers <id> [flags]",id:"compass-asset-stargazers-id-flags",level:3},{value:"compass asset starred [flags]",id:"compass-asset-starred-flags",level:3},{value:"compass asset types [flags]",id:"compass-asset-types-flags",level:3},{value:"compass asset unstar <id>",id:"compass-asset-unstar-id",level:3},{value:"compass asset version <urn> <version>",id:"compass-asset-version-urn-version",level:3},{value:"compass asset versionhistory <id> [flags]",id:"compass-asset-versionhistory-id-flags",level:3},{value:"compass asset view <urn>",id:"compass-asset-view-urn",level:3},{value:"compass completion [bash|zsh|fish|powershell]",id:"compass-completion-bashzshfishpowershell",level:2},{value:"compass config <command>",id:"compass-config-command",level:2},{value:"compass config init",id:"compass-config-init",level:3},{value:"compass config list",id:"compass-config-list",level:3},{value:"compass discussion",id:"compass-discussion",level:2},{value:"compass discussion list [flags]",id:"compass-discussion-list-flags",level:3},{value:"compass discussion post [flags]",id:"compass-discussion-post-flags",level:3},{value:"compass discussion view <id>",id:"compass-discussion-view-id",level:3},{value:"compass lineage <urn>",id:"compass-lineage-urn",level:2},{value:"compass search <text> [flags]",id:"compass-search-text-flags",level:2},{value:"compass server <command>",id:"compass-server-command",level:2},{value:"compass server migrate",id:"compass-server-migrate",level:3},{value:"compass server start",id:"compass-server-start",level:3},{value:"compass version",id:"compass-version",level:2}],u={toc:d};function m(e){var s=e.components,t=(0,n.Z)(e,i);return(0,o.kt)("wrapper",(0,a.Z)({},u,t,{components:s,mdxType:"MDXLayout"}),(0,o.kt)("h1",{id:"cli"},"CLI"),(0,o.kt)("h2",{id:"compass-asset"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass asset")),(0,o.kt)("p",null,"Manage assets"),(0,o.kt)("h3",{id:"compass-asset-delete-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset delete ")),(0,o.kt)("p",null,"delete asset with the given ID"),(0,o.kt)("h3",{id:"compass-asset-edit-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset edit [flags]")),(0,o.kt)("p",null,"upsert a new asset or patch"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-b, --body string filepath to body that has to be upserted\n")),(0,o.kt)("h3",{id:"compass-asset-list-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset list [flags]")),(0,o.kt)("p",null,"lists all assets"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},'-d, --data stringToString filter by field in asset.data (default [])\n-o, --out -o json flag to control output viewing, for json -o json (default "table")\n --page uint32 Page number offset (starts from 0)\n --query string querying by field\n --query_fields string querying by fields\n-s, --services string filter by services\n --size uint32 Size of each page (default 10)\n --sort string sort by certain fields\n --sort_dir string sorting direction (asc / desc)\n-t, --types string filter by types\n')),(0,o.kt)("h3",{id:"compass-asset-star-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset star ")),(0,o.kt)("p",null,"star an asset by id for current user"),(0,o.kt)("h3",{id:"compass-asset-stargazers-id-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset stargazers [flags]")),(0,o.kt)("p",null,"list all stargazers for a given asset id"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"--page uint32 Page number offset (starts from 0)\n--size uint32 Size of each page (default 10)\n")),(0,o.kt)("h3",{id:"compass-asset-starred-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset starred [flags]")),(0,o.kt)("p",null,"list all the starred assets for current user"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},'-o, --out -o json flag to control output viewing, for json -o json (default "table")\n --page uint32 Page number offset (starts from 0)\n --size uint32 Size of each page (default 10)\n')),(0,o.kt)("h3",{id:"compass-asset-types-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset types [flags]")),(0,o.kt)("p",null,"lists all asset types"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-d, --data stringToString filter by field in asset.data (default [])\n --query string filter by specific query\n --query_fields string filter by query field\n-s, --services string filter by services\n-t, --types string filter by types\n")),(0,o.kt)("h3",{id:"compass-asset-unstar-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset unstar ")),(0,o.kt)("p",null,"unstar an asset by id for current user"),(0,o.kt)("h3",{id:"compass-asset-version-urn-version"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset version ")),(0,o.kt)("p",null,"get asset's previous version by urn or id and version number"),(0,o.kt)("h3",{id:"compass-asset-versionhistory-id-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset versionhistory [flags]")),(0,o.kt)("p",null,"get asset version history by id"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"--page uint32 Page number offset (start from 0)\n--size uint32 Size of each page (default 10)\n")),(0,o.kt)("h3",{id:"compass-asset-view-urn"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass asset view ")),(0,o.kt)("p",null,"view asset for the given ID or URN"),(0,o.kt)("h2",{id:"compass-completion-bashzshfishpowershell"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass completion [bash|zsh|fish|powershell]")),(0,o.kt)("p",null,"Generate shell completion scripts"),(0,o.kt)("h2",{id:"compass-config-command"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass config ")),(0,o.kt)("p",null,"Manage server and client configurations"),(0,o.kt)("h3",{id:"compass-config-init"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass config init")),(0,o.kt)("p",null,"Initialize a new sevrer and client configuration"),(0,o.kt)("h3",{id:"compass-config-list"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass config list")),(0,o.kt)("p",null,"List server and client configuration settings"),(0,o.kt)("h2",{id:"compass-discussion"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass discussion")),(0,o.kt)("p",null,"Manage discussions"),(0,o.kt)("h3",{id:"compass-discussion-list-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass discussion list [flags]")),(0,o.kt)("p",null,"lists all discussions"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},'-o, --out -o json flag to control output viewing, for json -o json (default "table")\n')),(0,o.kt)("h3",{id:"compass-discussion-post-flags"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass discussion post [flags]")),(0,o.kt)("p",null,"post discussions, add "),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-b, --body string filepath to body that has to be upserted\n")),(0,o.kt)("h3",{id:"compass-discussion-view-id"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass discussion view ")),(0,o.kt)("p",null,"view discussion for the given ID"),(0,o.kt)("h2",{id:"compass-lineage-urn"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass lineage ")),(0,o.kt)("p",null,"observe the lineage of metadata"),(0,o.kt)("h2",{id:"compass-search-text-flags"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass search [flags]")),(0,o.kt)("p",null,"query the metadata available"),(0,o.kt)("pre",null,(0,o.kt)("code",{parentName:"pre"},"-f, --filter string --filter=field_key1:val1,key2:val2,key3:val3 gives exact match for values\n-q, --query string --query=--filter=field_key1:val1 supports fuzzy search\n-r, --rankby string --rankby=\n-s, --size uint32 --size=10 maximum size of response query\n")),(0,o.kt)("h2",{id:"compass-server-command"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass server ")),(0,o.kt)("p",null,"Run compass server"),(0,o.kt)("h3",{id:"compass-server-migrate"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass server migrate")),(0,o.kt)("p",null,"Run storage migration"),(0,o.kt)("h3",{id:"compass-server-start"},(0,o.kt)("inlineCode",{parentName:"h3"},"compass server start")),(0,o.kt)("p",null,"Start server on default port 8080"),(0,o.kt)("h2",{id:"compass-version"},(0,o.kt)("inlineCode",{parentName:"h2"},"compass version")),(0,o.kt)("p",null,"Print version information"))}m.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.030d8b66.js b/assets/js/935f2afb.030d8b66.js deleted file mode 100644 index 0c292566..00000000 --- a/assets/js/935f2afb.030d8b66.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkcompass=self.webpackChunkcompass||[]).push([[53],{1109:function(e){e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docsSidebar":[{"type":"link","label":"Introduction","href":"/compass/","docId":"introduction"},{"type":"link","label":"Installation","href":"/compass/installation","docId":"installation"},{"type":"link","label":"Configuration","href":"/compass/configuration","docId":"configuration"},{"type":"category","label":"Tour","items":[{"type":"link","label":"Introduction","href":"/compass/tour/introduction","docId":"tour/introduction"},{"type":"link","label":"1. My First Asset","href":"/compass/tour/my-first-asset","docId":"tour/my-first-asset"},{"type":"link","label":"2. Querying your Assets","href":"/compass/tour/querying-assets","docId":"tour/querying-assets"},{"type":"link","label":"3. Asset Lineage","href":"/compass/tour/asset-lineage","docId":"tour/asset-lineage"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Guides","items":[{"type":"link","label":"Ingesting metadata","href":"/compass/guides/ingestion","docId":"guides/ingestion"},{"type":"link","label":"Querying metadata","href":"/compass/guides/querying","docId":"guides/querying"},{"type":"link","label":"Starring","href":"/compass/guides/starring","docId":"guides/starring"},{"type":"link","label":"Tagging","href":"/compass/guides/tagging","docId":"guides/tagging"},{"type":"link","label":"Discussion","href":"/compass/guides/discussion","docId":"guides/discussion"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Concepts","items":[{"type":"link","label":"Overview","href":"/compass/concepts/overview","docId":"concepts/overview"},{"type":"link","label":"Asset","href":"/compass/concepts/asset","docId":"concepts/asset"},{"type":"link","label":"Type","href":"/compass/concepts/type","docId":"concepts/type"},{"type":"link","label":"User","href":"/compass/concepts/user","docId":"concepts/user"},{"type":"link","label":"Architecture","href":"/compass/concepts/architecture","docId":"concepts/architecture"},{"type":"link","label":"Internals","href":"/compass/concepts/internals","docId":"concepts/internals"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Reference","items":[{"type":"link","label":"API","href":"/compass/reference/api","docId":"reference/api"},{"type":"link","label":"CLI","href":"/compass/reference/cli","docId":"reference/cli"},{"type":"link","label":"Configurations","href":"/compass/reference/configuration","docId":"reference/configuration"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contribute","items":[{"type":"link","label":"Contribution Process","href":"/compass/contribute/contributing","docId":"contribute/contributing"},{"type":"link","label":"Development Guide","href":"/compass/contribute/development-guide","docId":"contribute/development-guide"}],"collapsed":true,"collapsible":true},{"type":"link","label":"Roadmap","href":"/compass/roadmap","docId":"roadmap"}]},"docs":{"concepts/architecture":{"id":"concepts/architecture","title":"Architecture","description":"Compass\' architecture is pretty simple. It has a client-server architecture backed by PostgreSQL as a main storage and Elasticsearch as a secondary storage and provides HTTP & gRPC interface to interact with.","sidebar":"docsSidebar"},"concepts/asset":{"id":"concepts/asset","title":"Asset","description":"In Compass, we call every metadata that you input as an Asset. All your tables, dashboards, topics, jobs are an example of assets.","sidebar":"docsSidebar"},"concepts/internals":{"id":"concepts/internals","title":"Internals","description":"This document details information about how Compass interfaces with elasticsearch. It is meant to give an overview of how some concepts work internally, to help streamline understanding of how things work under the hood.","sidebar":"docsSidebar"},"concepts/overview":{"id":"concepts/overview","title":"Overview","description":"Compass has three major concept when it comes to data ingestion: Asset, Type, and Service.","sidebar":"docsSidebar"},"concepts/type":{"id":"concepts/type","title":"Type","description":"Each Asset will have a Type to represent the kind of metadata it represents. It is currently pre-defined by Compass, so no arbitrary types will be supported.","sidebar":"docsSidebar"},"concepts/user":{"id":"concepts/user","title":"User","description":"The current version of Compass does not have user management. Compass expects there is an external instance that manages user. Compass consumes user information from the configurable identity uuid header in every API call. The default name of the header is Compass-User-UUID.","sidebar":"docsSidebar"},"configuration":{"id":"configuration","title":"Configuration","description":"Compass binary contains both the CLI client and the server. Each has it\'s own configuration in order to run. Server configuration contains information such as database credentials, elastic search brokers, log severity, etc. while CLI client configuration only has configuration about which server to connect.","sidebar":"docsSidebar"},"contribute/contributing":{"id":"contribute/contributing","title":"Contribution Process","description":"BECOME A COMMITOR & CONTRIBUTE","sidebar":"docsSidebar"},"contribute/development-guide":{"id":"contribute/development-guide","title":"Development Guide","description":"","sidebar":"docsSidebar"},"guides/discussion":{"id":"guides/discussion","title":"Discussion","description":"Discussion is a new feature in Compass. One could create a discussion and all users can put comment in it. Currently, there are three types of discussions issues, open ended, and question and answer. Depending on the type, the discussion could have multiple possible states. In the current version, all types only have two states: open and closed. A newly created discussion will always be assign an open state.","sidebar":"docsSidebar"},"guides/ingestion":{"id":"guides/ingestion","title":"Ingesting metadata","description":"This document showcases compass usage, from producing data, to using APIs for specific use-cases. This guide is geared towards adminstrators, more than users. It is meant to give the administrators an introduction of different configuration options available, and how they affect the behaviour of the application.","sidebar":"docsSidebar"},"guides/querying":{"id":"guides/querying","title":"Querying metadata","description":"Prerequisites","sidebar":"docsSidebar"},"guides/starring":{"id":"guides/starring","title":"Starring","description":"Compass allows a user to stars an asset. This bookmarking functionality is introduced to increase the speed of a user to get information.","sidebar":"docsSidebar"},"guides/tagging":{"id":"guides/tagging","title":"Tagging","description":"This doc explains how to tag an asset in Compass with a specific tag.","sidebar":"docsSidebar"},"guides/telemetry":{"id":"guides/telemetry","title":"Telemetry","description":"Compass collects basic HTTP metrics (response time, duration, etc) and sends it to statsd and New Relic when enabled."},"installation":{"id":"installation","title":"Installation","description":"There are several approaches to install Compass.","sidebar":"docsSidebar"},"introduction":{"id":"introduction","title":"Introduction","description":"Welcome to the introductory guide to Compass! This guide is the best place to start with Compass. We cover what Compass is, what problems it can solve, how it works, and how you can get started using it. If you are familiar with the basics of Compass, the guide provides a more detailed reference of available features.","sidebar":"docsSidebar"},"reference/api":{"id":"reference/api","title":"API","description":"Documentation of our Compass API with gRPC and gRPC-Gateway.","sidebar":"docsSidebar"},"reference/cli":{"id":"reference/cli","title":"CLI","description":"compass asset","sidebar":"docsSidebar"},"reference/configuration":{"id":"reference/configuration","title":"Configurations","description":"This page contains reference for all the application configurations for Compass.","sidebar":"docsSidebar"},"roadmap":{"id":"roadmap","title":"Roadmap","description":"In the following section you can learn about what features we\'re working on, what stage they\'re in, and when we expect to bring them to you. Have any questions or comments about items on the roadmap? Join the discussions on Compass Github forum.","sidebar":"docsSidebar"},"tour/asset-lineage":{"id":"tour/asset-lineage","title":"3. Asset Lineage","description":"3.1 Inserting lineage","sidebar":"docsSidebar"},"tour/introduction":{"id":"tour/introduction","title":"Introduction","description":"This tour introduces you to Compass. Along the way you will learn how to ingest assets in Compass database, list, search and manage asset lineage.","sidebar":"docsSidebar"},"tour/my-first-asset":{"id":"tour/my-first-asset","title":"1. My First Asset","description":"Pre-Requisites","sidebar":"docsSidebar"},"tour/querying-assets":{"id":"tour/querying-assets","title":"2. Querying your Assets","description":"In this section, we will learn how we can find and search our assets using the following approaches:","sidebar":"docsSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.31f45a27.js b/assets/js/935f2afb.31f45a27.js new file mode 100644 index 00000000..0c231bed --- /dev/null +++ b/assets/js/935f2afb.31f45a27.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkcompass=self.webpackChunkcompass||[]).push([[53],{1109:function(e){e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docsSidebar":[{"type":"link","label":"Introduction","href":"/compass/","docId":"introduction"},{"type":"link","label":"Installation","href":"/compass/installation","docId":"installation"},{"type":"link","label":"Configuration","href":"/compass/configuration","docId":"configuration"},{"type":"category","label":"Tour","items":[{"type":"link","label":"Introduction","href":"/compass/tour/introduction","docId":"tour/introduction"},{"type":"link","label":"1. My First Asset","href":"/compass/tour/my-first-asset","docId":"tour/my-first-asset"},{"type":"link","label":"2. Querying your Assets","href":"/compass/tour/querying-assets","docId":"tour/querying-assets"},{"type":"link","label":"3. Asset Lineage","href":"/compass/tour/asset-lineage","docId":"tour/asset-lineage"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Guides","items":[{"type":"link","label":"Ingesting metadata","href":"/compass/guides/ingestion","docId":"guides/ingestion"},{"type":"link","label":"Querying metadata","href":"/compass/guides/querying","docId":"guides/querying"},{"type":"link","label":"Starring","href":"/compass/guides/starring","docId":"guides/starring"},{"type":"link","label":"Tagging","href":"/compass/guides/tagging","docId":"guides/tagging"},{"type":"link","label":"Discussion","href":"/compass/guides/discussion","docId":"guides/discussion"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Concepts","items":[{"type":"link","label":"Overview","href":"/compass/concepts/overview","docId":"concepts/overview"},{"type":"link","label":"Asset","href":"/compass/concepts/asset","docId":"concepts/asset"},{"type":"link","label":"Type","href":"/compass/concepts/type","docId":"concepts/type"},{"type":"link","label":"User","href":"/compass/concepts/user","docId":"concepts/user"},{"type":"link","label":"Architecture","href":"/compass/concepts/architecture","docId":"concepts/architecture"},{"type":"link","label":"Internals","href":"/compass/concepts/internals","docId":"concepts/internals"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Reference","items":[{"type":"link","label":"Compass","href":"/compass/reference/api","docId":"reference/api"},{"type":"link","label":"CLI","href":"/compass/reference/cli","docId":"reference/cli"},{"type":"link","label":"Configurations","href":"/compass/reference/configuration","docId":"reference/configuration"}],"collapsed":true,"collapsible":true},{"type":"category","label":"Contribute","items":[{"type":"link","label":"Contribution Process","href":"/compass/contribute/contributing","docId":"contribute/contributing"},{"type":"link","label":"Development Guide","href":"/compass/contribute/development-guide","docId":"contribute/development-guide"}],"collapsed":true,"collapsible":true},{"type":"link","label":"Roadmap","href":"/compass/roadmap","docId":"roadmap"}]},"docs":{"concepts/architecture":{"id":"concepts/architecture","title":"Architecture","description":"Compass\' architecture is pretty simple. It has a client-server architecture backed by PostgreSQL as a main storage and Elasticsearch as a secondary storage and provides HTTP & gRPC interface to interact with.","sidebar":"docsSidebar"},"concepts/asset":{"id":"concepts/asset","title":"Asset","description":"In Compass, we call every metadata that you input as an Asset. All your tables, dashboards, topics, jobs are an example of assets.","sidebar":"docsSidebar"},"concepts/internals":{"id":"concepts/internals","title":"Internals","description":"This document details information about how Compass interfaces with elasticsearch. It is meant to give an overview of how some concepts work internally, to help streamline understanding of how things work under the hood.","sidebar":"docsSidebar"},"concepts/overview":{"id":"concepts/overview","title":"Overview","description":"Compass has three major concept when it comes to data ingestion: Asset, Type, and Service.","sidebar":"docsSidebar"},"concepts/type":{"id":"concepts/type","title":"Type","description":"Each Asset will have a Type to represent the kind of metadata it represents. It is currently pre-defined by Compass, so no arbitrary types will be supported.","sidebar":"docsSidebar"},"concepts/user":{"id":"concepts/user","title":"User","description":"The current version of Compass does not have user management. Compass expects there is an external instance that manages user. Compass consumes user information from the configurable identity uuid header in every API call. The default name of the header is Compass-User-UUID.","sidebar":"docsSidebar"},"configuration":{"id":"configuration","title":"Configuration","description":"Compass binary contains both the CLI client and the server. Each has it\'s own configuration in order to run. Server configuration contains information such as database credentials, elastic search brokers, log severity, etc. while CLI client configuration only has configuration about which server to connect.","sidebar":"docsSidebar"},"contribute/contributing":{"id":"contribute/contributing","title":"Contribution Process","description":"BECOME A COMMITOR & CONTRIBUTE","sidebar":"docsSidebar"},"contribute/development-guide":{"id":"contribute/development-guide","title":"Development Guide","description":"","sidebar":"docsSidebar"},"guides/discussion":{"id":"guides/discussion","title":"Discussion","description":"Discussion is a new feature in Compass. One could create a discussion and all users can put comment in it. Currently, there are three types of discussions issues, open ended, and question and answer. Depending on the type, the discussion could have multiple possible states. In the current version, all types only have two states: open and closed. A newly created discussion will always be assign an open state.","sidebar":"docsSidebar"},"guides/ingestion":{"id":"guides/ingestion","title":"Ingesting metadata","description":"This document showcases compass usage, from producing data, to using APIs for specific use-cases. This guide is geared towards adminstrators, more than users. It is meant to give the administrators an introduction of different configuration options available, and how they affect the behaviour of the application.","sidebar":"docsSidebar"},"guides/querying":{"id":"guides/querying","title":"Querying metadata","description":"Prerequisites","sidebar":"docsSidebar"},"guides/starring":{"id":"guides/starring","title":"Starring","description":"Compass allows a user to stars an asset. This bookmarking functionality is introduced to increase the speed of a user to get information.","sidebar":"docsSidebar"},"guides/tagging":{"id":"guides/tagging","title":"Tagging","description":"This doc explains how to tag an asset in Compass with a specific tag.","sidebar":"docsSidebar"},"guides/telemetry":{"id":"guides/telemetry","title":"Telemetry","description":"Compass collects basic HTTP metrics (response time, duration, etc) and sends it to statsd and New Relic when enabled."},"installation":{"id":"installation","title":"Installation","description":"There are several approaches to install Compass.","sidebar":"docsSidebar"},"introduction":{"id":"introduction","title":"Introduction","description":"Welcome to the introductory guide to Compass! This guide is the best place to start with Compass. We cover what Compass is, what problems it can solve, how it works, and how you can get started using it. If you are familiar with the basics of Compass, the guide provides a more detailed reference of available features.","sidebar":"docsSidebar"},"reference/api":{"id":"reference/api","title":"Compass","description":"Documentation of our Compass API with gRPC and gRPC-Gateway.","sidebar":"docsSidebar"},"reference/cli":{"id":"reference/cli","title":"CLI","description":"Run \\"compass config init\\" to initialize a new configuartion file","sidebar":"docsSidebar"},"reference/configuration":{"id":"reference/configuration","title":"Configurations","description":"This page contains reference for all the application configurations for Compass.","sidebar":"docsSidebar"},"roadmap":{"id":"roadmap","title":"Roadmap","description":"In the following section you can learn about what features we\'re working on, what stage they\'re in, and when we expect to bring them to you. Have any questions or comments about items on the roadmap? Join the discussions on Compass Github forum.","sidebar":"docsSidebar"},"tour/asset-lineage":{"id":"tour/asset-lineage","title":"3. Asset Lineage","description":"3.1 Inserting lineage","sidebar":"docsSidebar"},"tour/introduction":{"id":"tour/introduction","title":"Introduction","description":"This tour introduces you to Compass. Along the way you will learn how to ingest assets in Compass database, list, search and manage asset lineage.","sidebar":"docsSidebar"},"tour/my-first-asset":{"id":"tour/my-first-asset","title":"1. My First Asset","description":"Pre-Requisites","sidebar":"docsSidebar"},"tour/querying-assets":{"id":"tour/querying-assets","title":"2. Querying your Assets","description":"In this section, we will learn how we can find and search our assets using the following approaches:","sidebar":"docsSidebar"}}}')}}]); \ No newline at end of file diff --git a/assets/js/a510c3a6.7ffa8ab2.js b/assets/js/a510c3a6.7ffa8ab2.js deleted file mode 100644 index 75e69f74..00000000 --- a/assets/js/a510c3a6.7ffa8ab2.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkcompass=self.webpackChunkcompass||[]).push([[300],{3905:function(e,n,t){t.d(n,{Zo:function(){return u},kt:function(){return m}});var r=t(7294);function a(e,n,t){return n in e?Object.defineProperty(e,n,{value:t,enumerable:!0,configurable:!0,writable:!0}):e[n]=t,e}function i(e,n){var t=Object.keys(e);if(Object.getOwnPropertySymbols){var r=Object.getOwnPropertySymbols(e);n&&(r=r.filter((function(n){return Object.getOwnPropertyDescriptor(e,n).enumerable}))),t.push.apply(t,r)}return t}function o(e){for(var n=1;n=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),c=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=c(e.components);return r.createElement(l.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),d=c(t),m=a,h=d["".concat(l,".").concat(m)]||d[m]||p[m]||i;return t?r.createElement(h,o(o({ref:n},u),{},{components:t})):r.createElement(h,o({ref:n},u))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=d;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var c=2;c=0||(a[t]=e[t]);return a}(e,n);if(Object.getOwnPropertySymbols){var i=Object.getOwnPropertySymbols(e);for(r=0;r=0||Object.prototype.propertyIsEnumerable.call(e,t)&&(a[t]=e[t])}return a}var l=r.createContext({}),c=function(e){var n=r.useContext(l),t=n;return e&&(t="function"==typeof e?e(n):o(o({},n),e)),t},u=function(e){var n=c(e.components);return r.createElement(l.Provider,{value:n},e.children)},p={inlineCode:"code",wrapper:function(e){var n=e.children;return r.createElement(r.Fragment,{},n)}},d=r.forwardRef((function(e,n){var t=e.components,a=e.mdxType,i=e.originalType,l=e.parentName,u=s(e,["components","mdxType","originalType","parentName"]),d=c(t),m=a,h=d["".concat(l,".").concat(m)]||d[m]||p[m]||i;return t?r.createElement(h,o(o({ref:n},u),{},{components:t})):r.createElement(h,o({ref:n},u))}));function m(e,n){var t=arguments,a=n&&n.mdxType;if("string"==typeof e||a){var i=t.length,o=new Array(i);o[0]=d;var s={};for(var l in n)hasOwnProperty.call(n,l)&&(s[l]=n[l]);s.originalType=e,s.mdxType="string"==typeof e?e:a,o[1]=s;for(var c=2;c=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var i=n.createContext({}),s=function(t){var e=n.useContext(i),a=e;return t&&(a="function"==typeof t?t(e):p(p({},e),t)),a},m=function(t){var e=s(t.components);return n.createElement(i.Provider,{value:e},t.children)},u={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},k=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,l=t.originalType,i=t.parentName,m=d(t,["components","mdxType","originalType","parentName"]),k=s(a),N=r,g=k["".concat(i,".").concat(N)]||k[N]||u[N]||l;return a?n.createElement(g,p(p({ref:e},m),{},{components:a})):n.createElement(g,p({ref:e},m))}));function N(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var l=a.length,p=new Array(l);p[0]=k;var d={};for(var i in e)hasOwnProperty.call(e,i)&&(d[i]=e[i]);d.originalType=t,d.mdxType="string"==typeof t?t:r,p[1]=d;for(var s=2;s&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th"),". As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description ",(0,l.kt)("inlineCode",{parentName:"p"},"/search/?text=&query[description]=bigqu")),(0,l.kt)("h5",{id:"parameters-10"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for (fuzzy)"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"rankby"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},'descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby',"[data.profile.usage_count]",'"'),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"number of results to return"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-10"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#searchassetsresponse"},"SearchAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1searchsuggest"},"/v1beta1/search/suggest"),(0,l.kt)("h4",{id:"get-7"},"GET"),(0,l.kt)("h5",{id:"summary-11"},"Summary"),(0,l.kt)("p",null,"Suggest an asset"),(0,l.kt)("h5",{id:"description-11"},"Description"),(0,l.kt)("p",null,"API for retreiving N number of asset names that similar with the ",(0,l.kt)("inlineCode",{parentName:"p"},"text"),". By default, N = 5 for now and hardcoded in the code."),(0,l.kt)("h5",{id:"parameters-11"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for suggestions"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-11"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#suggestassetsresponse"},"SuggestAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-1"},"default"),(0,l.kt)("h3",{id:"v1beta1discussions"},"/v1beta1/discussions"),(0,l.kt)("h4",{id:"get-8"},"GET"),(0,l.kt)("h5",{id:"summary-12"},"Summary"),(0,l.kt)("p",null,"Get all discussions"),(0,l.kt)("h5",{id:"parameters-12"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owner"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assignee"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-12"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalldiscussionsresponse"},"GetAllDiscussionsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-1"},"POST"),(0,l.kt)("h5",{id:"summary-13"},"Summary"),(0,l.kt)("p",null,"Create a discussion"),(0,l.kt)("h5",{id:"parameters-13"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Request to be sent to create a discussion"),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#creatediscussionrequest"},"CreateDiscussionRequest"))))),(0,l.kt)("h5",{id:"responses-13"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#creatediscussionresponse"},"CreateDiscussionResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcomments"},"/v1beta1/discussions/{discussion_id}/comments"),(0,l.kt)("h4",{id:"get-9"},"GET"),(0,l.kt)("h5",{id:"summary-14"},"Summary"),(0,l.kt)("p",null,"Get all comments of a discussion"),(0,l.kt)("h5",{id:"parameters-14"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-14"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getallcommentsresponse"},"GetAllCommentsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-2"},"POST"),(0,l.kt)("h5",{id:"summary-15"},"Summary"),(0,l.kt)("p",null,"Create a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-15"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-15"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createcommentresponse"},"CreateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcommentsid"},"/v1beta1/discussions/{discussion_id}/comments/{id}"),(0,l.kt)("h4",{id:"get-10"},"GET"),(0,l.kt)("h5",{id:"summary-16"},"Summary"),(0,l.kt)("p",null,"Get a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-16"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-16"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getcommentresponse"},"GetCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-1"},"DELETE"),(0,l.kt)("h5",{id:"summary-17"},"Summary"),(0,l.kt)("p",null,"Delete a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-17"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-17"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletecommentresponse"},"DeleteCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-1"},"PUT"),(0,l.kt)("h5",{id:"summary-18"},"Summary"),(0,l.kt)("p",null,"Update a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-18"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-18"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatecommentresponse"},"UpdateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsid"},"/v1beta1/discussions/{id}"),(0,l.kt)("h4",{id:"get-11"},"GET"),(0,l.kt)("h5",{id:"summary-19"},"Summary"),(0,l.kt)("p",null,"Get a discussion"),(0,l.kt)("h5",{id:"parameters-19"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-19"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getdiscussionresponse"},"GetDiscussionResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"patch-1"},"PATCH"),(0,l.kt)("h5",{id:"summary-20"},"Summary"),(0,l.kt)("p",null,"Patch a discussion"),(0,l.kt)("h5",{id:"parameters-20"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"assets"'),": ","[ string ]",", ",(0,l.kt)("strong",{parentName:"td"},'"assignees"'),": ","[ string ]",", ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"labels"'),": ","[ string ]",", ",(0,l.kt)("strong",{parentName:"td"},'"state"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"title"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"type"'),": string }")))),(0,l.kt)("h5",{id:"responses-20"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#patchdiscussionresponse"},"PatchDiscussionResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mediscussions"},"/v1beta1/me/discussions"),(0,l.kt)("h4",{id:"get-12"},"GET"),(0,l.kt)("h5",{id:"summary-21"},"Summary"),(0,l.kt)("p",null,"Get all discussions of a user"),(0,l.kt)("h5",{id:"description-12"},"Description"),(0,l.kt)("p",null,"Returns all discussions given possible filters of a user"),(0,l.kt)("h5",{id:"parameters-21"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"filter"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-21"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmydiscussionsresponse"},"GetMyDiscussionsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-2"},"default"),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcomments-1"},"/v1beta1/discussions/{discussion_id}/comments"),(0,l.kt)("h4",{id:"get-13"},"GET"),(0,l.kt)("h5",{id:"summary-22"},"Summary"),(0,l.kt)("p",null,"Get all comments of a discussion"),(0,l.kt)("h5",{id:"parameters-22"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-22"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getallcommentsresponse"},"GetAllCommentsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-3"},"POST"),(0,l.kt)("h5",{id:"summary-23"},"Summary"),(0,l.kt)("p",null,"Create a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-23"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-23"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createcommentresponse"},"CreateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcommentsid-1"},"/v1beta1/discussions/{discussion_id}/comments/{id}"),(0,l.kt)("h4",{id:"get-14"},"GET"),(0,l.kt)("h5",{id:"summary-24"},"Summary"),(0,l.kt)("p",null,"Get a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-24"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-24"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getcommentresponse"},"GetCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-2"},"DELETE"),(0,l.kt)("h5",{id:"summary-25"},"Summary"),(0,l.kt)("p",null,"Delete a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-25"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-25"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletecommentresponse"},"DeleteCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-2"},"PUT"),(0,l.kt)("h5",{id:"summary-26"},"Summary"),(0,l.kt)("p",null,"Update a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-26"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-26"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatecommentresponse"},"UpdateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-3"},"default"),(0,l.kt)("h3",{id:"v1beta1lineageurn-1"},"/v1beta1/lineage/{urn}"),(0,l.kt)("h4",{id:"get-15"},"GET"),(0,l.kt)("h5",{id:"summary-27"},"Summary"),(0,l.kt)("p",null,"Get Lineage Graph"),(0,l.kt)("h5",{id:"description-13"},"Description"),(0,l.kt)("p",null,"Returns the lineage graph. Each entry in the graph describes a (edge) directed relation of assets with source and destination using it's urn, type, and service."),(0,l.kt)("h5",{id:"parameters-27"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"level"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-27"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getgraphresponse"},"GetGraphResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-4"},"default"),(0,l.kt)("h3",{id:"v1beta1mediscussions-1"},"/v1beta1/me/discussions"),(0,l.kt)("h4",{id:"get-16"},"GET"),(0,l.kt)("h5",{id:"summary-28"},"Summary"),(0,l.kt)("p",null,"Get all discussions of a user"),(0,l.kt)("h5",{id:"description-14"},"Description"),(0,l.kt)("p",null,"Returns all discussions given possible filters of a user"),(0,l.kt)("h5",{id:"parameters-28"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"filter"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-28"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmydiscussionsresponse"},"GetMyDiscussionsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mestarred"},"/v1beta1/me/starred"),(0,l.kt)("h4",{id:"get-17"},"GET"),(0,l.kt)("h5",{id:"summary-29"},"Summary"),(0,l.kt)("p",null,"Get my starred assets"),(0,l.kt)("h5",{id:"description-15"},"Description"),(0,l.kt)("p",null,"Get all assets starred by me"),(0,l.kt)("h5",{id:"parameters-29"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-29"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetsresponse"},"GetMyStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mestarredasset_id"},"/v1beta1/me/starred/{asset_id}"),(0,l.kt)("h4",{id:"get-18"},"GET"),(0,l.kt)("h5",{id:"summary-30"},"Summary"),(0,l.kt)("p",null,"Get my starred asset"),(0,l.kt)("h5",{id:"description-16"},"Description"),(0,l.kt)("p",null,"Get an asset starred by me"),(0,l.kt)("h5",{id:"parameters-30"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-30"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetresponse"},"GetMyStarredAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-3"},"DELETE"),(0,l.kt)("h5",{id:"summary-31"},"Summary"),(0,l.kt)("p",null,"Unstar an asset"),(0,l.kt)("h5",{id:"description-17"},"Description"),(0,l.kt)("p",null,"Unmark my starred asset"),(0,l.kt)("h5",{id:"parameters-31"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-31"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#unstarassetresponse"},"UnstarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-3"},"PUT"),(0,l.kt)("h5",{id:"summary-32"},"Summary"),(0,l.kt)("p",null,"Star an asset"),(0,l.kt)("h5",{id:"description-18"},"Description"),(0,l.kt)("p",null,"Mark an asset with a star"),(0,l.kt)("h5",{id:"parameters-32"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-32"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#starassetresponse"},"StarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1usersuser_idstarred"},"/v1beta1/users/{user_id}/starred"),(0,l.kt)("h4",{id:"get-19"},"GET"),(0,l.kt)("h5",{id:"summary-33"},"Summary"),(0,l.kt)("p",null,"Get assets starred by a user"),(0,l.kt)("h5",{id:"description-19"},"Description"),(0,l.kt)("p",null,"Get all assets starred by a user"),(0,l.kt)("h5",{id:"parameters-33"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"user_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-33"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getuserstarredassetsresponse"},"GetUserStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-5"},"default"),(0,l.kt)("h3",{id:"v1beta1mestarred-1"},"/v1beta1/me/starred"),(0,l.kt)("h4",{id:"get-20"},"GET"),(0,l.kt)("h5",{id:"summary-34"},"Summary"),(0,l.kt)("p",null,"Get my starred assets"),(0,l.kt)("h5",{id:"description-20"},"Description"),(0,l.kt)("p",null,"Get all assets starred by me"),(0,l.kt)("h5",{id:"parameters-34"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-34"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetsresponse"},"GetMyStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mestarredasset_id-1"},"/v1beta1/me/starred/{asset_id}"),(0,l.kt)("h4",{id:"get-21"},"GET"),(0,l.kt)("h5",{id:"summary-35"},"Summary"),(0,l.kt)("p",null,"Get my starred asset"),(0,l.kt)("h5",{id:"description-21"},"Description"),(0,l.kt)("p",null,"Get an asset starred by me"),(0,l.kt)("h5",{id:"parameters-35"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-35"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetresponse"},"GetMyStarredAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-4"},"DELETE"),(0,l.kt)("h5",{id:"summary-36"},"Summary"),(0,l.kt)("p",null,"Unstar an asset"),(0,l.kt)("h5",{id:"description-22"},"Description"),(0,l.kt)("p",null,"Unmark my starred asset"),(0,l.kt)("h5",{id:"parameters-36"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-36"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#unstarassetresponse"},"UnstarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-4"},"PUT"),(0,l.kt)("h5",{id:"summary-37"},"Summary"),(0,l.kt)("p",null,"Star an asset"),(0,l.kt)("h5",{id:"description-23"},"Description"),(0,l.kt)("p",null,"Mark an asset with a star"),(0,l.kt)("h5",{id:"parameters-37"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-37"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#starassetresponse"},"StarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1usersuser_idstarred-1"},"/v1beta1/users/{user_id}/starred"),(0,l.kt)("h4",{id:"get-22"},"GET"),(0,l.kt)("h5",{id:"summary-38"},"Summary"),(0,l.kt)("p",null,"Get assets starred by a user"),(0,l.kt)("h5",{id:"description-24"},"Description"),(0,l.kt)("p",null,"Get all assets starred by a user"),(0,l.kt)("h5",{id:"parameters-38"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"user_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-38"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getuserstarredassetsresponse"},"GetUserStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-6"},"default"),(0,l.kt)("h3",{id:"v1beta1search-1"},"/v1beta1/search"),(0,l.kt)("h4",{id:"get-23"},"GET"),(0,l.kt)("h5",{id:"summary-39"},"Summary"),(0,l.kt)("p",null,"Search for an asset"),(0,l.kt)("h5",{id:"description-25"},"Description"),(0,l.kt)("p",null,"API for querying documents. 'text' is fuzzy matched against all the available datasets, and matched results are returned. You can specify additional match criteria using 'filter","[.*]","' query parameters. You can specify each filter multiple times to specify a set of values for those filters. For instance, to specify two landscape 'vn' and 'th', the query could be ",(0,l.kt)("inlineCode",{parentName:"p"},"/search/?text=&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th"),". As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description ",(0,l.kt)("inlineCode",{parentName:"p"},"/search/?text=&query[description]=bigqu")),(0,l.kt)("h5",{id:"parameters-39"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for (fuzzy)"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"rankby"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},'descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby',"[data.profile.usage_count]",'"'),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"number of results to return"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-39"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#searchassetsresponse"},"SearchAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1searchsuggest-1"},"/v1beta1/search/suggest"),(0,l.kt)("h4",{id:"get-24"},"GET"),(0,l.kt)("h5",{id:"summary-40"},"Summary"),(0,l.kt)("p",null,"Suggest an asset"),(0,l.kt)("h5",{id:"description-26"},"Description"),(0,l.kt)("p",null,"API for retreiving N number of asset names that similar with the ",(0,l.kt)("inlineCode",{parentName:"p"},"text"),". By default, N = 5 for now and hardcoded in the code."),(0,l.kt)("h5",{id:"parameters-40"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for suggestions"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-40"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#suggestassetsresponse"},"SuggestAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-7"},"default"),(0,l.kt)("h3",{id:"v1beta1tagsassets"},"/v1beta1/tags/assets"),(0,l.kt)("h4",{id:"post-4"},"POST"),(0,l.kt)("h5",{id:"summary-41"},"Summary"),(0,l.kt)("p",null,"Tag an asset"),(0,l.kt)("h5",{id:"description-27"},"Description"),(0,l.kt)("p",null,"Tag an asset with a tag template"),(0,l.kt)("h5",{id:"parameters-41"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Request to be sent to create a tag"),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagassetrequest"},"CreateTagAssetRequest"))))),(0,l.kt)("h5",{id:"responses-41"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagassetresponse"},"CreateTagAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagsassetsasset_id"},"/v1beta1/tags/assets/{asset_id}"),(0,l.kt)("h4",{id:"get-25"},"GET"),(0,l.kt)("h5",{id:"summary-42"},"Summary"),(0,l.kt)("p",null,"Get an asset's tags"),(0,l.kt)("h5",{id:"description-28"},"Description"),(0,l.kt)("p",null,"Get all tags for an assets"),(0,l.kt)("h5",{id:"parameters-42"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-42"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalltagsbyassetresponse"},"GetAllTagsByAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagsassetsasset_idtemplatestemplate_urn"},"/v1beta1/tags/assets/{asset_id}/templates/{template_urn}"),(0,l.kt)("h4",{id:"get-26"},"GET"),(0,l.kt)("h5",{id:"summary-43"},"Summary"),(0,l.kt)("p",null,"Find a tag by asset and template"),(0,l.kt)("h5",{id:"description-29"},"Description"),(0,l.kt)("p",null,"Find a single tag using asset id and template urn"),(0,l.kt)("h5",{id:"parameters-43"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-43"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#gettagbyassetandtemplateresponse"},"GetTagByAssetAndTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-5"},"DELETE"),(0,l.kt)("h5",{id:"summary-44"},"Summary"),(0,l.kt)("p",null,"Remove a tag on an asset"),(0,l.kt)("h5",{id:"description-30"},"Description"),(0,l.kt)("p",null,"Remove a tag on an asset in a type"),(0,l.kt)("h5",{id:"parameters-44"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-44"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletetagassetresponse"},"DeleteTagAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-5"},"PUT"),(0,l.kt)("h5",{id:"summary-45"},"Summary"),(0,l.kt)("p",null,"Update a tag on an asset"),(0,l.kt)("h5",{id:"description-31"},"Description"),(0,l.kt)("p",null,"Update a tag on an asset"),(0,l.kt)("h5",{id:"parameters-45"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"tag_values"'),": [ ",(0,l.kt)("a",{parentName:"td",href:"#tagvalue"},"TagValue")," ], ",(0,l.kt)("strong",{parentName:"td"},'"template_description"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"template_display_name"'),": string }")))),(0,l.kt)("h5",{id:"responses-45"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatetagassetresponse"},"UpdateTagAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagstemplates"},"/v1beta1/tags/templates"),(0,l.kt)("h4",{id:"get-27"},"GET"),(0,l.kt)("h5",{id:"summary-46"},"Summary"),(0,l.kt)("p",null,"Get all tag templates"),(0,l.kt)("h5",{id:"description-32"},"Description"),(0,l.kt)("p",null,"Get all available tag templates"),(0,l.kt)("h5",{id:"parameters-46"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-46"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalltagtemplatesresponse"},"GetAllTagTemplatesResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-5"},"POST"),(0,l.kt)("h5",{id:"summary-47"},"Summary"),(0,l.kt)("p",null,"Create a template"),(0,l.kt)("h5",{id:"description-33"},"Description"),(0,l.kt)("p",null,"Create a new tag template"),(0,l.kt)("h5",{id:"parameters-47"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Request to be sent to create a tag's template"),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagtemplaterequest"},"CreateTagTemplateRequest"))))),(0,l.kt)("h5",{id:"responses-47"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagtemplateresponse"},"CreateTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagstemplatestemplate_urn"},"/v1beta1/tags/templates/{template_urn}"),(0,l.kt)("h4",{id:"get-28"},"GET"),(0,l.kt)("h5",{id:"summary-48"},"Summary"),(0,l.kt)("p",null,"Get a tag template"),(0,l.kt)("h5",{id:"description-34"},"Description"),(0,l.kt)("p",null,"Get a single tag template"),(0,l.kt)("h5",{id:"parameters-48"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-48"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#gettagtemplateresponse"},"GetTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-6"},"DELETE"),(0,l.kt)("h5",{id:"summary-49"},"Summary"),(0,l.kt)("p",null,"Delete a tag template"),(0,l.kt)("h5",{id:"description-35"},"Description"),(0,l.kt)("p",null,"Delete a single tag template"),(0,l.kt)("h5",{id:"parameters-49"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-49"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletetagtemplateresponse"},"DeleteTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-6"},"PUT"),(0,l.kt)("h5",{id:"summary-50"},"Summary"),(0,l.kt)("p",null,"Update a template"),(0,l.kt)("h5",{id:"description-36"},"Description"),(0,l.kt)("p",null,"Update an existing tag template"),(0,l.kt)("h5",{id:"parameters-50"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"description"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"display_name"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"fields"'),": [ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplatefield"},"TagTemplateField")," ] }")))),(0,l.kt)("h5",{id:"responses-50"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatetagtemplateresponse"},"UpdateTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-8"},"default"),(0,l.kt)("h3",{id:"v1beta1types"},"/v1beta1/types"),(0,l.kt)("h4",{id:"get-29"},"GET"),(0,l.kt)("h5",{id:"summary-51"},"Summary"),(0,l.kt)("p",null,"fetch all types"),(0,l.kt)("h5",{id:"description-37"},"Description"),(0,l.kt)("p",null,"Fetch all types supported in Compass"),(0,l.kt)("h5",{id:"parameters-51"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"q"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by specific query"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"q_fields"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by multiple query fields"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"types"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by multiple types"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"services"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by multiple services"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-51"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalltypesresponse"},"GetAllTypesResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"models"},"Models"),(0,l.kt)("h4",{id:"any"},"Any"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"@type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"change"},"Change"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"from"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"to"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"comment"},"Comment"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owner"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_by"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createassetproberequestprobe"},"CreateAssetProbeRequest.Probe"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"metadata"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status_reason"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"timestamp"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createassetproberesponse"},"CreateAssetProbeResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createcommentresponse"},"CreateCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"creatediscussionrequest"},"CreateDiscussionRequest"),(0,l.kt)("p",null,"Request to be sent to create a discussion"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assets"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assignees"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"title"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"creatediscussionresponse"},"CreateDiscussionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createtagassetrequest"},"CreateTagAssetRequest"),(0,l.kt)("p",null,"Request to be sent to create a tag"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"tag_values"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagvalue"},"TagValue")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")))),(0,l.kt)("h4",{id:"createtagassetresponse"},"CreateTagAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createtagtemplaterequest"},"CreateTagTemplateRequest"),(0,l.kt)("p",null,"Request to be sent to create a tag's template"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"fields"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplatefield"},"TagTemplateField")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")))),(0,l.kt)("h4",{id:"createtagtemplateresponse"},"CreateTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"deleteassetresponse"},"DeleteAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteAssetResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"deletecommentresponse"},"DeleteCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteCommentResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"deletetagassetresponse"},"DeleteTagAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteTagAssetResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"deletetagtemplateresponse"},"DeleteTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteTagTemplateResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"discussion"},"Discussion"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assets"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assignees"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owner"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"title"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getallassetsresponse"},"GetAllAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"total"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getallcommentsresponse"},"GetAllCommentsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#comment"},"Comment")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalldiscussionsresponse"},"GetAllDiscussionsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#discussion"},"Discussion")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalltagtemplatesresponse"},"GetAllTagTemplatesResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalltagsbyassetresponse"},"GetAllTagsByAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalltypesresponse"},"GetAllTypesResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1type"},"v1beta1.Type")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetbyidresponse"},"GetAssetByIDResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetbyversionresponse"},"GetAssetByVersionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetstargazersresponse"},"GetAssetStargazersResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetversionhistoryresponse"},"GetAssetVersionHistoryResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getcommentresponse"},"GetCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#comment"},"Comment")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getdiscussionresponse"},"GetDiscussionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#discussion"},"Discussion")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getgraphresponse"},"GetGraphResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineageedge"},"LineageEdge")," ]"),(0,l.kt)("td",{parentName:"tr",align:null},"Edges in the graph."),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"node_attrs"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"Key is the asset URN. Node attributes, if present, will be returned for source and target nodes in the LineageEdge."),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getmydiscussionsresponse"},"GetMyDiscussionsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#discussion"},"Discussion")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getmystarredassetresponse"},"GetMyStarredAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getmystarredassetsresponse"},"GetMyStarredAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"gettagbyassetandtemplateresponse"},"GetTagByAssetAndTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"gettagtemplateresponse"},"GetTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getuserstarredassetsresponse"},"GetUserStarredAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"lineageedge"},"LineageEdge"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"prop"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"source"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"target"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"lineagenode"},"LineageNode"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"nodeattributes"},"NodeAttributes"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"probes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#probesinfo"},"ProbesInfo")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"nullvalue"},"NullValue"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"NullValue")," is a singleton enumeration to represent the null value for the\n",(0,l.kt)("inlineCode",{parentName:"p"},"Value")," type union."),(0,l.kt)("p",null," The JSON representation for ",(0,l.kt)("inlineCode",{parentName:"p"},"NullValue")," is JSON ",(0,l.kt)("inlineCode",{parentName:"p"},"null"),"."),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},"NULL_VALUE: Null value.")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"NullValue"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("inlineCode",{parentName:"td"},"NullValue")," is a singleton enumeration to represent the null value for the ",(0,l.kt)("inlineCode",{parentName:"td"},"Value")," type union. The JSON representation for ",(0,l.kt)("inlineCode",{parentName:"td"},"NullValue")," is JSON ",(0,l.kt)("inlineCode",{parentName:"td"},"null"),". - NULL_VALUE: Null value."),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"patchdiscussionresponse"},"PatchDiscussionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"PatchDiscussionResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"probesinfo"},"ProbesInfo"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"latest"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1probe"},"v1beta1.Probe")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"searchassetsresponse"},"SearchAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"starassetresponse"},"StarAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"status"},"Status"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"code"),(0,l.kt)("td",{parentName:"tr",align:null},"integer"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"details"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#any"},"Any")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"message"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"suggestassetsresponse"},"SuggestAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"tagtemplate"},"TagTemplate"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"fields"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplatefield"},"TagTemplateField")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"tagtemplatefield"},"TagTemplateField"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data_type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"required"),(0,l.kt)("td",{parentName:"tr",align:null},"boolean"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"tagvalue"},"TagValue"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_data_type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_id"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_options"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_required"),(0,l.kt)("td",{parentName:"tr",align:null},"boolean"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_value"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"unstarassetresponse"},"UnstarAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"UnstarAssetResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"updatecommentresponse"},"UpdateCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"UpdateCommentResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"updatetagassetresponse"},"UpdateTagAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"updatetagtemplateresponse"},"UpdateTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertassetrequest"},"UpsertAssetRequest"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#upsertassetrequestasset"},"UpsertAssetRequest.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"downstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"upstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertassetrequestasset"},"UpsertAssetRequest.Asset"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"dynamic data of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"labels of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owners"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null},"list of owners of the asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"url"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertassetresponse"},"UpsertAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertpatchassetrequest"},"UpsertPatchAssetRequest"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#upsertpatchassetrequestasset"},"UpsertPatchAssetRequest.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"downstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"overwrite_lineage"),(0,l.kt)("td",{parentName:"tr",align:null},"boolean"),(0,l.kt)("td",{parentName:"tr",align:null},"overwrite_lineage determines whether the asset's lineage should be overwritten with the upstreams and downstreams specified in the request. Currently, it is only applicable when both upstreams and downstreams are empty/not specified."),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"upstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertpatchassetrequestasset"},"UpsertPatchAssetRequest.Asset"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"dynamic data of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},"description of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"labels of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},"name of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owners"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null},"list of owners of the asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"url"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertpatchassetresponse"},"UpsertPatchAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"user"},"User"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"email"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"provider"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"uuid"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1asset"},"v1beta1.Asset"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"changelog"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#change"},"Change")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owners"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"probes"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1probe"},"v1beta1.Probe")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_by"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"url"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"version"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1probe"},"v1beta1.Probe"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"metadata"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status_reason"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"timestamp"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1tag"},"v1beta1.Tag"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"tag_values"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagvalue"},"TagValue")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1type"},"v1beta1.Type"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"count"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))))}N.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/b95ea484.7dc75fac.js b/assets/js/b95ea484.7dc75fac.js new file mode 100644 index 00000000..0d77a876 --- /dev/null +++ b/assets/js/b95ea484.7dc75fac.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkcompass=self.webpackChunkcompass||[]).push([[488],{3905:function(t,e,a){a.d(e,{Zo:function(){return m},kt:function(){return N}});var n=a(7294);function r(t,e,a){return e in t?Object.defineProperty(t,e,{value:a,enumerable:!0,configurable:!0,writable:!0}):t[e]=a,t}function l(t,e){var a=Object.keys(t);if(Object.getOwnPropertySymbols){var n=Object.getOwnPropertySymbols(t);e&&(n=n.filter((function(e){return Object.getOwnPropertyDescriptor(t,e).enumerable}))),a.push.apply(a,n)}return a}function p(t){for(var e=1;e=0||(r[a]=t[a]);return r}(t,e);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(t);for(n=0;n=0||Object.prototype.propertyIsEnumerable.call(t,a)&&(r[a]=t[a])}return r}var i=n.createContext({}),s=function(t){var e=n.useContext(i),a=e;return t&&(a="function"==typeof t?t(e):p(p({},e),t)),a},m=function(t){var e=s(t.components);return n.createElement(i.Provider,{value:e},t.children)},u={inlineCode:"code",wrapper:function(t){var e=t.children;return n.createElement(n.Fragment,{},e)}},k=n.forwardRef((function(t,e){var a=t.components,r=t.mdxType,l=t.originalType,i=t.parentName,m=d(t,["components","mdxType","originalType","parentName"]),k=s(a),N=r,g=k["".concat(i,".").concat(N)]||k[N]||u[N]||l;return a?n.createElement(g,p(p({ref:e},m),{},{components:a})):n.createElement(g,p({ref:e},m))}));function N(t,e){var a=arguments,r=e&&e.mdxType;if("string"==typeof t||r){var l=a.length,p=new Array(l);p[0]=k;var d={};for(var i in e)hasOwnProperty.call(e,i)&&(d[i]=e[i]);d.originalType=t,d.mdxType="string"==typeof t?t:r,p[1]=d;for(var s=2;s&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th"),". As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description ",(0,l.kt)("inlineCode",{parentName:"p"},"/search/?text=&query[description]=bigqu")),(0,l.kt)("h5",{id:"parameters-10"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for (fuzzy)"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"rankby"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},'descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby',"[data.profile.usage_count]",'"'),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"number of results to return"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"include_fields"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"offset parameter defines the offset from the first result you want to fetch"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-10"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#searchassetsresponse"},"SearchAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1searchsuggest"},"/v1beta1/search/suggest"),(0,l.kt)("h4",{id:"get-7"},"GET"),(0,l.kt)("h5",{id:"summary-11"},"Summary"),(0,l.kt)("p",null,"Suggest an asset"),(0,l.kt)("h5",{id:"description-11"},"Description"),(0,l.kt)("p",null,"API for retreiving N number of asset names that similar with the ",(0,l.kt)("inlineCode",{parentName:"p"},"text"),". By default, N = 5 for now and hardcoded in the code."),(0,l.kt)("h5",{id:"parameters-11"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for suggestions"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-11"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#suggestassetsresponse"},"SuggestAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-1"},"default"),(0,l.kt)("h3",{id:"v1beta1discussions"},"/v1beta1/discussions"),(0,l.kt)("h4",{id:"get-8"},"GET"),(0,l.kt)("h5",{id:"summary-12"},"Summary"),(0,l.kt)("p",null,"Get all discussions"),(0,l.kt)("h5",{id:"parameters-12"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owner"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assignee"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-12"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalldiscussionsresponse"},"GetAllDiscussionsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-1"},"POST"),(0,l.kt)("h5",{id:"summary-13"},"Summary"),(0,l.kt)("p",null,"Create a discussion"),(0,l.kt)("h5",{id:"parameters-13"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Request to be sent to create a discussion"),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#creatediscussionrequest"},"CreateDiscussionRequest"))))),(0,l.kt)("h5",{id:"responses-13"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#creatediscussionresponse"},"CreateDiscussionResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcomments"},"/v1beta1/discussions/{discussion_id}/comments"),(0,l.kt)("h4",{id:"get-9"},"GET"),(0,l.kt)("h5",{id:"summary-14"},"Summary"),(0,l.kt)("p",null,"Get all comments of a discussion"),(0,l.kt)("h5",{id:"parameters-14"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-14"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getallcommentsresponse"},"GetAllCommentsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-2"},"POST"),(0,l.kt)("h5",{id:"summary-15"},"Summary"),(0,l.kt)("p",null,"Create a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-15"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-15"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createcommentresponse"},"CreateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcommentsid"},"/v1beta1/discussions/{discussion_id}/comments/{id}"),(0,l.kt)("h4",{id:"get-10"},"GET"),(0,l.kt)("h5",{id:"summary-16"},"Summary"),(0,l.kt)("p",null,"Get a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-16"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-16"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getcommentresponse"},"GetCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-1"},"DELETE"),(0,l.kt)("h5",{id:"summary-17"},"Summary"),(0,l.kt)("p",null,"Delete a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-17"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-17"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletecommentresponse"},"DeleteCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-1"},"PUT"),(0,l.kt)("h5",{id:"summary-18"},"Summary"),(0,l.kt)("p",null,"Update a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-18"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-18"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatecommentresponse"},"UpdateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsid"},"/v1beta1/discussions/{id}"),(0,l.kt)("h4",{id:"get-11"},"GET"),(0,l.kt)("h5",{id:"summary-19"},"Summary"),(0,l.kt)("p",null,"Get a discussion"),(0,l.kt)("h5",{id:"parameters-19"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-19"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getdiscussionresponse"},"GetDiscussionResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"patch-1"},"PATCH"),(0,l.kt)("h5",{id:"summary-20"},"Summary"),(0,l.kt)("p",null,"Patch a discussion"),(0,l.kt)("h5",{id:"parameters-20"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"assets"'),": ","[ string ]",", ",(0,l.kt)("strong",{parentName:"td"},'"assignees"'),": ","[ string ]",", ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"labels"'),": ","[ string ]",", ",(0,l.kt)("strong",{parentName:"td"},'"state"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"title"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"type"'),": string }")))),(0,l.kt)("h5",{id:"responses-20"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#patchdiscussionresponse"},"PatchDiscussionResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mediscussions"},"/v1beta1/me/discussions"),(0,l.kt)("h4",{id:"get-12"},"GET"),(0,l.kt)("h5",{id:"summary-21"},"Summary"),(0,l.kt)("p",null,"Get all discussions of a user"),(0,l.kt)("h5",{id:"description-12"},"Description"),(0,l.kt)("p",null,"Returns all discussions given possible filters of a user"),(0,l.kt)("h5",{id:"parameters-21"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"filter"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-21"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmydiscussionsresponse"},"GetMyDiscussionsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-2"},"default"),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcomments-1"},"/v1beta1/discussions/{discussion_id}/comments"),(0,l.kt)("h4",{id:"get-13"},"GET"),(0,l.kt)("h5",{id:"summary-22"},"Summary"),(0,l.kt)("p",null,"Get all comments of a discussion"),(0,l.kt)("h5",{id:"parameters-22"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-22"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getallcommentsresponse"},"GetAllCommentsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-3"},"POST"),(0,l.kt)("h5",{id:"summary-23"},"Summary"),(0,l.kt)("p",null,"Create a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-23"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-23"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createcommentresponse"},"CreateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1discussionsdiscussion_idcommentsid-1"},"/v1beta1/discussions/{discussion_id}/comments/{id}"),(0,l.kt)("h4",{id:"get-14"},"GET"),(0,l.kt)("h5",{id:"summary-24"},"Summary"),(0,l.kt)("p",null,"Get a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-24"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-24"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getcommentresponse"},"GetCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-2"},"DELETE"),(0,l.kt)("h5",{id:"summary-25"},"Summary"),(0,l.kt)("p",null,"Delete a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-25"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-25"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletecommentresponse"},"DeleteCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-2"},"PUT"),(0,l.kt)("h5",{id:"summary-26"},"Summary"),(0,l.kt)("p",null,"Update a comment of a discussion"),(0,l.kt)("h5",{id:"parameters-26"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"body"'),": string }")))),(0,l.kt)("h5",{id:"responses-26"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatecommentresponse"},"UpdateCommentResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-3"},"default"),(0,l.kt)("h3",{id:"v1beta1lineageurn-1"},"/v1beta1/lineage/{urn}"),(0,l.kt)("h4",{id:"get-15"},"GET"),(0,l.kt)("h5",{id:"summary-27"},"Summary"),(0,l.kt)("p",null,"Get Lineage Graph"),(0,l.kt)("h5",{id:"description-13"},"Description"),(0,l.kt)("p",null,"Returns the lineage graph. Each entry in the graph describes a (edge) directed relation of assets with source and destination using it's urn, type, and service."),(0,l.kt)("h5",{id:"parameters-27"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"level"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-27"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getgraphresponse"},"GetGraphResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-4"},"default"),(0,l.kt)("h3",{id:"v1beta1mediscussions-1"},"/v1beta1/me/discussions"),(0,l.kt)("h4",{id:"get-16"},"GET"),(0,l.kt)("h5",{id:"summary-28"},"Summary"),(0,l.kt)("p",null,"Get all discussions of a user"),(0,l.kt)("h5",{id:"description-14"},"Description"),(0,l.kt)("p",null,"Returns all discussions given possible filters of a user"),(0,l.kt)("h5",{id:"parameters-28"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"filter"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"sort"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"direction"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-28"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmydiscussionsresponse"},"GetMyDiscussionsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mestarred"},"/v1beta1/me/starred"),(0,l.kt)("h4",{id:"get-17"},"GET"),(0,l.kt)("h5",{id:"summary-29"},"Summary"),(0,l.kt)("p",null,"Get my starred assets"),(0,l.kt)("h5",{id:"description-15"},"Description"),(0,l.kt)("p",null,"Get all assets starred by me"),(0,l.kt)("h5",{id:"parameters-29"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-29"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetsresponse"},"GetMyStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mestarredasset_id"},"/v1beta1/me/starred/{asset_id}"),(0,l.kt)("h4",{id:"get-18"},"GET"),(0,l.kt)("h5",{id:"summary-30"},"Summary"),(0,l.kt)("p",null,"Get my starred asset"),(0,l.kt)("h5",{id:"description-16"},"Description"),(0,l.kt)("p",null,"Get an asset starred by me"),(0,l.kt)("h5",{id:"parameters-30"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-30"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetresponse"},"GetMyStarredAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-3"},"DELETE"),(0,l.kt)("h5",{id:"summary-31"},"Summary"),(0,l.kt)("p",null,"Unstar an asset"),(0,l.kt)("h5",{id:"description-17"},"Description"),(0,l.kt)("p",null,"Unmark my starred asset"),(0,l.kt)("h5",{id:"parameters-31"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-31"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#unstarassetresponse"},"UnstarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-3"},"PUT"),(0,l.kt)("h5",{id:"summary-32"},"Summary"),(0,l.kt)("p",null,"Star an asset"),(0,l.kt)("h5",{id:"description-18"},"Description"),(0,l.kt)("p",null,"Mark an asset with a star"),(0,l.kt)("h5",{id:"parameters-32"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-32"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#starassetresponse"},"StarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1usersuser_idstarred"},"/v1beta1/users/{user_id}/starred"),(0,l.kt)("h4",{id:"get-19"},"GET"),(0,l.kt)("h5",{id:"summary-33"},"Summary"),(0,l.kt)("p",null,"Get assets starred by a user"),(0,l.kt)("h5",{id:"description-19"},"Description"),(0,l.kt)("p",null,"Get all assets starred by a user"),(0,l.kt)("h5",{id:"parameters-33"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"user_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-33"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getuserstarredassetsresponse"},"GetUserStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-5"},"default"),(0,l.kt)("h3",{id:"v1beta1mestarred-1"},"/v1beta1/me/starred"),(0,l.kt)("h4",{id:"get-20"},"GET"),(0,l.kt)("h5",{id:"summary-34"},"Summary"),(0,l.kt)("p",null,"Get my starred assets"),(0,l.kt)("h5",{id:"description-20"},"Description"),(0,l.kt)("p",null,"Get all assets starred by me"),(0,l.kt)("h5",{id:"parameters-34"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-34"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetsresponse"},"GetMyStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1mestarredasset_id-1"},"/v1beta1/me/starred/{asset_id}"),(0,l.kt)("h4",{id:"get-21"},"GET"),(0,l.kt)("h5",{id:"summary-35"},"Summary"),(0,l.kt)("p",null,"Get my starred asset"),(0,l.kt)("h5",{id:"description-21"},"Description"),(0,l.kt)("p",null,"Get an asset starred by me"),(0,l.kt)("h5",{id:"parameters-35"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-35"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getmystarredassetresponse"},"GetMyStarredAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-4"},"DELETE"),(0,l.kt)("h5",{id:"summary-36"},"Summary"),(0,l.kt)("p",null,"Unstar an asset"),(0,l.kt)("h5",{id:"description-22"},"Description"),(0,l.kt)("p",null,"Unmark my starred asset"),(0,l.kt)("h5",{id:"parameters-36"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-36"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#unstarassetresponse"},"UnstarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-4"},"PUT"),(0,l.kt)("h5",{id:"summary-37"},"Summary"),(0,l.kt)("p",null,"Star an asset"),(0,l.kt)("h5",{id:"description-23"},"Description"),(0,l.kt)("p",null,"Mark an asset with a star"),(0,l.kt)("h5",{id:"parameters-37"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-37"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#starassetresponse"},"StarAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1usersuser_idstarred-1"},"/v1beta1/users/{user_id}/starred"),(0,l.kt)("h4",{id:"get-22"},"GET"),(0,l.kt)("h5",{id:"summary-38"},"Summary"),(0,l.kt)("p",null,"Get assets starred by a user"),(0,l.kt)("h5",{id:"description-24"},"Description"),(0,l.kt)("p",null,"Get all assets starred by a user"),(0,l.kt)("h5",{id:"parameters-38"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"user_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-38"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getuserstarredassetsresponse"},"GetUserStarredAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-6"},"default"),(0,l.kt)("h3",{id:"v1beta1search-1"},"/v1beta1/search"),(0,l.kt)("h4",{id:"get-23"},"GET"),(0,l.kt)("h5",{id:"summary-39"},"Summary"),(0,l.kt)("p",null,"Search for an asset"),(0,l.kt)("h5",{id:"description-25"},"Description"),(0,l.kt)("p",null,"API for querying documents. 'text' is fuzzy matched against all the available datasets, and matched results are returned. You can specify additional match criteria using 'filter","[.*]","' query parameters. You can specify each filter multiple times to specify a set of values for those filters. For instance, to specify two landscape 'vn' and 'th', the query could be ",(0,l.kt)("inlineCode",{parentName:"p"},"/search/?text=&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th"),". As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description ",(0,l.kt)("inlineCode",{parentName:"p"},"/search/?text=&query[description]=bigqu")),(0,l.kt)("h5",{id:"parameters-39"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for (fuzzy)"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"rankby"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},'descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby',"[data.profile.usage_count]",'"'),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"size"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"number of results to return"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"include_fields"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"offset"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"offset parameter defines the offset from the first result you want to fetch"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"long")))),(0,l.kt)("h5",{id:"responses-39"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#searchassetsresponse"},"SearchAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1searchsuggest-1"},"/v1beta1/search/suggest"),(0,l.kt)("h4",{id:"get-24"},"GET"),(0,l.kt)("h5",{id:"summary-40"},"Summary"),(0,l.kt)("p",null,"Suggest an asset"),(0,l.kt)("h5",{id:"description-26"},"Description"),(0,l.kt)("p",null,"API for retreiving N number of asset names that similar with the ",(0,l.kt)("inlineCode",{parentName:"p"},"text"),". By default, N = 5 for now and hardcoded in the code."),(0,l.kt)("h5",{id:"parameters-40"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"text"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"text to search for suggestions"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-40"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#suggestassetsresponse"},"SuggestAssetsResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-7"},"default"),(0,l.kt)("h3",{id:"v1beta1tagsassets"},"/v1beta1/tags/assets"),(0,l.kt)("h4",{id:"post-4"},"POST"),(0,l.kt)("h5",{id:"summary-41"},"Summary"),(0,l.kt)("p",null,"Tag an asset"),(0,l.kt)("h5",{id:"description-27"},"Description"),(0,l.kt)("p",null,"Tag an asset with a tag template"),(0,l.kt)("h5",{id:"parameters-41"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Request to be sent to create a tag"),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagassetrequest"},"CreateTagAssetRequest"))))),(0,l.kt)("h5",{id:"responses-41"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagassetresponse"},"CreateTagAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagsassetsasset_id"},"/v1beta1/tags/assets/{asset_id}"),(0,l.kt)("h4",{id:"get-25"},"GET"),(0,l.kt)("h5",{id:"summary-42"},"Summary"),(0,l.kt)("p",null,"Get an asset's tags"),(0,l.kt)("h5",{id:"description-28"},"Description"),(0,l.kt)("p",null,"Get all tags for an assets"),(0,l.kt)("h5",{id:"parameters-42"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-42"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalltagsbyassetresponse"},"GetAllTagsByAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagsassetsasset_idtemplatestemplate_urn"},"/v1beta1/tags/assets/{asset_id}/templates/{template_urn}"),(0,l.kt)("h4",{id:"get-26"},"GET"),(0,l.kt)("h5",{id:"summary-43"},"Summary"),(0,l.kt)("p",null,"Find a tag by asset and template"),(0,l.kt)("h5",{id:"description-29"},"Description"),(0,l.kt)("p",null,"Find a single tag using asset id and template urn"),(0,l.kt)("h5",{id:"parameters-43"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-43"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#gettagbyassetandtemplateresponse"},"GetTagByAssetAndTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-5"},"DELETE"),(0,l.kt)("h5",{id:"summary-44"},"Summary"),(0,l.kt)("p",null,"Remove a tag on an asset"),(0,l.kt)("h5",{id:"description-30"},"Description"),(0,l.kt)("p",null,"Remove a tag on an asset in a type"),(0,l.kt)("h5",{id:"parameters-44"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-44"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletetagassetresponse"},"DeleteTagAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-5"},"PUT"),(0,l.kt)("h5",{id:"summary-45"},"Summary"),(0,l.kt)("p",null,"Update a tag on an asset"),(0,l.kt)("h5",{id:"description-31"},"Description"),(0,l.kt)("p",null,"Update a tag on an asset"),(0,l.kt)("h5",{id:"parameters-45"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"tag_values"'),": [ ",(0,l.kt)("a",{parentName:"td",href:"#tagvalue"},"TagValue")," ], ",(0,l.kt)("strong",{parentName:"td"},'"template_description"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"template_display_name"'),": string }")))),(0,l.kt)("h5",{id:"responses-45"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatetagassetresponse"},"UpdateTagAssetResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagstemplates"},"/v1beta1/tags/templates"),(0,l.kt)("h4",{id:"get-27"},"GET"),(0,l.kt)("h5",{id:"summary-46"},"Summary"),(0,l.kt)("p",null,"Get all tag templates"),(0,l.kt)("h5",{id:"description-32"},"Description"),(0,l.kt)("p",null,"Get all available tag templates"),(0,l.kt)("h5",{id:"parameters-46"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-46"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalltagtemplatesresponse"},"GetAllTagTemplatesResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"post-5"},"POST"),(0,l.kt)("h5",{id:"summary-47"},"Summary"),(0,l.kt)("p",null,"Create a template"),(0,l.kt)("h5",{id:"description-33"},"Description"),(0,l.kt)("p",null,"Create a new tag template"),(0,l.kt)("h5",{id:"parameters-47"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"Request to be sent to create a tag's template"),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagtemplaterequest"},"CreateTagTemplateRequest"))))),(0,l.kt)("h5",{id:"responses-47"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#createtagtemplateresponse"},"CreateTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"v1beta1tagstemplatestemplate_urn"},"/v1beta1/tags/templates/{template_urn}"),(0,l.kt)("h4",{id:"get-28"},"GET"),(0,l.kt)("h5",{id:"summary-48"},"Summary"),(0,l.kt)("p",null,"Get a tag template"),(0,l.kt)("h5",{id:"description-34"},"Description"),(0,l.kt)("p",null,"Get a single tag template"),(0,l.kt)("h5",{id:"parameters-48"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-48"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#gettagtemplateresponse"},"GetTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"delete-6"},"DELETE"),(0,l.kt)("h5",{id:"summary-49"},"Summary"),(0,l.kt)("p",null,"Delete a tag template"),(0,l.kt)("h5",{id:"description-35"},"Description"),(0,l.kt)("p",null,"Delete a single tag template"),(0,l.kt)("h5",{id:"parameters-49"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-49"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#deletetagtemplateresponse"},"DeleteTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h4",{id:"put-6"},"PUT"),(0,l.kt)("h5",{id:"summary-50"},"Summary"),(0,l.kt)("p",null,"Update a template"),(0,l.kt)("h5",{id:"description-36"},"Description"),(0,l.kt)("p",null,"Update an existing tag template"),(0,l.kt)("h5",{id:"parameters-50"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes"),(0,l.kt)("td",{parentName:"tr",align:null},"{ ",(0,l.kt)("strong",{parentName:"td"},'"description"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"display_name"'),": string, ",(0,l.kt)("strong",{parentName:"td"},'"fields"'),": [ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplatefield"},"TagTemplateField")," ] }")))),(0,l.kt)("h5",{id:"responses-50"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#updatetagtemplateresponse"},"UpdateTagTemplateResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h2",{id:"default-8"},"default"),(0,l.kt)("h3",{id:"v1beta1types"},"/v1beta1/types"),(0,l.kt)("h4",{id:"get-29"},"GET"),(0,l.kt)("h5",{id:"summary-51"},"Summary"),(0,l.kt)("p",null,"fetch all types"),(0,l.kt)("h5",{id:"description-37"},"Description"),(0,l.kt)("p",null,"Fetch all types supported in Compass"),(0,l.kt)("h5",{id:"parameters-51"},"Parameters"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Located in"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"q"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by specific query"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"q_fields"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by multiple query fields"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"types"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by multiple types"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"services"),(0,l.kt)("td",{parentName:"tr",align:null},"query"),(0,l.kt)("td",{parentName:"tr",align:null},"filter by multiple services"),(0,l.kt)("td",{parentName:"tr",align:null},"No"),(0,l.kt)("td",{parentName:"tr",align:null},"string")))),(0,l.kt)("h5",{id:"responses-51"},"Responses"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Code"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Schema"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"200"),(0,l.kt)("td",{parentName:"tr",align:null},"A successful response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#getalltypesresponse"},"GetAllTypesResponse"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"400"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the data that user input is wrong."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"404"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource does not exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"409"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when the resource already exist."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"500"),(0,l.kt)("td",{parentName:"tr",align:null},"Returned when theres is something wrong on the server side."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"default"),(0,l.kt)("td",{parentName:"tr",align:null},"An unexpected error response."),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#status"},"Status"))))),(0,l.kt)("h3",{id:"models"},"Models"),(0,l.kt)("h4",{id:"any"},"Any"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"@type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"change"},"Change"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"from"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"path"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"to"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"comment"},"Comment"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"discussion_id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owner"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_by"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createassetproberequestprobe"},"CreateAssetProbeRequest.Probe"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"metadata"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status_reason"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"timestamp"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createassetproberesponse"},"CreateAssetProbeResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createcommentresponse"},"CreateCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"creatediscussionrequest"},"CreateDiscussionRequest"),(0,l.kt)("p",null,"Request to be sent to create a discussion"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assets"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assignees"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"title"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"creatediscussionresponse"},"CreateDiscussionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createtagassetrequest"},"CreateTagAssetRequest"),(0,l.kt)("p",null,"Request to be sent to create a tag"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"tag_values"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagvalue"},"TagValue")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")))),(0,l.kt)("h4",{id:"createtagassetresponse"},"CreateTagAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"createtagtemplaterequest"},"CreateTagTemplateRequest"),(0,l.kt)("p",null,"Request to be sent to create a tag's template"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"fields"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplatefield"},"TagTemplateField")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"Yes")))),(0,l.kt)("h4",{id:"createtagtemplateresponse"},"CreateTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"deleteassetresponse"},"DeleteAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteAssetResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"deletecommentresponse"},"DeleteCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteCommentResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"deletetagassetresponse"},"DeleteTagAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteTagAssetResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"deletetagtemplateresponse"},"DeleteTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"DeleteTagTemplateResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"discussion"},"Discussion"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assets"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"assignees"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"body"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owner"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"state"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"title"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getallassetsresponse"},"GetAllAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"total"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getallcommentsresponse"},"GetAllCommentsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#comment"},"Comment")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalldiscussionsresponse"},"GetAllDiscussionsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#discussion"},"Discussion")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalltagtemplatesresponse"},"GetAllTagTemplatesResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalltagsbyassetresponse"},"GetAllTagsByAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getalltypesresponse"},"GetAllTypesResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1type"},"v1beta1.Type")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetbyidresponse"},"GetAssetByIDResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetbyversionresponse"},"GetAssetByVersionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetstargazersresponse"},"GetAssetStargazersResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getassetversionhistoryresponse"},"GetAssetVersionHistoryResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getcommentresponse"},"GetCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#comment"},"Comment")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getdiscussionresponse"},"GetDiscussionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#discussion"},"Discussion")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getgraphresponse"},"GetGraphResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineageedge"},"LineageEdge")," ]"),(0,l.kt)("td",{parentName:"tr",align:null},"Edges in the graph."),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"node_attrs"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"Key is the asset URN. Node attributes, if present, will be returned for source and target nodes in the LineageEdge."),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getmydiscussionsresponse"},"GetMyDiscussionsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#discussion"},"Discussion")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getmystarredassetresponse"},"GetMyStarredAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getmystarredassetsresponse"},"GetMyStarredAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"gettagbyassetandtemplateresponse"},"GetTagByAssetAndTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"gettagtemplateresponse"},"GetTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"getuserstarredassetsresponse"},"GetUserStarredAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"lineageedge"},"LineageEdge"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"prop"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"source"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"target"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"lineagenode"},"LineageNode"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"nodeattributes"},"NodeAttributes"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"probes"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#probesinfo"},"ProbesInfo")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"nullvalue"},"NullValue"),(0,l.kt)("p",null,(0,l.kt)("inlineCode",{parentName:"p"},"NullValue")," is a singleton enumeration to represent the null value for the\n",(0,l.kt)("inlineCode",{parentName:"p"},"Value")," type union."),(0,l.kt)("p",null," The JSON representation for ",(0,l.kt)("inlineCode",{parentName:"p"},"NullValue")," is JSON ",(0,l.kt)("inlineCode",{parentName:"p"},"null"),"."),(0,l.kt)("ul",null,(0,l.kt)("li",{parentName:"ul"},"NULL_VALUE: Null value.")),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"NullValue"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("inlineCode",{parentName:"td"},"NullValue")," is a singleton enumeration to represent the null value for the ",(0,l.kt)("inlineCode",{parentName:"td"},"Value")," type union. The JSON representation for ",(0,l.kt)("inlineCode",{parentName:"td"},"NullValue")," is JSON ",(0,l.kt)("inlineCode",{parentName:"td"},"null"),". - NULL_VALUE: Null value."),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"patchdiscussionresponse"},"PatchDiscussionResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"PatchDiscussionResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"probesinfo"},"ProbesInfo"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"latest"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1probe"},"v1beta1.Probe")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"searchassetsresponse"},"SearchAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1asset"},"v1beta1.Asset")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"starassetresponse"},"StarAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"status"},"Status"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"code"),(0,l.kt)("td",{parentName:"tr",align:null},"integer"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"details"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#any"},"Any")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"message"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"suggestassetsresponse"},"SuggestAssetsResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"tagtemplate"},"TagTemplate"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"fields"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagtemplatefield"},"TagTemplateField")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"tagtemplatefield"},"TagTemplateField"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data_type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"options"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"required"),(0,l.kt)("td",{parentName:"tr",align:null},"boolean"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"tagvalue"},"TagValue"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_data_type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_id"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_options"),(0,l.kt)("td",{parentName:"tr",align:null},"[ string ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_required"),(0,l.kt)("td",{parentName:"tr",align:null},"boolean"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"field_value"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"unstarassetresponse"},"UnstarAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"UnstarAssetResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"updatecommentresponse"},"UpdateCommentResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"UpdateCommentResponse"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null})))),(0,l.kt)("h4",{id:"updatetagassetresponse"},"UpdateTagAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#v1beta1tag"},"v1beta1.Tag")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"updatetagtemplateresponse"},"UpdateTagTemplateResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#tagtemplate"},"TagTemplate")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertassetrequest"},"UpsertAssetRequest"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#upsertassetrequestasset"},"UpsertAssetRequest.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"downstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"upstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertassetrequestasset"},"UpsertAssetRequest.Asset"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"dynamic data of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"labels of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owners"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null},"list of owners of the asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"url"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertassetresponse"},"UpsertAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertpatchassetrequest"},"UpsertPatchAssetRequest"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#upsertpatchassetrequestasset"},"UpsertPatchAssetRequest.Asset")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"downstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"overwrite_lineage"),(0,l.kt)("td",{parentName:"tr",align:null},"boolean"),(0,l.kt)("td",{parentName:"tr",align:null},"overwrite_lineage determines whether the asset's lineage should be overwritten with the upstreams and downstreams specified in the request. Currently, it is only applicable when both upstreams and downstreams are empty/not specified."),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"upstreams"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#lineagenode"},"LineageNode")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertpatchassetrequestasset"},"UpsertPatchAssetRequest.Asset"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"dynamic data of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},"description of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null},"labels of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null},"name of an asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owners"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null},"list of owners of the asset"),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"url"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"upsertpatchassetresponse"},"UpsertPatchAssetResponse"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"user"},"User"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"email"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"provider"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"uuid"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1asset"},"v1beta1.Asset"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"changelog"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#change"},"Change")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"data"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"labels"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"owners"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#user"},"User")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"probes"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#v1beta1probe"},"v1beta1.Probe")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"service"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"type"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"updated_by"),(0,l.kt)("td",{parentName:"tr",align:null},(0,l.kt)("a",{parentName:"td",href:"#user"},"User")),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"url"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"version"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1probe"},"v1beta1.Probe"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"created_at"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"metadata"),(0,l.kt)("td",{parentName:"tr",align:null},"object"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"status_reason"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"timestamp"),(0,l.kt)("td",{parentName:"tr",align:null},"dateTime"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1tag"},"v1beta1.Tag"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"asset_id"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"tag_values"),(0,l.kt)("td",{parentName:"tr",align:null},"[ ",(0,l.kt)("a",{parentName:"td",href:"#tagvalue"},"TagValue")," ]"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_description"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_display_name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"template_urn"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))),(0,l.kt)("h4",{id:"v1beta1type"},"v1beta1.Type"),(0,l.kt)("table",null,(0,l.kt)("thead",{parentName:"table"},(0,l.kt)("tr",{parentName:"thead"},(0,l.kt)("th",{parentName:"tr",align:null},"Name"),(0,l.kt)("th",{parentName:"tr",align:null},"Type"),(0,l.kt)("th",{parentName:"tr",align:null},"Description"),(0,l.kt)("th",{parentName:"tr",align:null},"Required"))),(0,l.kt)("tbody",{parentName:"table"},(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"count"),(0,l.kt)("td",{parentName:"tr",align:null},"long"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")),(0,l.kt)("tr",{parentName:"tbody"},(0,l.kt)("td",{parentName:"tr",align:null},"name"),(0,l.kt)("td",{parentName:"tr",align:null},"string"),(0,l.kt)("td",{parentName:"tr",align:null}),(0,l.kt)("td",{parentName:"tr",align:null},"No")))))}N.isMDXComponent=!0}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.6ad9faff.js b/assets/js/runtime~main.063e0640.js similarity index 94% rename from assets/js/runtime~main.6ad9faff.js rename to assets/js/runtime~main.063e0640.js index 8a8955dc..d86777a2 100644 --- a/assets/js/runtime~main.6ad9faff.js +++ b/assets/js/runtime~main.063e0640.js @@ -1 +1 @@ -!function(){"use strict";var e,t,n,r,f,o={},c={};function a(e){var t=c[e];if(void 0!==t)return t.exports;var n=c[e]={id:e,loaded:!1,exports:{}};return o[e].call(n.exports,n,n.exports,a),n.loaded=!0,n.exports}a.m=o,a.c=c,e=[],a.O=function(t,n,r,f){if(!n){var o=1/0;for(d=0;d=f)&&Object.keys(a.O).every((function(e){return a.O[e](n[u])}))?n.splice(u--,1):(c=!1,f0&&e[d-1][2]>f;d--)e[d]=e[d-1];e[d]=[n,r,f]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);a.r(f);var o={};t=t||[null,n({}),n([]),n(n)];for(var c=2&r&&e;"object"==typeof c&&!~t.indexOf(c);c=n(c))Object.getOwnPropertyNames(c).forEach((function(t){o[t]=function(){return e[t]}}));return o.default=function(){return e},a.d(f,o),f},a.d=function(e,t){for(var n in t)a.o(t,n)&&!a.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,n){return a.f[n](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({4:"9ed00105",19:"f9023d10",34:"3e06f441",53:"935f2afb",75:"0dffb83e",112:"e0fc6f72",115:"73885a0d",128:"a09c2993",217:"3b8c55ea",244:"fa0bf435",281:"f3d92a4d",300:"a510c3a6",329:"9431b8f7",339:"17896441",464:"e481d38d",488:"b95ea484",514:"1be78505",533:"b3700643",576:"81d48be1",643:"7de266c1",683:"2151714b",704:"bcc82efc",737:"b59fa990",740:"7e37206e",825:"306919cb",844:"85612fbc",886:"8a1416ba",915:"90c7f2f1",918:"054a9191",960:"91c76d4c",980:"270797cf"}[e]||e)+"."+{4:"eb06d45c",19:"55984b7c",34:"d590dafb",53:"030d8b66",75:"05a2a0ae",112:"2d6f3790",115:"d5a2ebf3",128:"b2fadcdb",217:"1ed89906",244:"e9b82cb7",281:"6a86dc09",300:"7ffa8ab2",329:"47ff73d7",339:"b718e0c4",464:"9726f839",488:"28a2eb6d",514:"8414fb50",533:"bd064dac",576:"ddb22d09",643:"b51d9c4b",683:"4b916eea",704:"da70c0b7",737:"4e810728",740:"fc853613",825:"db6bc86c",844:"19c8e2bc",886:"485bd34e",915:"c8c92fa4",918:"dfe63384",960:"f33fdb26",972:"325b24f3",980:"86bc5529"}[e]+".js"},a.miniCssF=function(e){},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},f="compass:",a.l=function(e,t,n,o){if(r[e])r[e].push(t);else{var c,u;if(void 0!==n)for(var i=document.getElementsByTagName("script"),d=0;d=f)&&Object.keys(a.O).every((function(e){return a.O[e](n[u])}))?n.splice(u--,1):(c=!1,f0&&e[d-1][2]>f;d--)e[d]=e[d-1];e[d]=[n,r,f]},a.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return a.d(t,{a:t}),t},n=Object.getPrototypeOf?function(e){return Object.getPrototypeOf(e)}:function(e){return e.__proto__},a.t=function(e,r){if(1&r&&(e=this(e)),8&r)return e;if("object"==typeof e&&e){if(4&r&&e.__esModule)return e;if(16&r&&"function"==typeof e.then)return e}var f=Object.create(null);a.r(f);var o={};t=t||[null,n({}),n([]),n(n)];for(var c=2&r&&e;"object"==typeof c&&!~t.indexOf(c);c=n(c))Object.getOwnPropertyNames(c).forEach((function(t){o[t]=function(){return e[t]}}));return o.default=function(){return e},a.d(f,o),f},a.d=function(e,t){for(var n in t)a.o(t,n)&&!a.o(e,n)&&Object.defineProperty(e,n,{enumerable:!0,get:t[n]})},a.f={},a.e=function(e){return Promise.all(Object.keys(a.f).reduce((function(t,n){return a.f[n](e,t),t}),[]))},a.u=function(e){return"assets/js/"+({4:"9ed00105",19:"f9023d10",34:"3e06f441",53:"935f2afb",75:"0dffb83e",112:"e0fc6f72",115:"73885a0d",128:"a09c2993",217:"3b8c55ea",244:"fa0bf435",281:"f3d92a4d",300:"a510c3a6",329:"9431b8f7",339:"17896441",464:"e481d38d",488:"b95ea484",514:"1be78505",533:"b3700643",576:"81d48be1",643:"7de266c1",683:"2151714b",704:"bcc82efc",737:"b59fa990",740:"7e37206e",825:"306919cb",844:"85612fbc",886:"8a1416ba",915:"90c7f2f1",918:"054a9191",960:"91c76d4c",980:"270797cf"}[e]||e)+"."+{4:"eb06d45c",19:"55984b7c",34:"d590dafb",53:"31f45a27",75:"05a2a0ae",112:"2d6f3790",115:"d5a2ebf3",128:"b2fadcdb",217:"1ed89906",244:"e9b82cb7",281:"6a86dc09",300:"a95ed453",329:"47ff73d7",339:"b718e0c4",464:"9726f839",488:"7dc75fac",514:"8414fb50",533:"bd064dac",576:"ddb22d09",643:"b51d9c4b",683:"4b916eea",704:"da70c0b7",737:"4e810728",740:"fc853613",825:"db6bc86c",844:"19c8e2bc",886:"485bd34e",915:"c8c92fa4",918:"dfe63384",960:"cdcf4bf4",972:"325b24f3",980:"86bc5529"}[e]+".js"},a.miniCssF=function(e){},a.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),a.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r={},f="compass:",a.l=function(e,t,n,o){if(r[e])r[e].push(t);else{var c,u;if(void 0!==n)for(var i=document.getElementsByTagName("script"),d=0;d Architecture | Compass - +

Architecture

Compass' architecture is pretty simple. It has a client-server architecture backed by PostgreSQL as a main storage and Elasticsearch as a secondary storage and provides HTTP & gRPC interface to interact with.

Compass Architecture

System Design​

Components​

gRPC Server​

  • gRPC server is the main interface to interact with Compass.
  • The protobuf file to define the interface is centralized in goto/proton

gRPC-gateway Server​

  • gRPC-gateway server transcodes HTTP call to gRPC call and allows client to interact with Compass using RESTful HTTP request.

PostgreSQL​

  • Compass uses PostgreSQL as it is main storage for storing all of its metadata.

Elasticsearch​

  • Compass uses Elasticsearch as it is secondary storage to power search of metadata.
- + \ No newline at end of file diff --git a/concepts/asset/index.html b/concepts/asset/index.html index 25ec99e6..9c9c349b 100644 --- a/concepts/asset/index.html +++ b/concepts/asset/index.html @@ -8,7 +8,7 @@ Asset | Compass - + @@ -18,7 +18,7 @@ Up until now, Compass always bump up the minor version if an asset get updated. The version history of an asset could also be fetched via /v1beta1/assets/{id}/versions API. Not only storing the versions of an asset, Compass also stores the changelog between each version. Compass use r3labs/diff to get the diff between newly ingested asset and the existing asset.

For instance, there is an asset with urn kafka:booking-log-kafka

{
    "id": "f2bb4e02-12b6-4c9f-aa9d-7d56aaaeb51e",
    "urn": "kafka:booking-log-kafka",
    "type": "topic",
    "service": "kafka",
    "data": {},
    "labels": {
        "environment": "integration"
    },
    "version": "0.1"
}

If there is an update to the environment in the asset labels, here is the asset version history stored in Compass:

{
    "id": "f2bb4e02-12b6-4c9f-aa9d-7d56aaaeb51e",
    "urn": "kafka:booking-log-kafka",
    "type": "topic",
    "service": "kafka",
    "data": {},
    "labels": {
        "environment": "production"
    },
    "version": "0.2"
    "changelog": [
        {
            "type": "update",
            "path": ["labels","environment"],
            "from": "integration",
            "to":   "production
        }
    ]
}

Tagging an Asset​

Compass allows user to tag a specific asset. To tag a new asset, one needs to create a template of the tag. Tag's template defines a set of fields' tag that are applicable to tag each field in an asset. Once a template is created, each field in an asset is possible to be tagged by calling /v1beta1/tags API. More detail about Tagging.

- + \ No newline at end of file diff --git a/concepts/internals/index.html b/concepts/internals/index.html index 39ccb6b2..0263d0b5 100644 --- a/concepts/internals/index.html +++ b/concepts/internals/index.html @@ -8,13 +8,13 @@ Internals | Compass - +
-

Internals

This document details information about how Compass interfaces with elasticsearch. It is meant to give an overview of how some concepts work internally, to help streamline understanding of how things work under the hood.

Index Setup​

There is a migration command in compass to setup all storages. Once the migration is executed, all types are being created (if does not exist). When a type is created, an index is created in elasticsearch by it's name. All created indices are aliased to the universe index, which is used to run the search when all types need to be searched, or when filter[type] is not specifed in the Search API.

The indices are also configured with a camel case tokenizer, to support proper lexing of some resources that use camel case in their nomenclature (protobuf names for instance). Given below is a sample of the index settings that are used:

// PUT http://${ES_HOST}/{index}
{
        "mappings": {},         // used for boost
        "aliases": {            // all indices are aliased to the "universe" index
            "universe": {} 
        },
        "settings": {           // configuration for handling camel case text
            "analysis": {
                "analyzer": {
                    "default": {
                        "type": "pattern",
                        "pattern": "([^\\p{L}\\d]+)|(?<=\\D)(?=\\d)|(?<=\\d)(?=\\D)|(?<=[\\p{L}&&[^\\p{Lu}]])(?=\\p{Lu})|(?<=\\p{Lu})(?=\\p{Lu}[\\p{L}&&[^\\p{Lu}]])"
                    }
                }
            }
        }
    }

We use elasticsearch's multi_match search for running our queries. Depending on whether there are additional filter's specified during search, we augment the query with a custom script query that filter's the result set.

The script filter is designed to match a document if:

  • the document contains the filter key and it's value matches the filter value OR
  • the document doesn't contain the filter key at all

To demonstrate, the following API call:

$ curl http://localhost:8080/v1beta1/search?text=log&filter[landscape]=id

is internally translated to the following elasticsearch query

{
    "query": {
        "bool": {
            "must": {
                "multi_match": {
                    "query": "log"
                }
            },
            "filter": [{
                "script": {
                    "script": {
                        "source": "doc.containsKey(\"landscape.keyword\") == false || doc[\"landscape.keyword\"].value == \"id\""
                    }
                }
            }]
        }
    }
}

Compass also supports filter with fuzzy match with query query params. The script query is designed to match a document if:

  • the document contains the filter key and it's value is fuzzily matches the query value
$ curl http://localhost:8080/v1beta1/search?text=log&filter[landscape]=id

is internally translated to the following elasticsearch query

{
   "query":{
      "bool":{
         "filter":{
            "match":{
               "description":{
                  "fuzziness":"AUTO",
                  "query":"test"
               }
            }
         },
         "should":{
            "bool":{
               "should":[
                  {
                     "multi_match":{
                        "fields":[
                           "urn^10",
                           "name^5"
                        ],
                        "query":"log"
                     }
                  },
                  {
                     "multi_match":{
                        "fields":[
                           "urn^10",
                           "name^5"
                        ],
                        "fuzziness":"AUTO",
                        "query":"log"
                     }
                  },
                  {
                     "multi_match":{
                        "fields":[
                           
                        ],
                        "fuzziness":"AUTO",
                        "query":"log"
                     }
                  }
               ]
            }
         }
      }
   },
   "min_score":0.01
}
- +

Internals

This document details information about how Compass interfaces with elasticsearch. It is meant to give an overview of how some concepts work internally, to help streamline understanding of how things work under the hood.

Index Setup​

There is a migration command in compass to setup all storages. Once the migration is executed, all types are being created (if does not exist). When a type is created, an index is created in elasticsearch by it's name. All created indices are aliased to the universe index, which is used to run the search when all types need to be searched, or when filter[type] is not specifed in the Search API.

The indices are also configured with a camel case tokenizer, to support proper lexing of some resources that use camel case in their nomenclature (protobuf names for instance). Given below is a sample of the index settings that are used:

// PUT http://${ES_HOST}/{index}
{
        "mappings": {},         // used for boost
        "aliases": {            // all indices are aliased to the "universe" index
            "universe": {} 
        },
        "settings": {           // configuration for handling camel case text
            "analysis": {
                "analyzer": {
                    "default": {
                        "type": "pattern",
                        "pattern": "([^\\p{L}\\d]+)|(?<=\\D)(?=\\d)|(?<=\\d)(?=\\D)|(?<=[\\p{L}&&[^\\p{Lu}]])(?=\\p{Lu})|(?<=\\p{Lu})(?=\\p{Lu}[\\p{L}&&[^\\p{Lu}]])"
                    }
                }
            }
        }
    }

We use elasticsearch's multi_match search for running our queries. Depending on whether there are additional filter's specified during search, we augment the query with a custom script query that filter's the result set.

The script filter is designed to match a document if:

  • the document contains the filter key and it's value matches the filter value OR
  • the document doesn't contain the filter key at all

To demonstrate, the following API call:

$ curl http://localhost:8080/v1beta1/search?text=log&filter[landscape]=id

is internally translated to the following elasticsearch query

{
    "query": {
        "bool": {
            "must": {
                "multi_match": {
                    "query": "log"
                }
            },
            "filter": [{
                "script": {
                    "script": {
                        "source": "doc.containsKey(\"landscape.keyword\") == false || doc[\"landscape.keyword\"].value == \"id\""
                    }
                }
            }]
        }
    }
}

Compass also supports filter with fuzzy match with query query params. The script query is designed to match a document if:

  • the document contains the filter key and it's value is fuzzily matches the query value
$ curl http://localhost:8080/v1beta1/search?text=log&filter[landscape]=id

is internally translated to the following elasticsearch query

{
   "query":{
      "bool":{
         "filter":{
            "match":{
               "description":{
                  "fuzziness":"AUTO",
                  "query":"test"
               }
            }
         },
         "should":{
            "bool":{
               "should":[
                  {
                     "multi_match":{
                        "fields":[
                           "urn^10",
                           "name^5"
                        ],
                        "query":"log"
                     }
                  },
                  {
                     "multi_match":{
                        "fields":[
                           "urn^10",
                           "name^5"
                        ],
                        "fuzziness":"AUTO",
                        "query":"log"
                     }
                  },
                  {
                     "multi_match":{
                        "fields":[
                           
                        ],
                        "fuzziness":"AUTO",
                        "query":"log"
                     }
                  }
               ]
            }
         }
      }
   },
   "min_score":0.01
}
+ \ No newline at end of file diff --git a/concepts/overview/index.html b/concepts/overview/index.html index 441cc70f..93d492f0 100644 --- a/concepts/overview/index.html +++ b/concepts/overview/index.html @@ -8,13 +8,13 @@ Overview | Compass - +

Overview

Compass has three major concept when it comes to data ingestion: Asset, Type, and Service.

Asset is the main model that represents a metadata of a specific service with a specific type.

Type defines a ‘type’ of an asset and it is pre-defined. Compass currently supports the following types:

  1. table
  2. job
  3. dashboard
  4. topic
  5. feature_table
  6. model (under development)
  7. application (under development)

Service defines the application or source that maintains or generates the asset. Examples would be biquery, postgres, etc.

Some features that compass has:

Discussion​

Compass supports discussion feature. User could drop comments in each discussion. Currently, there are three types of discussions issues, open ended, and question and answer. Depending on the type, the discussion could have multiple possible states. In the current version, all types only have two states: open and closed. A newly created discussion will always be assign an open state. More detail about Discussion.

Starring​

Compass allows a user to stars an asset. This bookmarking functionality is introduced to increase the speed of a user to get information. There is also an API to see which users star an asset (stargazers). More detail about Starring.

- + \ No newline at end of file diff --git a/concepts/type/index.html b/concepts/type/index.html index a974c4cf..c7b5bcf4 100644 --- a/concepts/type/index.html +++ b/concepts/type/index.html @@ -8,14 +8,14 @@ Type | Compass - +

Type

Each Asset will have a Type to represent the kind of metadata it represents. It is currently pre-defined by Compass, so no arbitrary types will be supported.

Compass currently supports the following types:

  1. table
  2. job
  3. dashboard
  4. topic
  5. feature_table
  6. model (under development)
  7. application (under development)

Type will be extremely useful for categorizing your assets and it will be really helpful during discovery. Check this section on querying assets on how to leverage type for your discovery.

- + \ No newline at end of file diff --git a/concepts/user/index.html b/concepts/user/index.html index cb9499c5..a6de78a1 100644 --- a/concepts/user/index.html +++ b/concepts/user/index.html @@ -8,7 +8,7 @@ User | Compass - + @@ -17,7 +17,7 @@ Compass does not make any assumption of what kind of identity format that is being used. The uuid indicates that it could be in any form (e.g. email, UUIDv4, etc) as long as it is universally unique. The current behaviour is, Compass will add a new user if the user information consumed from the header does not exist in Compass' database.

Phantom User​

In Compass ingestion API, Compass allows asset to mentioned who is its own owners. During the ingestion, if the email field in the list of owners field in the asset is not empty, Compass will create a new 'Phantom User' with the email but with empty UUID. A 'Phantom User' is a user that is written in the storage but with empty UUID. The 'Phantom User' cannot do any user-related interaction (e.g. Starring, Discussion) in Compass.

Linking User​

There is another configurable optional email header that Compass expect. The default name is Compass-User-Email. In case there is already an existing 'Phantom User', if there is a request coming to Compass with completed user information in its header (uuid header and email header are not empty), Compass will register the UUID to the existing 'Phantom User' and the 'Phantom User' becomes a normal user. By doing so, assets ownership of that new user will immediately reflected.

User Provider​

Since Compass expects that there is an external instance that manages user, it is possible for Compass to consume user information from multiple external instances. Compass distinguishes the source of user by marking it in the provider field. The default provider field value can be configured via config.

- + \ No newline at end of file diff --git a/configuration/index.html b/configuration/index.html index 3ee11053..c8b35adb 100644 --- a/configuration/index.html +++ b/configuration/index.html @@ -8,13 +8,13 @@ Configuration | Compass - +

Configuration

Compass binary contains both the CLI client and the server. Each has it's own configuration in order to run. Server configuration contains information such as database credentials, elastic search brokers, log severity, etc. while CLI client configuration only has configuration about which server to connect.

Server Setup​

There are several approaches to setup Compass Server

  1. Using the CLI
  2. Using the Docker
  3. Using the Helm Chart

General pre-requisites​

  • PostgreSQL (version 13 or above)
  • ElasticSearch v7 (optional)

Using the CLI​

Using config file​

Create a config file with the following command 

$ compass config init

alternatively you can use --config flag to customize to config file location.

You can also use environment variables to provide the server configuration.

Setup up the Postgres database, and ElasticSearch instance and provide the details as shown in the example below.

If you're new to YAML and want to learn more, see Learn YAML in Y minutes.

Following is a sample server configuration yaml:

compass.yaml
log_level: info                                 # debug|info|warning|error|fatal|trace|panic - default: info

elasticsearch:
    brokers: http://localhost:9200              #required

db:
    host: localhost                             #required
    port: 5432                                  #required
    name: compass                               #required
    user: compass                               #required
    password: compass_password                  #required
    sslmode: disable                            #optional

service:
    host: localhost                             #required
    port: 8080                                  #required    
    identity:                                   
        headerkey_uuid: Compass-User-UUID       #required
        headerkey_email: Compass-User-Email     #optional
        provider_default_name: shield           #optional
    grpc:
        port: 8081                              #required
        max_send_msg_size: 33554432     
        max_recv_msg_size: 33554432

Using environment variable​

All the server configurations can be passed as environment variables using underscore _ as the delimiter between nested keys.

See configuration reference for the list of all the configuration keys.

.env
LOG_LEVEL=info
ELASTICSEARCH_BROKERS=http://localhost:9200
DB_HOST=localhost
DB_PORT=5432
DB_NAME=compass
DB_USER=compass
DB_PASSWORD=compass_password
DB_SSLMODE=disable
SERVICE_HOST=localhost
SERVICE_PORT=8080
SERVICE_IDENTITY_HEADERKEY_UUID=Compass-User-UUID
SERVICE_IDENTITY_HEADERKEY_EMAIL=Compass-User-Email
SERVICE_IDENTITY_PROVIDER_DEFAULT_NAME=shield
SERVICE_GRPC_PORT=8081
SERVICE_GRPC_MAX_SEND_MSG_SIZE=33554432
SERVICE_GRPC_MAX_RECV_MSG_SIZE=33554432

Set the env variable using export

$ export DB_PORT = 5432

Starting the server​

Database migration is required during the first server initialization. In addition, re-running the migration command might be needed in a new release to apply the new schema changes (if any). It's safer to always re-run the migration script before deploying/starting a new release.

To initialize the database schema, Run Migrations with the following command:

$ compass server migrate

To run the Compass server use command:

$ compass server start

Using --config flag​

$ compass server migrate --config=<path-to-file> 
$ compass server start --config=<path-to-file>

Using the Docker​

To run the Compass server using Docker, you need to have Docker installed on your system. You can find the installation instructions here.

You can choose to set the configuration using environment variables or a config file. The environment variables will override the config file.

If you use Docker to build compass, then configuring networking requires extra steps. Following is one of doing it by running postgres and elasticsearch inside with docker-compose first.

Go to the root of this project and run docker-compose.

$ docker-compose up

Once postgres and elasticsearch has been ready, we can run Compass by passing in the config of postgres and elasticsearch defined in docker-compose.yaml file.

Using config file​

Alternatively you can use the compass.yaml config file defined above and run the following command.

$ docker run -d \
    --restart=always \
    -p 8080:8080 \
    -v $(pwd)/compass.yaml:/compass.yaml \
    --name compass-server \
    gotocompany/compass:<version> \
    server start -c /compass.yaml

Using environment variables​

All the configs can be passed as environment variables using underscore _ as the delimiter between nested keys. See the example as discussed above

Run the following command to start the server

$ docker run -d \
    --restart=always \
    -p 8080:8080 \
    --env-file .env \
    --name compass-server \
    gotocompany/compass:<version> \
    server start

Using the Helm chart​

Pre-requisites for Helm chart​

Compass can be installed in Kubernetes using the Helm chart from https://github.com/goto/charts.

Ensure that the following requirements are met:

  • Kubernetes 1.14+
  • Helm version 3.x is installed

Add ODPF Helm repository​

Add ODPF chart repository to Helm:

helm repo add goto https://goto.github.io/charts/

You can update the chart repository by running:

helm repo update

Setup helm values​

The following table lists the configurable parameters of the Compass chart and their default values.

See full helm values guide here

values.yaml
app:
  image:
    repository: gotocompany/compass
    pullPolicy: Always
    tag: "0.5.0"
  container:
    command:
      - compass
    args:
      - server start
    livenessProbe:
      httpGet:
        path: /ping
        port: tcp
    readinessProbe:
      httpGet:
        path: /ping
        port: tcp

  migration:
    enabled: true
    command:
      - compass
    args:
      - server migrate

  service:
    annotations: {}

  ingress:
    enabled: true
    annotations:
      kubernetes.io/ingress.class: contour
    hosts:
      - host: compass.example.com
        paths:
          - path: /
            pathType: ImplementationSpecific
            backend:
              service:
                # name: backend_01
                port:
                  number: 80

  config:
    COMPASS_SERVICE_PORT: 8080
    COMPASS_SERVICE_GRPC_PORT: 8081
    # COMPASS_SERVICE_HOST: 0.0.0.0
    # COMPASS_STATSD_ENABLED: false
    # COMPASS_STATSD_PREFIX: compass
    # COMPASS_NEWRELIC_ENABLED: false
    # COMPASS_NEWRELIC_APPNAME: compass
    # COMPASS_LOG_LEVEL: info

  secretConfig: {}
    # COMPASS_ELASTICSEARCH_BROKERS: ~
    # COMPASS_STATSD_ADDRESS: ~
    # COMPASS_NEWRELIC_LICENSEKEY: ~
    # COMPASS_DB_HOST: ~
    # COMPASS_DB_PORT: 5432
    # COMPASS_DB_NAME: ~
    # COMPASS_DB_USER: ~
    # COMPASS_DB_PASSWORD: ~
    # COMPASS_DB_SSLMODE: disable

And install it with the helm command line along with the values file:

$ helm install my-release -f values.yaml goto/compass

Client Initialisation​

Add client configurations in the same ~/compass.yaml file in root of current directory. Open this file to configure client. 

client:
    host: localhost:8081
    serverheaderkey_uuid: Compass-User-UUID
    serverheadervalue_uuid: john.doe@example.com

Required Header/Metadata in API​

Compass has a concept of User. In the current version, all HTTP & gRPC APIs in Compass requires an identity header/metadata in the request. The header key is configurable but the default name is Compass-User-UUID.

Compass APIs also expect an additional optional e-mail header. This is also configurable and the default name is Compass-User-Email. The purpose of having this optional e-mail header is described in the User section.

If everything goes ok, you should see something like this:

time="2022-04-27T09:18:08Z" level=info msg="compass starting" version=v0.2.0
time="2022-04-27T09:18:08Z" level=info msg="connected to elasticsearch cluster" config="\"docker-cluster\" (server version 7.6.1)"
time="2022-04-27T09:18:08Z" level=info msg="New Relic monitoring is disabled."
time="2022-04-27T09:18:08Z" level=info msg="statsd metrics monitoring is disabled."
time="2022-04-27T09:18:08Z" level=info msg="connected to postgres server" host=postgres port=5432
time="2022-04-27T09:18:08Z" level=info msg="server started"
- + \ No newline at end of file diff --git a/contribute/contributing/index.html b/contribute/contributing/index.html index c71b3a26..ce1513bb 100644 --- a/contribute/contributing/index.html +++ b/contribute/contributing/index.html @@ -8,13 +8,13 @@ Contribution Process | Compass - +

Contribution Process

BECOME A COMMITOR & CONTRIBUTE​

We are always interested in adding new contributors. What we look for is a series of contributions, good taste, and an ongoing interest in the project.

  • Committers will have write access to the Compass repositories.
  • There is no strict protocol for becoming a committer or PMC member. Candidates for new committers are typically people that are active contributors and community members.
  • Candidates for new committers can also be suggested by current committers or PMC members.
  • If you would like to become a committer, you should start contributing to Compass in any of the ways mentioned. You might also want to talk to other committers and ask for their advice and guidance.

WHAT CAN YOU DO?​

  • You can report a bug or suggest a feature enhancement or can just ask questions. Reach out on Github discussions for this purpose.
  • You can modify the code
    • Add any new feature
    • Optimise Lineage Graph building
    • Improve Health and Monitoring Metrics
    • Improve Logging
    • Update deprecated libraries or tools
  • You can help with documenting new features or improve existing documentation.
  • You can also review and accept other contributions if you are a Commiter.

GUIDELINES​

Please follow these practices for your changes to get merged faster:

  • Contributions can only be accepted if they contain appropriate testing (Unit and Integration Tests).
  • If you are introducing a completely new feature or making any major changes in an existing one, we recommend to start with an RFC and get consensus on the basic design first.
  • Make sure your local build is running with all the tests and checkstyle passing.
  • If your change is related to user-facing protocols / configurations, you need to make the corresponding change in the documentation as well.
  • Docs live in the code repo under docs so that changes to that can be done in the same PR as changes to the code.
- + \ No newline at end of file diff --git a/contribute/development-guide/index.html b/contribute/development-guide/index.html index 500cb94f..7f5fffb4 100644 --- a/contribute/development-guide/index.html +++ b/contribute/development-guide/index.html @@ -8,13 +8,13 @@ Development Guide | Compass - +
- + \ No newline at end of file diff --git a/guides/discussion/index.html b/guides/discussion/index.html index 047e04e3..8dd9abc7 100644 --- a/guides/discussion/index.html +++ b/guides/discussion/index.html @@ -8,13 +8,13 @@ Discussion | Compass - +

Discussion

Discussion is a new feature in Compass. One could create a discussion and all users can put comment in it. Currently, there are three types of discussions issues, open ended, and question and answer. Depending on the type, the discussion could have multiple possible states. In the current version, all types only have two states: open and closed. A newly created discussion will always be assign an open state.

Create a Discussion​

A discussion thread can be created with the Discussion API. The API contract is available here.

$ compass discussion post --body=<filepath to discussion body>
{
  "title": "The first discussion",
  "body": "This is the first discussion thread in Compass",
  "type": "openended"
}

Fetching All Discussions​

The Get Discussions will fetch all discussions in Compass.

$ compass discussion list

The response will be something like

{
    "data": [
        {
            "id": "1",
            "title": "The first discussion",
            "body": "This is the first discussion thread in Compass",
            "type": "openended"
            "state": "open",
            "labels": [],
            "assets": [],
            "assignees": [],
            "owner": {
                "id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
                "email": "gotocompany@email.com",
                "provider": "shield"
            },
            "created_at": "elit cillum Duis",
            "updated_at": "velit dolor ex"
        }
    ]
}

Notice the state is open by default once we create a new discussion. There are also some additional features in discussion where we can label the discussion and assign users and assets to the discussion. These labelling and assinging assets and users could also be done when we are creating a discussion.

Patching Discussion​

If we are not labelling and assigning users & assets to the discussion in the creation step, there are also a dedicated API to do those.

$ curl --request PATCH 'http://localhost:8080/v1beta1/discussions/1' \
--header 'Compass-User-UUID:gotocompany@email.com' \
--data-raw '{
    "title": "The first discussion (duplicated)",
    "state": "closed"
}'

We just need to send the fields that we want to patch for a discussion. Some fields have array type, in this case the PATCH will overwrite the fields with the new value.

For example we have this labelled discussion.

$ curl 'http://localhost:8080/v1beta1/discussions' \
--header 'Compass-User-UUID:gotocompany@email.com'

{
    "data": [
        {
            "id": "1",
            "title": "The first discussion",
            "body": "This is the first discussion thread in Compass",
            "type": "openended"
            "state": "open",
            "labels": [
                "work",
                "urgent",
                "help wanted"
            ],
            "owner": {
                "id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
                "email": "gotocompany@email.com",
                "provider": "shield"
            },
            "created_at": "elit cillum Duis",
            "updated_at": "velit dolor ex"
        }
    ]
}

If we patch the label with the new values.

$ curl --request PATCH 'http://localhost:8080/v1beta1/discussions/1' \
--header 'Compass-User-UUID:gotocompany@email.com' \
--data-raw '{
    "labels": ["new value"]
}'

The discussion with id 1 will be updated like this.

$ curl 'http://localhost:8080/v1beta1/discussions' \
--header 'Compass-User-UUID:gotocompany@email.com'

{
    "data": [
        {
            "id": "1",
            "title": "The first discussion",
            "body": "This is the first discussion thread in Compass",
            "type": "openended"
            "state": "open",
            "labels": [
                "new value"
            ],
            "owner": {
                "id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
                "email": "gotocompany@email.com",
                "provider": "shield"
            },
            "created_at": "elit cillum Duis",
            "updated_at": "velit dolor ex"
        }
    ]
}

Commenting a Discussion​

One could also comment a specific discussion with discussion comment API.

$ curl --request POST 'http://localhost:8080/v1beta1/discussions/1/comments' \
--header 'Compass-User-UUID:gotocompany@email.com' \
--data-raw '{
  "body": "This is the first comment of discussion 1"
}'

Getting All My Discussions​

Compass integrates discussions with User API so we could fetch all discussions belong to us with this API.

$ curl 'http://localhost:8080/v1beta1/me/discussions' \
--header 'Compass-User-UUID:gotocompany@email.com'

{
    "data": [
        {
            "id": "1",
            "title": "The first discussion",
            "body": "This is the first discussion thread in Compass",
            "type": "openended"
            "state": "open",
            "labels": [
                "new value"
            ],
            "owner": {
                "id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
                "email": "gotocompany@email.com",
                "provider": "shield"
            },
            "created_at": "elit cillum Duis",
            "updated_at": "velit dolor ex"
        }
    ]
}
- + \ No newline at end of file diff --git a/guides/ingestion/index.html b/guides/ingestion/index.html index 6369f22d..79fc7969 100644 --- a/guides/ingestion/index.html +++ b/guides/ingestion/index.html @@ -8,13 +8,13 @@ Ingesting metadata | Compass - +

Ingesting metadata

This document showcases compass usage, from producing data, to using APIs for specific use-cases. This guide is geared towards adminstrators, more than users. It is meant to give the administrators an introduction of different configuration options available, and how they affect the behaviour of the application.

Prerequisites​

This guide assumes that you have a local instance of compass running and listening on localhost:8080. See Installation guide for information on how to run Compass.

Adding Data​

Let’s say that you have a hypothetical tool called Piccolo and you have several deployments of this tool on your platform. Before we can push data for Piccolo deployments to Compass, you need to recognize the type of Piccolo, whether it is a kind of table, topic, dashboard, or job. One can ingest metadata to compass with the Upsert Patch API. The API contract is available here.

If there is an existing asset, Upsert Patch API will check each field whether there is an update in the field of the existing asset. With this behaviour, it is possible to send partial updated field to update a certain field only as long as the urn, type, and service match with the existing asset. If there is any field changed, a new version of the asset will be created. If the asset does not exist, upsert patch API will create a new asset. Apart from asset details, we also could send upstreams and downstreams of lineage edges of the asset in the body.

Let's say piccolo tool is a kind of table, we can start pushing data for it. Let's add 3 metadata of picollo.

$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
--header 'Compass-User-UUID:gotocompany@email.com' \
--data-raw '{
    "asset": {
        "urn": "picollo:deployment-01",
        "type": "table",
        "name": "deployment-01",
        "service": "picollo",
        "description": "this is the one",
        "data": {},
        "owners": [
            {
                "email": "john.doe@email.com"
            }
        ]
    }
}'

Searching​

We can search for required text in the following ways:​

  1. Using compass search <text> CLI command
  2. Calling to GET /v1beta1/search API with text to be searched as query parameter

Now we're ready to start searching. Let's run a search for the term 'one' from the assets we ingested earlier.

$ compass search one

The output is the following:

{
    "data": [
         {
            "urn": "picollo:deployment-01",
            "type": "table",
            "name": "deployment-01",
            "service": "picollo",
            "description": "this is the one",
            "data": {},
            "owners": [
                {
                    "email": "john.doe@email.com"
                }
            ],
            "labels": {}
        },
        {
            "urn": "picollo:deployment-03",
            "type": "table",
            "name": "deployment-03",
            "service": "picollo",
            "description": "the last one",
            "data": {},
            "owners": [
                {
                    "email": "kami@email.com"
                }
            ],
            "labels": {}
        }
    ]
}

The search is run against ALL fields of the records. It can be further restricted by specifying a filter criteria, could be exact match with filter and fuzzy match with query. For instance, if you wish to restrict the search to piccolo deployments that belong to kami (fuzzy), you can run:

We can search with custom queries in the following ways:​

  1. Using compass search <text> --query=field_key1:val1 CLI command
  2. Calling to GET /v1beta1/search API with text and query[field_key1]=val1 as query parameters 
$ compass search one --query=owners:kami

The output is the following:

{
    "data": [
        {
            "urn": "picollo:deployment-03",
            "type": "table",
            "name": "deployment-03",
            "service": "picollo",
            "description": "the last one",
            "data": {},
            "owners": [
                {
                    "email": "kami@email.com"
                }
            ],
            "labels": {}
        }
    ]
}

Lineage​

Now that we have configured the piccolo type and learnt how to use the search API to search it's assets, let's configure lineage for it.

To begin with, let's start over adding picolo metadata with its lineage information and add another metadata with service name sensu and type topic and add some records for it.

Adding picollo Metadata​

$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
--header 'Compass-User-UUID:gotocompany@email.com' \
--data-raw '{
    "asset": {
        "urn": "picollo:deployment-01",
        "type": "table",
        "name": "deployment-01",
        "service": "picollo",
        "description": "this is the one",
        "data": {},
        "owners": [
            {
                "email": "john.doe@email.com"
            }
        ]
    },
    "upstreams": [
        {
            "urn": "sensu:deployment-01",
            "type": "topic",
            "service": "sensu"
        }
    ],
    "downstreams": [
        {
            "urn": "gohan:deployment-01",
            "type": "table",
            "service": "gohan"
        }
    ]
}'

Adding sensu Metadata​

sensu is the data store that piccolo instances read from. In order to have a lineage, we need to have the metadata urn of sensu in Compass.

For instance, if you look at the upstreams and downstreams fields when we are ingesting piccolo metadata, you'll see that they are urn's of sensu instances. This means we can define the relationship between piccolo and sensu resources by declaring this relationship in piccolo's definition.

$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
--header 'Compass-User-UUID:gotocompany@email.com' \
--data-raw '{
    "asset": {
        "urn": "sensu:deployment-01",
        "type": "topic",
        "name": "deployment-01",
        "service": "sensu",
        "description": "primary sensu dataset",
        "data": {}
    },
    "upstreams": [],
    "downstreams": []
}'

Note: it is sufficient (and preferred) that one declare it's relationship to another. Both need not do this.

Querying Lineage​

We can search for lineage in the following ways:​

  1. Using compass lineage <urn> CLI command
  2. Calling to GET /v1beta1/lineage/:urn API with urn to be searched as the path parameter
$ compass lineage picollo:deployment-01

The output is the following:

{
    "data": [
        {
            "source": "sensu:deployment-01",
            "target": "picollo:deployment-01",
            "prop": {
                "root": "picollo:deployment-01"
            }
        },
        {
            "source": "picollo:deployment-01",
            "target": "gohan:deployment-01",
            "prop": {
                "root": "picollo:deployment-01"
            }
        }
    ],
    "node_attrs": {}
}

The response represents a graph that consists of edges in its graph.

- + \ No newline at end of file diff --git a/guides/querying/index.html b/guides/querying/index.html index be13a391..b582b972 100644 --- a/guides/querying/index.html +++ b/guides/querying/index.html @@ -8,14 +8,14 @@ Querying metadata | Compass - +

Querying metadata

Prerequisites​

This guide assumes that you have a local instance of compass running and listening on localhost:8080. See Installation guide for information on how to run Compass.

Using the Search API​

We can search for required text in the following ways:​

  1. Using compass search <text> CLI command
  2. Calling to GET /v1beta1/search API with text to be searched as query parameter

The API contract is available here.

To demonstrate how to use compass, we’re going to query it for resources that contain the word ‘booking’.

$ compass search booking

This will return a list of search results. Here’s a sample response:

{
    "data": [
        {
            "id": "00c06ef7-badb-4236-9d9e-889697cbda46",
            "urn": "kafka::g-godata-id-playground/ g-godata-id-seg-enriched-booking-dagger",
            "type": "topic",
            "service": "kafka",
            "name": "g-godata-id-seg-enriched-booking-dagger",
            "description": "",
            "labels": {
                "flink_name": "g-godata-id-playground",
                "sink_type": "kafka"
            }
        },
        {
            "id": "9e69c08a-c3c2-4e04-957f-c8010c1e6515",
            "urn": "kafka::g-godata-id-playground/ g-godata-id-booking-bach-test-dagger",
            "type": "topic",
            "service": "kafka",
            "name": "g-godata-id-booking-bach-test-dagger",
            "description": "",
            "labels": {
                "flink_name": "g-godata-id-playground",
                "sink_type": "kafka"
            }
        },
        {
            "id": "ff597a0f-8062-4370-a54c-fd6f6c12d2a0",
            "urn": "kafka::g-godata-id-playground/ g-godata-id-booking-bach-test-3-dagger",
            "type": "topic",
            "service": "kafka",
            "title": "g-godata-id-booking-bach-test-3-dagger",
            "description": "",
            "labels": {
                "flink_name": "g-godata-id-playground",
                "sink_type": "kafka"
            }
        }
    ]
}

Compass decouple identifier from external system with the one that is being used internally. ID is the internally auto-generated unique identifier. URN is the external identifier of the asset, while Name is the human friendly name for it. See the complete API spec to learn more about what the rest of the fields mean.

Filter​

Compass search supports restricting search results via filter by passing it in query params. Filter query params format is filter[{field_key}]={value} where field_key is the field name that we want to restrict and value is what value that should be matched. Filter can also support nested field by chaining key field_key with . (dot) such as filter[{field_key}.{nested_field_key}]={value}.

We can filter our search in the following ways:​

  1. Using compass search <text> --filter=field_key1:val1 CLI command
  2. Calling to GET /v1beta1/search API with text and filter[field_key1]=val1 as query parameters

For instance, to restrict search results to the ‘id’ landscape for ‘gotocompany’ organisation, run:

$ compass search booking --filter=labels.landscape=id,labels.entity=gotocompany

Under the hood, filter's work by checking whether the matching document's contain the filter key and checking if their values match. Filters can be specified multiple times to specify a set of filter criteria. For example, to search for ‘booking’ in both ‘vn’ and ‘th’ landscape, run:

$ compass search booking --filter=labels.landscape=vn,labels.landscape=th

Query​

Apart from filters, Compass search API also supports fuzzy restriction in its query params. The difference of filter and query are, filter is for exact match on a specific field in asset while query is for fuzzy match.

We can search with custom queries in the following ways:​

  1. Using compass search <text> --query=field_key1:val1 CLI command
  2. Calling to GET /v1beta1/search API with text and query[field_key1]=val1 as query parameters

Query format is not different with filter query[{field_key}]={value} where field_key is the field name that we want to query and value is what value that should be fuzzy matched. Query could also support nested field by chaining key field_key with . (dot) such as query[{field_key}.{nested_field_key}]={value}. For instance, to search results that has a name kafka and belongs to the team data_engineering, run:

$ compass search booking --query=name:kafka,labels.team=data_eng

Ranking Results​

Compass allows user to rank the results based on a numeric field in the asset. It supports nested field by using the . (dot) to point to the nested field. For instance, to rank the search results based on usage_count in data field, run:

$ compass search booking --rankby=data.usage_count

Size​

You can also specify the number of maximum results you want compass to return using the size parameter

$ compass search booking --size=5

Using the Suggest API​

The Suggest API gives a number of suggestion based on asset's name. There are 5 suggestions by default return by this API.

The API contract is available here.

Example of searching assets suggestion that has a name ‘booking’.

$ curl 'http://localhost:8080/v1beta1/search/suggest?text=booking' \
--header 'Compass-User-UUID:gotocompany@email.com'

This will return a list of suggestions. Here’s a sample response:

{
    "data": [
        "booking-daily-test-962ZFY",
        "booking-daily-test-c7OUZv",
        "booking-weekly-test-fmDeUf",
        "booking-daily-test-jkQS2b",
        "booking-daily-test-m6Oe9M"
    ]
}

Using the Get Assets API​

The Get Assets API returns assets from Compass' main storage (PostgreSQL) while the Search API returns assets from Elasticsearch. The Get Assets API has several options (filters, size, offset, etc...) in its query params.

Query ParamsDescription
types=topic,tablefilter by types
services=kafka,postgresfilter by services
data[dataset]=booking&data[project]=p-godata-idfilter by field in asset.data
q=internal&q_fields=name,urn,description,servicesquerying by field
sort=created_atsort by certain fields
direction=descsorting direction (asc / desc)

The API contract is available here.

Using the Lineage API​

The Lineage API allows the clients to query the data flow relationship between different assets managed by Compass.

See the swagger definition of Lineage API) for more information.

Lineage API returns a list of directed edges. For each edge, there are source and target fields that represent nodes to indicate the direction of the edge. Each edge could have an optional property in the props field.

We can search for lineage in the following ways:​

  1. Using compass lineage <urn> CLI command
  2. Calling to GET /v1beta1/lineage/:urn API with urn to be searched as the path parameter
$ compass lineage data-project:datalake.events
{
    "data": [
        {
            "source": {
                "urn": "data-project:datalake.events",
                "type": "table",
                "service": "bigquery",
            },
            "target": {
                "urn": "events-transform-dwh",
                "type": "csv",
                "service": "s3",
            },
            "props": {}
        },
        {
            "source": {
                "urn": "events-ingestion",
                "type": "topic",
                "service": "beast",
            },
            "target": {
                "urn": "data-project:datalake.events",
                "type": "table",
                "service": "bigquery",
            },
            "props": {}
        },
    ]
}

The lineage is fetched from the perspective of an asset. The response shows it has a list of upstreams and downstreams assets of the requested asset. Notice that in the URL, we are using urn instead of id. The reason is because we use urn as a main identifier in our lineage storage. We don't use id to store the lineage as a main identifier, because id is internally auto generated and in lineage, there might be some assets that we don't store in our Compass' storage yet.

- + \ No newline at end of file diff --git a/guides/starring/index.html b/guides/starring/index.html index 8da59bd1..ca30f5a2 100644 --- a/guides/starring/index.html +++ b/guides/starring/index.html @@ -8,13 +8,13 @@ Starring | Compass - +

Starring

Compass allows a user to stars an asset. This bookmarking functionality is introduced to increase the speed of a user to get information.

To star and asset, we can use the User Starring API. Assuming we already have asset_id that we want to star.

$ curl --request PUT 'http://localhost:8080/v1beta1/me/starred/00c06ef7-badb-4236-9d9e-889697cbda46' \
--header 'Compass-User-UUID:gotocompany@email.com'

To get the list of my starred assets.

$ curl --request PUT 'http://localhost:8080/v1beta1/me/starred' \
--header 'Compass-User-UUID:gotocompany@email.com'

{
  "data": [
      {
          "id": "00c06ef7-badb-4236-9d9e-889697cbda46",
          "urn": "kafka::g-godata-id-playground/ g-godata-id-seg-enriched-booking-dagger",
          "type": "topic",
          "service": "kafka",
          "name": "g-godata-id-seg-enriched-booking-dagger",
          "description": "",
          "labels": {
              "flink_name": "g-godata-id-playground",
              "sink_type": "kafka"
          }
      }
  ]
}

There is also an API to see which users star an asset (stargazers) in the Asset API.

$ curl 'http://localhost:8080/v1beta1/assets/00c06ef7-badb-4236-9d9e-889697cbda46/stargazers' \
--header 'Compass-User-UUID:gotocompany@email.com'

{
  "data": [
      {
          "id": "1111-2222-3333",
          "email": "gotocompany@email.com",
          "provider": "shield"
      }
  ]
}
- + \ No newline at end of file diff --git a/guides/tagging/index.html b/guides/tagging/index.html index 3abaa6e2..e36c62cb 100644 --- a/guides/tagging/index.html +++ b/guides/tagging/index.html @@ -8,13 +8,13 @@ Tagging | Compass - +

Tagging

This doc explains how to tag an asset in Compass with a specific tag.

Tag Template​

To support reusability of a tag, Compass has a tag template that we need to define first before we apply it to an asset. Tagging an asset means Compass will wire tag template to assets.

Creating a tag's template could be done with Tag Template API.

$ curl --request POST 'localhost:8080/v1beta1/tags/templates' \
--header 'Compass-User-UUID: user@gotocompany.com' \
--data-raw '{
    "urn": "my-first-template",
    "display_name": "My First Template",
    "description": "This is my first template",
    "fields": [
        {
            "urn": "fieldA",
            "display_name": "Field A",
            "description": "This is Field A",
            "data_type": "string",
            "required": false
        },
        {
            "urn": "fieldB",
            "display_name": "Field B",
            "description": "This is Field B",
            "data_type": "double",
            "required": true
        }
    ]
}'

We can verify the tag's template is created by calling GET tag's templates API

$ curl --request GET 'localhost:8080/v1beta1/tags/templates' \
--header 'Compass-User-UUID: user@gotocompany.com'

The response will be like this

{
    "data": [
        {
            "urn": "my-first-template",
            "display_name": "My First Template",
            "description": "This is my first template",
            "fields": [
                {
                    "id": 1,
                    "urn": "fieldA",
                    "display_name": "Field A",
                    "description": "This is Field A",
                    "data_type": "string",
                    "created_at": "2022-05-10T09:34:18.766125Z",
                    "updated_at": "2022-05-10T09:34:18.766125Z"
                },
                {
                    "id": 2,
                    "urn": "fieldB",
                    "display_name": "Field B",
                    "description": "This is Field B",
                    "data_type": "double",
                    "required": true,
                    "created_at": "2022-05-10T09:34:18.766125Z",
                    "updated_at": "2022-05-10T09:34:18.766125Z"
                }
            ],
            "created_at": "2022-05-10T09:34:18.766125Z",
            "updated_at": "2022-05-10T09:34:18.766125Z"
        }
    ]
}

Now, we already have a template with template urn my-first-template that has 2 kind of fields with id 1 and 2.

Tagging an Asset​

Once templates exist, we can tag an asset with a template by calling PUT /v1beta1/tags/assets/{asset_id} API.

Assuming we have an asset

{
    "id": "a2c74793-b584-4d20-ba2a-28bdf6b92c08",
    "urn": "sample-urn",
    "type": "topic",
    "service": "bigquery",
    "name": "sample-name",
    "description": "sample description",
    "version": "0.1",
    "updated_by": {
        "uuid": "user@gotocompany.com"
    },
    "created_at": "2022-05-11T07:03:45.954387Z",
    "updated_at": "2022-05-11T07:03:45.954387Z"
}

We can tag the asset with template my-first-template.

$ curl --request POST 'localhost:8080/v1beta1/tags/assets' \
--header 'Compass-User-UUID: user@gotocompany.com'
--data-raw '{
    "asset_id": "a2c74793-b584-4d20-ba2a-28bdf6b92c08",
    "template_urn": "my-first-template",
    "tag_values": [
        {
            "field_id": 1,
            "field_value": "test"
        },
        {
            "field_id": 2,
            "field_value": 10.0
        }
    ]
}'

We will get response showing that the asset is already tagged.

{
    "data": {
        "asset_id": "a2c74793-b584-4d20-ba2a-28bdf6b92c08",
        "template_urn": "my-first-template",
        "tag_values": [
            {
                "field_id": 1,
                "field_value": "test",
                "field_urn": "fieldA",
                "field_display_name": "Field A",
                "field_description": "This is Field A",
                "field_data_type": "string",
                "created_at": "2022-05-11T00:06:26.475943Z",
                "updated_at": "2022-05-11T00:06:26.475943Z"
            },
            {
                "field_id": 2,
                "field_value": 10,
                "field_urn": "fieldB",
                "field_display_name": "Field B",
                "field_description": "This is Field B",
                "field_data_type": "double",
                "field_required": true,
                "created_at": "2022-05-11T00:06:26.475943Z",
                "updated_at": "2022-05-11T00:06:26.475943Z"
            }
        ],
        "template_display_name": "My First Template",
        "template_description": "This is my first template"
    }
}

Getting Asset's Tag(s)​

We can get all tags belong to an asset by calling GET /v1beta1/tags/assets/{asset_id} API.

$ curl --request GET 'localhost:8080/v1beta1/tags/assets/a2c74793-b584-4d20-ba2a-28bdf6b92c08' \
--header 'Compass-User-UUID: user@gotocompany.com'

{
    "data": [
        {
            "asset_id": "a2c74793-b584-4d20-ba2a-28bdf6b92c08",
            "template_urn": "my-first-template",
            "tag_values": [
                {
                    "field_id": 1,
                    "field_value": "test",
                    "field_urn": "fieldA",
                    "field_display_name": "Field A",
                    "field_description": "This is Field A",
                    "field_data_type": "string",
                    "created_at": "2022-05-11T00:06:26.475943Z",
                    "updated_at": "2022-05-11T00:06:26.475943Z"
                },
                {
                    "field_id": 2,
                    "field_value": 10,
                    "field_urn": "fieldB",
                    "field_display_name": "Field B",
                    "field_description": "This is Field B",
                    "field_data_type": "double",
                    "field_required": true,
                    "created_at": "2022-05-11T00:06:26.475943Z",
                    "updated_at": "2022-05-11T00:06:26.475943Z"
                }
            ],
            "template_display_name": "My First Template",
            "template_description": "This is my first template"
        }
    ]
}
- + \ No newline at end of file diff --git a/guides/telemetry/index.html b/guides/telemetry/index.html index b0b3bb90..02f4623c 100644 --- a/guides/telemetry/index.html +++ b/guides/telemetry/index.html @@ -8,13 +8,13 @@ Telemetry | Compass - +

Telemetry

Compass collects basic HTTP metrics (response time, duration, etc) and sends it to statsd and New Relic when enabled.

Statsd​

By default statsd is not enabled. To enable statsd, we just need to set these configurations below

STATSD_ENABLED=true
STATSD_ADDRESS=127.0.0.1:8125
STATSD_PREFIX=compass

New Relic​

Similar with statsd, New Relic is not enabled by default. To enable New Relic, you can set these configurations

NEW_RELIC_LICENSE_KEY=mf9d13c838u252252c43ji47q1u4ynzpDDDDTSPQ
NEW_RELIC_APP_NAME=compass

Empty NEW_RELIC_LICENSE_KEY will disable New Relic integration.

- + \ No newline at end of file diff --git a/help/index.html b/help/index.html index 98a368b5..284f9ed3 100644 --- a/help/index.html +++ b/help/index.html @@ -8,13 +8,13 @@ Help | Compass - +

Need help?

Need a bit of help? We're here for you. Check out our current issues, GitHub discussions, or get support through Slack.

GitHub Issues

Have a general issue or bug that you've found? We'd love to hear about it in our GitHub issues. This can be feature requests too!
Go to issues

GitHub Discussions

For help and questions about best practices, join our GitHub discussions. Browse and ask questions.
Go to discussions
- + \ No newline at end of file diff --git a/index.html b/index.html index 82933d13..23244205 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ Introduction | Compass - + @@ -16,7 +16,7 @@

Introduction

Welcome to the introductory guide to Compass! This guide is the best place to start with Compass. We cover what Compass is, what problems it can solve, how it works, and how you can get started using it. If you are familiar with the basics of Compass, the guide provides a more detailed reference of available features.

What is Compass?​

Compass is a search and discovery engine built for querying application deployments, datasets and meta resources. It can also optionally track data flow relationships between these resources and allow the user to view a representation of the data flow graph.

The problem we aim to solve​

Organizational teams face the challenge of finding the right data from various sources for their analysis and decision-making needs. A lack of transparency about the flow of data within the organization can lead to problems when it comes to updating or discarding outdated data.

Manual methods for tracking the dependencies of data are time-consuming and subject to human error or oversight as it depends on mapping of the movement of data in the organisation on knowledge in people's head. Huge code volume, rate of change and complexity in manually examning the data changes make the process unsustainable. In addition, organizations may struggle to locate the most relevant data from the massive amounts stored in their data stores. The longer it takes for users to find the business data they need, the less productive they are.

To address these challenges, Compass was designed as a data discovery and search tool for organizations. It provides comprehensive asset-listing and search capabilities to enhance user productivity. Organizing the data assets using Compass allows the data professionals to collect, access, and enrich metadata to support data discovery and governance. The data lineage information provided by Compass also helps organizations meet compliance requirements by offering a clear record of the movement of sensitive data. Using Compass one can identify and star the most relevant data assets, and safely delete when you don’t need.

Key Features​

Discover why users choose Compass as their main data discovery and lineage service

  • Full text search Faster and better search results powered by ElasticSearch full text search capability.
  • Search Tuning Narrow down your search results by adding filters, getting your crisp results.
  • Data Lineage Understand the relationship between metadata with data lineage interface.
  • Scale: Compass scales in an instant, both vertically and horizontally for high performance.
  • Extensibility: Add your own metadata types and resources to support wide variety of metadata.
  • Runtime: Compass can run inside VMs or containers in a fully managed runtime environment like kubernetes.

Using Compass​

You can manage the data discovery for your resources via Compass in any of the following ways:

Compass Command Line Interface​

You can use the Compass command line interface to issue commands and to perform the entire data discovery flow. Using the command line can be faster and more convenient than the console. For more information on using the Compass CLI, see the CLI Reference page.

HTTPS API​

You can get hands on asset searching, listing, tagging, starring and much more by using the Compass HTTPS API, which lets you issue HTTPS requests directly to the service. When you use the HTTPS API, you must include the user information from the configurable identity uuid in the request header. For more information, see the User Management and API reference pages.

Where to go from here​

See the installation page to install the Compass CLI. Next, we recommend completing the guides. The tour provides an overview of most of the existing functionality of Compass and takes approximately 20 minutes to complete.

After completing the tour, check out the remainder of the documentation in the reference and concepts sections for your specific areas of interest. We've aimed to provide as much documentation as we can for the various components of Compass to give you a full understanding of Compass's surface area.

Finally, follow the project on GitHub, and contact us if you'd like to get involved.

- + \ No newline at end of file diff --git a/installation/index.html b/installation/index.html index 140705d4..551212a8 100644 --- a/installation/index.html +++ b/installation/index.html @@ -8,7 +8,7 @@ Installation | Compass - + @@ -16,7 +16,7 @@

Installation

There are several approaches to install Compass.

  1. Using a pre-compiled binary
  2. Using the Docker image
  3. Installing from source

Binary (Cross-platform)​

Download the appropriate version for your platform from releases page. Once downloaded, the binary can be run from anywhere. You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account. Ideally, you should install it somewhere in your PATH for easy use. /usr/local/bin is the most probable location.

macOS​

Compass is available via a Homebrew Tap, and as downloadable binary from the releases page:

brew install goto/tap/compass

To upgrade to the latest version:

brew upgrade compass

Linux​

Compass is available as downloadable binaries from the releases page. Download the .deb or .rpm from the releases page and install with sudo dpkg -i and sudo rpm -i respectively.

Windows​

compass is available via scoop, and as a downloadable binary from the releases page:

scoop bucket add compass https://github.com/goto/scoop-bucket.git

To upgrade to the latest version:

scoop update compass

Docker​

We provide ready to use Docker container images. To pull the latest image:

docker pull gotocompany/compass:latest

To pull a specific version:

docker pull gotocompany/compass:v0.3.2

If you like to have a shell alias that runs the latest version of compass from docker whenever you type compass:

mkdir -p $HOME/.config/gotocompany
alias compass="docker run -e HOME=/tmp -v $HOME/.config/gotocompany:/tmp/.config/gotocompany --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp gotocompany/compass:latest"

Building from Source​

Begin by cloning this repository then you have two ways in which you can build compass

  • As a native executable
  • As a docker image

Run either of the following commands to clone and compile Compass from source

$ git clone git@github.com:goto/compass.git                 # (Using SSH Protocol)
$ git clone https://github.com/goto/compass.git             # (Using HTTPS Protocol)

As a native executable​

To build compass as a native executable, run make inside the cloned repository.

$ make

This will create the compass binary in the root directory

Initialise server and client config file. Customise the compass.yml file with your local configurations.

$ ./compass config init

Run database migrations

$ ./compass server migrate

Start compass server

$ ./compass server start

As a Docker image​

Building compass' Docker image is just a simple, just run docker build command and optionally name the image

$ docker build . -t compass

Verifying the installation​​

To verify if Compass is properly installed, run compass --help on your system. You should see help output. If you are executing it from the command line, make sure it is on your PATH or you may get an error about Compass not being found.

$ compass --help

What's next​

  • See the Configurations page on how to setup Compass server and client
  • See the CLI Reference for a complete list of commands and options.
- + \ No newline at end of file diff --git a/reference/api/index.html b/reference/api/index.html index 8ed424a8..3399312e 100644 --- a/reference/api/index.html +++ b/reference/api/index.html @@ -7,15 +7,15 @@ -API | Compass - +Compass | Compass +
-

API

Documentation of our Compass API with gRPC and gRPC-Gateway.

Version: 0.2.1​

License: Apache License 2.0

More about Compass

default​

/v1beta1/assets​

GET​

Summary​

Get list of assets

Description​

Returns list of assets, optionally filtered by types, services, sorting, fields in asset.data and querying fields

Parameters​
NameLocated inDescriptionRequiredSchema
qqueryfilter by specific queryNostring
q_fieldsqueryfilter by multiple query fieldsNostring
typesqueryfilter by multiple typesNostring
servicesqueryfilter by multiple servicesNostring
sortquerysorting based on fieldsNostring
directionquerysorting direction can either be asc or descNostring
sizequerymaximum size to fetchNolong
offsetqueryoffset to fetch fromNolong
with_totalqueryif set include total field in responseNoboolean
Responses​
CodeDescriptionSchema
200A successful response.GetAllAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update/Create an asset

Description​

Upsert will update an asset or create a new one if it does not exist yet

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyYesUpsertAssetRequest
Responses​
CodeDescriptionSchema
200A successful response.UpsertAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PATCH​

Summary​

Patch/Create an asset

Description​

Similar to Upsert but with patch strategy and different body format

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyYesUpsertPatchAssetRequest
Responses​
CodeDescriptionSchema
200A successful response.UpsertPatchAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{asset_urn}/probes​

POST​

Summary​

Create asset's probe

Description​

Add a new probe to an asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_urnpathYesstring
probebodyYesCreateAssetProbeRequest.Probe
Responses​
CodeDescriptionSchema
200A successful response.CreateAssetProbeResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}​

GET​

Summary​

Find an asset

Description​

Returns a single asset with given ID

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetAssetByIDResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete an asset

Description​

Delete a single asset with given ID

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}/stargazers​

GET​

Summary​

Find users that stars an asset

Description​

Returns a list of users that stars an asset

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAssetStargazersResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}/versions​

GET​

Summary​

Get version history of an asset

Description​

Returns a list of asset version history

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAssetVersionHistoryResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}/versions/{version}​

GET​

Summary​

Get asset's previous version

Description​

Returns a specific version of an asset

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
versionpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetAssetByVersionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/lineage/{urn}​

GET​

Summary​

Get Lineage Graph

Description​

Returns the lineage graph. Each entry in the graph describes a (edge) directed relation of assets with source and destination using it's urn, type, and service.

Parameters​
NameLocated inDescriptionRequiredSchema
urnpathYesstring
levelqueryNolong
directionqueryNostring
Responses​
CodeDescriptionSchema
200A successful response.GetGraphResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/search​

GET​

Summary​

Search for an asset

Description​

API for querying documents. 'text' is fuzzy matched against all the available datasets, and matched results are returned. You can specify additional match criteria using 'filter[.*]' query parameters. You can specify each filter multiple times to specify a set of values for those filters. For instance, to specify two landscape 'vn' and 'th', the query could be /search/?text=<text>&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th. As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description /search/?text=<text>&query[description]=bigqu

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for (fuzzy)Nostring
rankbyquerydescendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]"Nostring
sizequerynumber of results to returnNolong
Responses​
CodeDescriptionSchema
200A successful response.SearchAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/search/suggest​

GET​

Summary​

Suggest an asset

Description​

API for retreiving N number of asset names that similar with the text. By default, N = 5 for now and hardcoded in the code.

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for suggestionsNostring
Responses​
CodeDescriptionSchema
200A successful response.SuggestAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/discussions​

GET​

Summary​

Get all discussions

Parameters​
NameLocated inDescriptionRequiredSchema
typequeryNostring
statequeryNostring
ownerqueryNostring
assigneequeryNostring
assetqueryNostring
labelsqueryNostring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAllDiscussionsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyRequest to be sent to create a discussionYesCreateDiscussionRequest
Responses​
CodeDescriptionSchema
200A successful response.CreateDiscussionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{discussion_id}/comments​

GET​

Summary​

Get all comments of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAllCommentsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.CreateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{discussion_id}/comments/{id}​

GET​

Summary​

Get a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.UpdateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{id}​

GET​

Summary​

Get a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetDiscussionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PATCH​

Summary​

Patch a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
bodybodyYes{ "assets": [ string ], "assignees": [ string ], "body": string, "labels": [ string ], "state": string, "title": string, "type": string }
Responses​
CodeDescriptionSchema
200A successful response.PatchDiscussionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/discussions​

GET​

Summary​

Get all discussions of a user

Description​

Returns all discussions given possible filters of a user

Parameters​
NameLocated inDescriptionRequiredSchema
filterqueryNostring
typequeryNostring
statequeryNostring
assetqueryNostring
labelsqueryNostring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyDiscussionsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/discussions/{discussion_id}/comments​

GET​

Summary​

Get all comments of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAllCommentsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.CreateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{discussion_id}/comments/{id}​

GET​

Summary​

Get a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.UpdateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/lineage/{urn}​

GET​

Summary​

Get Lineage Graph

Description​

Returns the lineage graph. Each entry in the graph describes a (edge) directed relation of assets with source and destination using it's urn, type, and service.

Parameters​
NameLocated inDescriptionRequiredSchema
urnpathYesstring
levelqueryNolong
directionqueryNostring
Responses​
CodeDescriptionSchema
200A successful response.GetGraphResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/me/discussions​

GET​

Summary​

Get all discussions of a user

Description​

Returns all discussions given possible filters of a user

Parameters​
NameLocated inDescriptionRequiredSchema
filterqueryNostring
typequeryNostring
statequeryNostring
assetqueryNostring
labelsqueryNostring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyDiscussionsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/starred​

GET​

Summary​

Get my starred assets

Description​

Get all assets starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/starred/{asset_id}​

GET​

Summary​

Get my starred asset

Description​

Get an asset starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Unstar an asset

Description​

Unmark my starred asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.UnstarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Star an asset

Description​

Mark an asset with a star

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.StarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/users/{user_id}/starred​

GET​

Summary​

Get assets starred by a user

Description​

Get all assets starred by a user

Parameters​
NameLocated inDescriptionRequiredSchema
user_idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetUserStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/me/starred​

GET​

Summary​

Get my starred assets

Description​

Get all assets starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/starred/{asset_id}​

GET​

Summary​

Get my starred asset

Description​

Get an asset starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Unstar an asset

Description​

Unmark my starred asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.UnstarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Star an asset

Description​

Mark an asset with a star

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.StarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/users/{user_id}/starred​

GET​

Summary​

Get assets starred by a user

Description​

Get all assets starred by a user

Parameters​
NameLocated inDescriptionRequiredSchema
user_idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetUserStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/search​

GET​

Summary​

Search for an asset

Description​

API for querying documents. 'text' is fuzzy matched against all the available datasets, and matched results are returned. You can specify additional match criteria using 'filter[.*]' query parameters. You can specify each filter multiple times to specify a set of values for those filters. For instance, to specify two landscape 'vn' and 'th', the query could be /search/?text=<text>&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th. As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description /search/?text=<text>&query[description]=bigqu

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for (fuzzy)Nostring
rankbyquerydescendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]"Nostring
sizequerynumber of results to returnNolong
Responses​
CodeDescriptionSchema
200A successful response.SearchAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/search/suggest​

GET​

Summary​

Suggest an asset

Description​

API for retreiving N number of asset names that similar with the text. By default, N = 5 for now and hardcoded in the code.

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for suggestionsNostring
Responses​
CodeDescriptionSchema
200A successful response.SuggestAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/tags/assets​

POST​

Summary​

Tag an asset

Description​

Tag an asset with a tag template

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyRequest to be sent to create a tagYesCreateTagAssetRequest
Responses​
CodeDescriptionSchema
200A successful response.CreateTagAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/assets/{asset_id}​

GET​

Summary​

Get an asset's tags

Description​

Get all tags for an assets

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetAllTagsByAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/assets/{asset_id}/templates/{template_urn}​

GET​

Summary​

Find a tag by asset and template

Description​

Find a single tag using asset id and template urn

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetTagByAssetAndTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Remove a tag on an asset

Description​

Remove a tag on an asset in a type

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteTagAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a tag on an asset

Description​

Update a tag on an asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
template_urnpathYesstring
bodybodyYes{ "tag_values": [ TagValue ], "template_description": string, "template_display_name": string }
Responses​
CodeDescriptionSchema
200A successful response.UpdateTagAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/templates​

GET​

Summary​

Get all tag templates

Description​

Get all available tag templates

Parameters​
NameLocated inDescriptionRequiredSchema
urnqueryNostring
Responses​
CodeDescriptionSchema
200A successful response.GetAllTagTemplatesResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a template

Description​

Create a new tag template

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyRequest to be sent to create a tag's templateYesCreateTagTemplateRequest
Responses​
CodeDescriptionSchema
200A successful response.CreateTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/templates/{template_urn}​

GET​

Summary​

Get a tag template

Description​

Get a single tag template

Parameters​
NameLocated inDescriptionRequiredSchema
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete a tag template

Description​

Delete a single tag template

Parameters​
NameLocated inDescriptionRequiredSchema
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a template

Description​

Update an existing tag template

Parameters​
NameLocated inDescriptionRequiredSchema
template_urnpathYesstring
bodybodyYes{ "description": string, "display_name": string, "fields": [ TagTemplateField ] }
Responses​
CodeDescriptionSchema
200A successful response.UpdateTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/types​

GET​

Summary​

fetch all types

Description​

Fetch all types supported in Compass

Parameters​
NameLocated inDescriptionRequiredSchema
qqueryfilter by specific queryNostring
q_fieldsqueryfilter by multiple query fieldsNostring
typesqueryfilter by multiple typesNostring
servicesqueryfilter by multiple servicesNostring
Responses​
CodeDescriptionSchema
200A successful response.GetAllTypesResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

Models​

Any​

NameTypeDescriptionRequired
@typestringNo

Change​

NameTypeDescriptionRequired
fromNo
path[ string ]No
toNo
typestringNo

Comment​

NameTypeDescriptionRequired
bodystringNo
created_atdateTimeNo
discussion_idstringNo
idstringNo
ownerUserNo
updated_atdateTimeNo
updated_byUserNo

CreateAssetProbeRequest.Probe​

NameTypeDescriptionRequired
metadataobjectNo
statusstringYes
status_reasonstringNo
timestampdateTimeNo

CreateAssetProbeResponse​

NameTypeDescriptionRequired
idstringNo

CreateCommentResponse​

NameTypeDescriptionRequired
idstringNo

CreateDiscussionRequest​

Request to be sent to create a discussion

NameTypeDescriptionRequired
assets[ string ]No
assignees[ string ]No
bodystringYes
labels[ string ]No
statestringNo
titlestringYes
typestringNo

CreateDiscussionResponse​

NameTypeDescriptionRequired
idstringNo

CreateTagAssetRequest​

Request to be sent to create a tag

NameTypeDescriptionRequired
asset_idstringYes
tag_values[ TagValue ]Yes
template_descriptionstringNo
template_display_namestringNo
template_urnstringYes

CreateTagAssetResponse​

NameTypeDescriptionRequired
datav1beta1.TagNo

CreateTagTemplateRequest​

Request to be sent to create a tag's template

NameTypeDescriptionRequired
descriptionstringYes
display_namestringYes
fields[ TagTemplateField ]No
urnstringYes

CreateTagTemplateResponse​

NameTypeDescriptionRequired
dataTagTemplateNo

DeleteAssetResponse​

NameTypeDescriptionRequired
DeleteAssetResponseobject

DeleteCommentResponse​

NameTypeDescriptionRequired
DeleteCommentResponseobject

DeleteTagAssetResponse​

NameTypeDescriptionRequired
DeleteTagAssetResponseobject

DeleteTagTemplateResponse​

NameTypeDescriptionRequired
DeleteTagTemplateResponseobject

Discussion​

NameTypeDescriptionRequired
assets[ string ]No
assignees[ string ]No
bodystringNo
created_atdateTimeNo
idstringNo
labels[ string ]No
ownerUserNo
statestringNo
titlestringNo
typestringNo
updated_atdateTimeNo

GetAllAssetsResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No
totallongNo

GetAllCommentsResponse​

NameTypeDescriptionRequired
data[ Comment ]No

GetAllDiscussionsResponse​

NameTypeDescriptionRequired
data[ Discussion ]No

GetAllTagTemplatesResponse​

NameTypeDescriptionRequired
data[ TagTemplate ]No

GetAllTagsByAssetResponse​

NameTypeDescriptionRequired
data[ v1beta1.Tag ]No

GetAllTypesResponse​

NameTypeDescriptionRequired
data[ v1beta1.Type ]No

GetAssetByIDResponse​

NameTypeDescriptionRequired
datav1beta1.AssetNo

GetAssetByVersionResponse​

NameTypeDescriptionRequired
datav1beta1.AssetNo

GetAssetStargazersResponse​

NameTypeDescriptionRequired
data[ User ]No

GetAssetVersionHistoryResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No

GetCommentResponse​

NameTypeDescriptionRequired
dataCommentNo

GetDiscussionResponse​

NameTypeDescriptionRequired
dataDiscussionNo

GetGraphResponse​

NameTypeDescriptionRequired
data[ LineageEdge ]Edges in the graph.No
node_attrsobjectKey is the asset URN. Node attributes, if present, will be returned for source and target nodes in the LineageEdge.No

GetMyDiscussionsResponse​

NameTypeDescriptionRequired
data[ Discussion ]No

GetMyStarredAssetResponse​

NameTypeDescriptionRequired
datav1beta1.AssetNo

GetMyStarredAssetsResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No

GetTagByAssetAndTemplateResponse​

NameTypeDescriptionRequired
datav1beta1.TagNo

GetTagTemplateResponse​

NameTypeDescriptionRequired
dataTagTemplateNo

GetUserStarredAssetsResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No

LineageEdge​

NameTypeDescriptionRequired
propobjectNo
sourcestringNo
targetstringNo

LineageNode​

NameTypeDescriptionRequired
servicestringNo
typestringNo
urnstringNo

NodeAttributes​

NameTypeDescriptionRequired
probesProbesInfoNo

NullValue​

NullValue is a singleton enumeration to represent the null value for the +

Compass

Documentation of our Compass API with gRPC and gRPC-Gateway.

Version: 0.2.1​

License: Apache License 2.0

More about Compass

default​

/v1beta1/assets​

GET​

Summary​

Get list of assets

Description​

Returns list of assets, optionally filtered by types, services, sorting, fields in asset.data and querying fields

Parameters​
NameLocated inDescriptionRequiredSchema
qqueryfilter by specific queryNostring
q_fieldsqueryfilter by multiple query fieldsNostring
typesqueryfilter by multiple typesNostring
servicesqueryfilter by multiple servicesNostring
sortquerysorting based on fieldsNostring
directionquerysorting direction can either be asc or descNostring
sizequerymaximum size to fetchNolong
offsetqueryoffset to fetch fromNolong
with_totalqueryif set include total field in responseNoboolean
Responses​
CodeDescriptionSchema
200A successful response.GetAllAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update/Create an asset

Description​

Upsert will update an asset or create a new one if it does not exist yet

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyYesUpsertAssetRequest
Responses​
CodeDescriptionSchema
200A successful response.UpsertAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PATCH​

Summary​

Patch/Create an asset

Description​

Similar to Upsert but with patch strategy and different body format

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyYesUpsertPatchAssetRequest
Responses​
CodeDescriptionSchema
200A successful response.UpsertPatchAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{asset_urn}/probes​

POST​

Summary​

Create asset's probe

Description​

Add a new probe to an asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_urnpathYesstring
probebodyYesCreateAssetProbeRequest.Probe
Responses​
CodeDescriptionSchema
200A successful response.CreateAssetProbeResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}​

GET​

Summary​

Find an asset

Description​

Returns a single asset with given ID

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetAssetByIDResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete an asset

Description​

Delete a single asset with given ID

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}/stargazers​

GET​

Summary​

Find users that stars an asset

Description​

Returns a list of users that stars an asset

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAssetStargazersResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}/versions​

GET​

Summary​

Get version history of an asset

Description​

Returns a list of asset version history

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAssetVersionHistoryResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/assets/{id}/versions/{version}​

GET​

Summary​

Get asset's previous version

Description​

Returns a specific version of an asset

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
versionpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetAssetByVersionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/lineage/{urn}​

GET​

Summary​

Get Lineage Graph

Description​

Returns the lineage graph. Each entry in the graph describes a (edge) directed relation of assets with source and destination using it's urn, type, and service.

Parameters​
NameLocated inDescriptionRequiredSchema
urnpathYesstring
levelqueryNolong
directionqueryNostring
Responses​
CodeDescriptionSchema
200A successful response.GetGraphResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/search​

GET​

Summary​

Search for an asset

Description​

API for querying documents. 'text' is fuzzy matched against all the available datasets, and matched results are returned. You can specify additional match criteria using 'filter[.*]' query parameters. You can specify each filter multiple times to specify a set of values for those filters. For instance, to specify two landscape 'vn' and 'th', the query could be /search/?text=<text>&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th. As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description /search/?text=<text>&query[description]=bigqu

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for (fuzzy)Nostring
rankbyquerydescendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]"Nostring
sizequerynumber of results to returnNolong
include_fieldsqueryNo[ string ]
offsetqueryoffset parameter defines the offset from the first result you want to fetchNolong
Responses​
CodeDescriptionSchema
200A successful response.SearchAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/search/suggest​

GET​

Summary​

Suggest an asset

Description​

API for retreiving N number of asset names that similar with the text. By default, N = 5 for now and hardcoded in the code.

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for suggestionsNostring
Responses​
CodeDescriptionSchema
200A successful response.SuggestAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/discussions​

GET​

Summary​

Get all discussions

Parameters​
NameLocated inDescriptionRequiredSchema
typequeryNostring
statequeryNostring
ownerqueryNostring
assigneequeryNostring
assetqueryNostring
labelsqueryNostring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAllDiscussionsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyRequest to be sent to create a discussionYesCreateDiscussionRequest
Responses​
CodeDescriptionSchema
200A successful response.CreateDiscussionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{discussion_id}/comments​

GET​

Summary​

Get all comments of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAllCommentsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.CreateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{discussion_id}/comments/{id}​

GET​

Summary​

Get a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.UpdateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{id}​

GET​

Summary​

Get a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetDiscussionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PATCH​

Summary​

Patch a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
idpathYesstring
bodybodyYes{ "assets": [ string ], "assignees": [ string ], "body": string, "labels": [ string ], "state": string, "title": string, "type": string }
Responses​
CodeDescriptionSchema
200A successful response.PatchDiscussionResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/discussions​

GET​

Summary​

Get all discussions of a user

Description​

Returns all discussions given possible filters of a user

Parameters​
NameLocated inDescriptionRequiredSchema
filterqueryNostring
typequeryNostring
statequeryNostring
assetqueryNostring
labelsqueryNostring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyDiscussionsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/discussions/{discussion_id}/comments​

GET​

Summary​

Get all comments of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetAllCommentsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.CreateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/discussions/{discussion_id}/comments/{id}​

GET​

Summary​

Get a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a comment of a discussion

Parameters​
NameLocated inDescriptionRequiredSchema
discussion_idpathYesstring
idpathYesstring
bodybodyYes{ "body": string }
Responses​
CodeDescriptionSchema
200A successful response.UpdateCommentResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/lineage/{urn}​

GET​

Summary​

Get Lineage Graph

Description​

Returns the lineage graph. Each entry in the graph describes a (edge) directed relation of assets with source and destination using it's urn, type, and service.

Parameters​
NameLocated inDescriptionRequiredSchema
urnpathYesstring
levelqueryNolong
directionqueryNostring
Responses​
CodeDescriptionSchema
200A successful response.GetGraphResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/me/discussions​

GET​

Summary​

Get all discussions of a user

Description​

Returns all discussions given possible filters of a user

Parameters​
NameLocated inDescriptionRequiredSchema
filterqueryNostring
typequeryNostring
statequeryNostring
assetqueryNostring
labelsqueryNostring
sortqueryNostring
directionqueryNostring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyDiscussionsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/starred​

GET​

Summary​

Get my starred assets

Description​

Get all assets starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/starred/{asset_id}​

GET​

Summary​

Get my starred asset

Description​

Get an asset starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Unstar an asset

Description​

Unmark my starred asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.UnstarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Star an asset

Description​

Mark an asset with a star

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.StarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/users/{user_id}/starred​

GET​

Summary​

Get assets starred by a user

Description​

Get all assets starred by a user

Parameters​
NameLocated inDescriptionRequiredSchema
user_idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetUserStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/me/starred​

GET​

Summary​

Get my starred assets

Description​

Get all assets starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/me/starred/{asset_id}​

GET​

Summary​

Get my starred asset

Description​

Get an asset starred by me

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetMyStarredAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Unstar an asset

Description​

Unmark my starred asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.UnstarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Star an asset

Description​

Mark an asset with a star

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.StarAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/users/{user_id}/starred​

GET​

Summary​

Get assets starred by a user

Description​

Get all assets starred by a user

Parameters​
NameLocated inDescriptionRequiredSchema
user_idpathYesstring
sizequeryNolong
offsetqueryNolong
Responses​
CodeDescriptionSchema
200A successful response.GetUserStarredAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/search​

GET​

Summary​

Search for an asset

Description​

API for querying documents. 'text' is fuzzy matched against all the available datasets, and matched results are returned. You can specify additional match criteria using 'filter[.*]' query parameters. You can specify each filter multiple times to specify a set of values for those filters. For instance, to specify two landscape 'vn' and 'th', the query could be /search/?text=<text>&filter[environment]=integration&filter[landscape]=vn&filter[landscape]=th. As an alternative, this API also supports fuzzy filter match with 'query' query params. For instance, searching assets that has 'bigqu' term in its description /search/?text=<text>&query[description]=bigqu

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for (fuzzy)Nostring
rankbyquerydescendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]"Nostring
sizequerynumber of results to returnNolong
include_fieldsqueryNo[ string ]
offsetqueryoffset parameter defines the offset from the first result you want to fetchNolong
Responses​
CodeDescriptionSchema
200A successful response.SearchAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/search/suggest​

GET​

Summary​

Suggest an asset

Description​

API for retreiving N number of asset names that similar with the text. By default, N = 5 for now and hardcoded in the code.

Parameters​
NameLocated inDescriptionRequiredSchema
textquerytext to search for suggestionsNostring
Responses​
CodeDescriptionSchema
200A successful response.SuggestAssetsResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/tags/assets​

POST​

Summary​

Tag an asset

Description​

Tag an asset with a tag template

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyRequest to be sent to create a tagYesCreateTagAssetRequest
Responses​
CodeDescriptionSchema
200A successful response.CreateTagAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/assets/{asset_id}​

GET​

Summary​

Get an asset's tags

Description​

Get all tags for an assets

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetAllTagsByAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/assets/{asset_id}/templates/{template_urn}​

GET​

Summary​

Find a tag by asset and template

Description​

Find a single tag using asset id and template urn

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetTagByAssetAndTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Remove a tag on an asset

Description​

Remove a tag on an asset in a type

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteTagAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a tag on an asset

Description​

Update a tag on an asset

Parameters​
NameLocated inDescriptionRequiredSchema
asset_idpathYesstring
template_urnpathYesstring
bodybodyYes{ "tag_values": [ TagValue ], "template_description": string, "template_display_name": string }
Responses​
CodeDescriptionSchema
200A successful response.UpdateTagAssetResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/templates​

GET​

Summary​

Get all tag templates

Description​

Get all available tag templates

Parameters​
NameLocated inDescriptionRequiredSchema
urnqueryNostring
Responses​
CodeDescriptionSchema
200A successful response.GetAllTagTemplatesResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

POST​

Summary​

Create a template

Description​

Create a new tag template

Parameters​
NameLocated inDescriptionRequiredSchema
bodybodyRequest to be sent to create a tag's templateYesCreateTagTemplateRequest
Responses​
CodeDescriptionSchema
200A successful response.CreateTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

/v1beta1/tags/templates/{template_urn}​

GET​

Summary​

Get a tag template

Description​

Get a single tag template

Parameters​
NameLocated inDescriptionRequiredSchema
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.GetTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

DELETE​

Summary​

Delete a tag template

Description​

Delete a single tag template

Parameters​
NameLocated inDescriptionRequiredSchema
template_urnpathYesstring
Responses​
CodeDescriptionSchema
200A successful response.DeleteTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

PUT​

Summary​

Update a template

Description​

Update an existing tag template

Parameters​
NameLocated inDescriptionRequiredSchema
template_urnpathYesstring
bodybodyYes{ "description": string, "display_name": string, "fields": [ TagTemplateField ] }
Responses​
CodeDescriptionSchema
200A successful response.UpdateTagTemplateResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

default​

/v1beta1/types​

GET​

Summary​

fetch all types

Description​

Fetch all types supported in Compass

Parameters​
NameLocated inDescriptionRequiredSchema
qqueryfilter by specific queryNostring
q_fieldsqueryfilter by multiple query fieldsNostring
typesqueryfilter by multiple typesNostring
servicesqueryfilter by multiple servicesNostring
Responses​
CodeDescriptionSchema
200A successful response.GetAllTypesResponse
400Returned when the data that user input is wrong.Status
404Returned when the resource does not exist.Status
409Returned when the resource already exist.Status
500Returned when theres is something wrong on the server side.Status
defaultAn unexpected error response.Status

Models​

Any​

NameTypeDescriptionRequired
@typestringNo

Change​

NameTypeDescriptionRequired
fromNo
path[ string ]No
toNo
typestringNo

Comment​

NameTypeDescriptionRequired
bodystringNo
created_atdateTimeNo
discussion_idstringNo
idstringNo
ownerUserNo
updated_atdateTimeNo
updated_byUserNo

CreateAssetProbeRequest.Probe​

NameTypeDescriptionRequired
metadataobjectNo
statusstringYes
status_reasonstringNo
timestampdateTimeNo

CreateAssetProbeResponse​

NameTypeDescriptionRequired
idstringNo

CreateCommentResponse​

NameTypeDescriptionRequired
idstringNo

CreateDiscussionRequest​

Request to be sent to create a discussion

NameTypeDescriptionRequired
assets[ string ]No
assignees[ string ]No
bodystringYes
labels[ string ]No
statestringNo
titlestringYes
typestringNo

CreateDiscussionResponse​

NameTypeDescriptionRequired
idstringNo

CreateTagAssetRequest​

Request to be sent to create a tag

NameTypeDescriptionRequired
asset_idstringYes
tag_values[ TagValue ]Yes
template_descriptionstringNo
template_display_namestringNo
template_urnstringYes

CreateTagAssetResponse​

NameTypeDescriptionRequired
datav1beta1.TagNo

CreateTagTemplateRequest​

Request to be sent to create a tag's template

NameTypeDescriptionRequired
descriptionstringYes
display_namestringYes
fields[ TagTemplateField ]No
urnstringYes

CreateTagTemplateResponse​

NameTypeDescriptionRequired
dataTagTemplateNo

DeleteAssetResponse​

NameTypeDescriptionRequired
DeleteAssetResponseobject

DeleteCommentResponse​

NameTypeDescriptionRequired
DeleteCommentResponseobject

DeleteTagAssetResponse​

NameTypeDescriptionRequired
DeleteTagAssetResponseobject

DeleteTagTemplateResponse​

NameTypeDescriptionRequired
DeleteTagTemplateResponseobject

Discussion​

NameTypeDescriptionRequired
assets[ string ]No
assignees[ string ]No
bodystringNo
created_atdateTimeNo
idstringNo
labels[ string ]No
ownerUserNo
statestringNo
titlestringNo
typestringNo
updated_atdateTimeNo

GetAllAssetsResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No
totallongNo

GetAllCommentsResponse​

NameTypeDescriptionRequired
data[ Comment ]No

GetAllDiscussionsResponse​

NameTypeDescriptionRequired
data[ Discussion ]No

GetAllTagTemplatesResponse​

NameTypeDescriptionRequired
data[ TagTemplate ]No

GetAllTagsByAssetResponse​

NameTypeDescriptionRequired
data[ v1beta1.Tag ]No

GetAllTypesResponse​

NameTypeDescriptionRequired
data[ v1beta1.Type ]No

GetAssetByIDResponse​

NameTypeDescriptionRequired
datav1beta1.AssetNo

GetAssetByVersionResponse​

NameTypeDescriptionRequired
datav1beta1.AssetNo

GetAssetStargazersResponse​

NameTypeDescriptionRequired
data[ User ]No

GetAssetVersionHistoryResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No

GetCommentResponse​

NameTypeDescriptionRequired
dataCommentNo

GetDiscussionResponse​

NameTypeDescriptionRequired
dataDiscussionNo

GetGraphResponse​

NameTypeDescriptionRequired
data[ LineageEdge ]Edges in the graph.No
node_attrsobjectKey is the asset URN. Node attributes, if present, will be returned for source and target nodes in the LineageEdge.No

GetMyDiscussionsResponse​

NameTypeDescriptionRequired
data[ Discussion ]No

GetMyStarredAssetResponse​

NameTypeDescriptionRequired
datav1beta1.AssetNo

GetMyStarredAssetsResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No

GetTagByAssetAndTemplateResponse​

NameTypeDescriptionRequired
datav1beta1.TagNo

GetTagTemplateResponse​

NameTypeDescriptionRequired
dataTagTemplateNo

GetUserStarredAssetsResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No

LineageEdge​

NameTypeDescriptionRequired
propobjectNo
sourcestringNo
targetstringNo

LineageNode​

NameTypeDescriptionRequired
servicestringNo
typestringNo
urnstringNo

NodeAttributes​

NameTypeDescriptionRequired
probesProbesInfoNo

NullValue​

NullValue is a singleton enumeration to represent the null value for the Value type union.

The JSON representation for NullValue is JSON null.

  • NULL_VALUE: Null value.
NameTypeDescriptionRequired
NullValuestringNullValue is a singleton enumeration to represent the null value for the Value type union. The JSON representation for NullValue is JSON null. - NULL_VALUE: Null value.

PatchDiscussionResponse​

NameTypeDescriptionRequired
PatchDiscussionResponseobject

ProbesInfo​

NameTypeDescriptionRequired
latestv1beta1.ProbeNo

SearchAssetsResponse​

NameTypeDescriptionRequired
data[ v1beta1.Asset ]No

StarAssetResponse​

NameTypeDescriptionRequired
idstringNo

Status​

NameTypeDescriptionRequired
codeintegerNo
details[ Any ]No
messagestringNo

SuggestAssetsResponse​

NameTypeDescriptionRequired
data[ string ]No

TagTemplate​

NameTypeDescriptionRequired
created_atdateTimeNo
descriptionstringNo
display_namestringNo
fields[ TagTemplateField ]No
updated_atdateTimeNo
urnstringNo

TagTemplateField​

NameTypeDescriptionRequired
created_atdateTimeNo
data_typestringNo
descriptionstringNo
display_namestringNo
idlongNo
options[ string ]No
requiredbooleanNo
updated_atdateTimeNo
urnstringNo

TagValue​

NameTypeDescriptionRequired
created_atdateTimeNo
field_data_typestringNo
field_descriptionstringNo
field_display_namestringNo
field_idlongNo
field_options[ string ]No
field_requiredbooleanNo
field_urnstringNo
field_valueNo
updated_atdateTimeNo

UnstarAssetResponse​

NameTypeDescriptionRequired
UnstarAssetResponseobject

UpdateCommentResponse​

NameTypeDescriptionRequired
UpdateCommentResponseobject

UpdateTagAssetResponse​

NameTypeDescriptionRequired
datav1beta1.TagNo

UpdateTagTemplateResponse​

NameTypeDescriptionRequired
dataTagTemplateNo

UpsertAssetRequest​

NameTypeDescriptionRequired
assetUpsertAssetRequest.AssetNo
downstreams[ LineageNode ]No
upstreams[ LineageNode ]No

UpsertAssetRequest.Asset​

NameTypeDescriptionRequired
dataobjectdynamic data of an assetNo
descriptionstringNo
labelsobjectlabels of an assetNo
namestringNo
owners[ User ]list of owners of the assetNo
servicestringNo
typestringNo
urlstringNo
urnstringNo

UpsertAssetResponse​

NameTypeDescriptionRequired
idstringNo

UpsertPatchAssetRequest​

NameTypeDescriptionRequired
assetUpsertPatchAssetRequest.AssetNo
downstreams[ LineageNode ]No
overwrite_lineagebooleanoverwrite_lineage determines whether the asset's lineage should be overwritten with the upstreams and downstreams specified in the request. Currently, it is only applicable when both upstreams and downstreams are empty/not specified.No
upstreams[ LineageNode ]No

UpsertPatchAssetRequest.Asset​

NameTypeDescriptionRequired
dataobjectdynamic data of an assetNo
descriptionstringdescription of an assetNo
labelsobjectlabels of an assetNo
namestringname of an assetNo
owners[ User ]list of owners of the assetNo
servicestringNo
typestringNo
urlstringNo
urnstringNo

UpsertPatchAssetResponse​

NameTypeDescriptionRequired
idstringNo

User​

NameTypeDescriptionRequired
created_atdateTimeNo
emailstringNo
idstringNo
providerstringNo
updated_atdateTimeNo
uuidstringNo

v1beta1.Asset​

NameTypeDescriptionRequired
changelog[ Change ]No
created_atdateTimeNo
dataobjectNo
descriptionstringNo
idstringNo
labelsobjectNo
namestringNo
owners[ User ]No
probes[ v1beta1.Probe ]No
servicestringNo
typestringNo
updated_atdateTimeNo
updated_byUserNo
urlstringNo
urnstringNo
versionstringNo

v1beta1.Probe​

NameTypeDescriptionRequired
asset_urnstringNo
created_atdateTimeNo
idstringNo
metadataobjectNo
statusstringNo
status_reasonstringNo
timestampdateTimeNo

v1beta1.Tag​

NameTypeDescriptionRequired
asset_idstringNo
tag_values[ TagValue ]No
template_descriptionstringNo
template_display_namestringNo
template_urnstringNo

v1beta1.Type​

NameTypeDescriptionRequired
countlongNo
namestringNo
- + \ No newline at end of file diff --git a/reference/cli/index.html b/reference/cli/index.html index 18fa5605..f0bee5c9 100644 --- a/reference/cli/index.html +++ b/reference/cli/index.html @@ -7,14 +7,15 @@ -CLI | Compass - +CLI | Compass +
-

CLI

compass asset​

Manage assets

compass asset delete <id>​

delete asset with the given ID

compass asset edit [flags]​

upsert a new asset or patch

-b, --body string   filepath to body that has to be upserted

compass asset list [flags]​

lists all assets

-d, --data stringToString   filter by field in asset.data (default [])
-o, --out -o json           flag to control output viewing, for json -o json (default "table")
    --page uint32           Page number offset (starts from 0)
    --query string          querying by field
    --query_fields string   querying by fields
-s, --services string       filter by services
    --size uint32           Size of each page (default 10)
    --sort string           sort by certain fields
    --sort_dir string       sorting direction (asc / desc)
-t, --types string          filter by types

compass asset star <id>​

star an asset by id for current user

compass asset stargazers <id> [flags]​

list all stargazers for a given asset id

--page uint32   Page number offset (starts from 0)
--size uint32   Size of each page (default 10)

compass asset starred [flags]​

list all the starred assets for current user

-o, --out -o json   flag to control output viewing, for json -o json (default "table")
    --page uint32   Page number offset (starts from 0)
    --size uint32   Size of each page (default 10)

compass asset types [flags]​

lists all asset types

-d, --data stringToString   filter by field in asset.data (default [])
    --query string          filter by specific query
    --query_fields string   filter by query field
-s, --services string       filter by services
-t, --types string          filter by types

compass asset unstar <id>​

unstar an asset by id for current user

compass asset version <urn> <version>​

get asset's previous version by urn or id and version number

compass asset versionhistory <id> [flags]​

get asset version history by id

--page uint32   Page number offset (start from 0)
--size uint32   Size of each page (default 10)

compass asset view <urn>​

view asset for the given ID or URN

compass completion [bash|zsh|fish|powershell]​

Generate shell completion scripts

compass config <command>​

Manage server and client configurations

compass config init​

Initialize a new sevrer and client configuration

compass config list​

List server and client configuration settings

compass discussion​

Manage discussions

compass discussion list [flags]​

lists all discussions

-o, --out -o json   flag to control output viewing, for json -o json (default "table")

compass discussion post [flags]​

post discussions, add 

-b, --body string   filepath to body that has to be upserted

compass discussion view <id>​

view discussion for the given ID

compass lineage <urn>​

observe the lineage of metadata

compass search <text> [flags]​

query the metadata available

-f, --filter string   --filter=field_key1:val1,key2:val2,key3:val3 gives exact match for values
-q, --query string    --query=--filter=field_key1:val1 supports fuzzy search
-r, --rankby string   --rankby=<numeric_field>
-s, --size uint32     --size=10 maximum size of response query

compass server <command>​

Run compass server

compass server migrate​

Run storage migration

compass server start​

Start server on default port 8080

compass version​

Print version information

- +

CLI

Run "compass config init" to initialize a new configuartion file +Run "compass help environment" for more information.

Alternatively, make a "compass.yaml" file in the current directory from the example given

compass reference

compass asset​

Manage assets

compass asset delete <id>​

delete asset with the given ID

compass asset edit [flags]​

upsert a new asset or patch

-b, --body string   filepath to body that has to be upserted

compass asset list [flags]​

lists all assets

-d, --data stringToString   filter by field in asset.data (default [])
-o, --out -o json           flag to control output viewing, for json -o json (default "table")
    --page uint32           Page number offset (starts from 0)
    --query string          querying by field
    --query_fields string   querying by fields
-s, --services string       filter by services
    --size uint32           Size of each page (default 10)
    --sort string           sort by certain fields
    --sort_dir string       sorting direction (asc / desc)
-t, --types string          filter by types

compass asset star <id>​

star an asset by id for current user

compass asset stargazers <id> [flags]​

list all stargazers for a given asset id

--page uint32   Page number offset (starts from 0)
--size uint32   Size of each page (default 10)

compass asset starred [flags]​

list all the starred assets for current user

-o, --out -o json   flag to control output viewing, for json -o json (default "table")
    --page uint32   Page number offset (starts from 0)
    --size uint32   Size of each page (default 10)

compass asset types [flags]​

lists all asset types

-d, --data stringToString   filter by field in asset.data (default [])
    --query string          filter by specific query
    --query_fields string   filter by query field
-s, --services string       filter by services
-t, --types string          filter by types

compass asset unstar <id>​

unstar an asset by id for current user

compass asset version <urn> <version>​

get asset's previous version by urn or id and version number

compass asset versionhistory <id> [flags]​

get asset version history by id

--page uint32   Page number offset (start from 0)
--size uint32   Size of each page (default 10)

compass asset view <urn>​

view asset for the given ID or URN

compass completion [bash|zsh|fish|powershell]​

Generate shell completion scripts

compass config <command>​

Manage server and client configurations

compass config init​

Initialize a new sevrer and client configuration

compass config list​

List server and client configuration settings

compass discussion​

Manage discussions

compass discussion list [flags]​

lists all discussions

-o, --out -o json   flag to control output viewing, for json -o json (default "table")

compass discussion post [flags]​

post discussions, add 

-b, --body string   filepath to body that has to be upserted

compass discussion view <id>​

view discussion for the given ID

compass lineage <urn>​

observe the lineage of metadata

compass search <text> [flags]​

query the metadata available

-f, --filter string   --filter=field_key1:val1,key2:val2,key3:val3 gives exact match for values
-q, --query string    --query=--filter=field_key1:val1 supports fuzzy search
-r, --rankby string   --rankby=<numeric_field>
-s, --size uint32     --size=10 maximum size of response query

compass server <command>​

Run compass server

compass server migrate​

Run storage migration

compass server start​

Start server on default port 8080

compass version​

Print version information

+ \ No newline at end of file diff --git a/reference/configuration/index.html b/reference/configuration/index.html index 28265fd5..70d764f5 100644 --- a/reference/configuration/index.html +++ b/reference/configuration/index.html @@ -8,13 +8,13 @@ Configurations | Compass - +
-

Configurations

This page contains reference for all the application configurations for Compass.

Table of Contents​

Generic​

Compass's required variables to start using it.

LOG_LEVEL​

  • Example value: error
  • Type: optional
  • Default: info
  • Logging level, can be one of trace, debug, info, warning, error, fatal, panic.

SERVER_HOST​

  • Example value: localhost
  • Type: required
  • Network interface to bind to.

SERVER_PORT​

  • Example value: 8080
  • Type: required
  • Port to listen on.

ELASTICSEARCH_BROKERS​

  • Example value: http://localhost:9200,http://localhost:9300
  • Type: required
  • Comma separated list of elasticsearch nodes.

DB_HOST​

  • Example value: localhost
  • Type: required
  • PostgreSQL DB hostname to connect.

DB_PORT​

  • Example value: 5432
  • Type: required
  • PostgreSQL DB port to connect.

DB_NAME​

  • Example value: compass
  • Type: required
  • PostgreSQL DB name to connect.

DB_USER​

  • Example value: postgres
  • Type: required
  • PostgreSQL DB user to connect.

DB_PASSWORD​

  • Example value: ~
  • Type: required
  • PostgreSQL DB user's password to connect.

DB_SSL_MODE​

  • Example value: disable
  • Type: optional
  • PostgreSQL DB SSL mode to connect.

IDENTITY_UUID_HEADER​

  • Example value: Compass-User-UUID
  • Type: required
  • Header key to accept Compass User UUID. See User for more information about the usage.

IDENTITY_EMAIL_HEADER​

  • Example value: Compass-User-Email
  • Type: optional
  • Header key to accept Compass User Email. See User for more information about the usage.

IDENTITY_PROVIDER_DEFAULT_NAME​

  • Example value: shield
  • Type: optional
  • Default value of user provider. See User for more information about the usage.

Telemetry​

Variables for metrics gathering.

STATSD_ADDRESS​

  • Example value: 127.0.0.1:8125
  • Type: optional
  • statsd client to send metrics to.

STATSD_PREFIX​

  • Example value: discovery
  • Type: optional
  • Default: compassApi
  • Prefix for statsd metrics names.

STATSD_ENABLED​

  • Example value: true
  • Type: required
  • Default: false
  • Enable publishing application metrics to statsd.

NEW_RELIC_APP_NAME​

  • Example value: compass-integration
  • Type: optional
  • Default: compass
  • New Relic application name.

NEW_RELIC_LICENSE_KEY​

  • Example value: mf9d13c838u252252c43ji47q1u4ynzpDDDDTSPQ
  • Type: optional
  • Default: ""
  • New Relic license key. Empty value would disable newrelic monitoring.
- +

Configurations

This page contains reference for all the application configurations for Compass.

Table of Contents​

Generic​

Compass's required variables to start using it.

LOG_LEVEL​

  • Example value: error
  • Type: optional
  • Default: info
  • Logging level, can be one of trace, debug, info, warning, error, fatal, panic.

SERVER_HOST​

  • Example value: localhost
  • Type: required
  • Network interface to bind to.

SERVER_PORT​

  • Example value: 8080
  • Type: required
  • Port to listen on.

ELASTICSEARCH_BROKERS​

  • Example value: http://localhost:9200,http://localhost:9300
  • Type: required
  • Comma separated list of elasticsearch nodes.

DB_HOST​

  • Example value: localhost
  • Type: required
  • PostgreSQL DB hostname to connect.

DB_PORT​

  • Example value: 5432
  • Type: required
  • PostgreSQL DB port to connect.

DB_NAME​

  • Example value: compass
  • Type: required
  • PostgreSQL DB name to connect.

DB_USER​

  • Example value: postgres
  • Type: required
  • PostgreSQL DB user to connect.

DB_PASSWORD​

  • Example value: ~
  • Type: required
  • PostgreSQL DB user's password to connect.

DB_SSL_MODE​

  • Example value: disable
  • Type: optional
  • PostgreSQL DB SSL mode to connect.

IDENTITY_UUID_HEADER​

  • Example value: Compass-User-UUID
  • Type: required
  • Header key to accept Compass User UUID. See User for more information about the usage.

IDENTITY_EMAIL_HEADER​

  • Example value: Compass-User-Email
  • Type: optional
  • Header key to accept Compass User Email. See User for more information about the usage.

IDENTITY_PROVIDER_DEFAULT_NAME​

  • Example value: shield
  • Type: optional
  • Default value of user provider. See User for more information about the usage.

Telemetry​

Variables for metrics gathering.

STATSD_ADDRESS​

  • Example value: 127.0.0.1:8125
  • Type: optional
  • statsd client to send metrics to.

STATSD_PREFIX​

  • Example value: discovery
  • Type: optional
  • Default: compassApi
  • Prefix for statsd metrics names.

STATSD_ENABLED​

  • Example value: true
  • Type: required
  • Default: false
  • Enable publishing application metrics to statsd.

NEW_RELIC_APP_NAME​

  • Example value: compass-integration
  • Type: optional
  • Default: compass
  • New Relic application name.

NEW_RELIC_LICENSE_KEY​

  • Example value: mf9d13c838u252252c43ji47q1u4ynzpDDDDTSPQ
  • Type: optional
  • Default: ""
  • New Relic license key. Empty value would disable newrelic monitoring.
+ \ No newline at end of file diff --git a/roadmap/index.html b/roadmap/index.html index 1b1affe8..3fe32bbe 100644 --- a/roadmap/index.html +++ b/roadmap/index.html @@ -8,13 +8,13 @@ Roadmap | Compass - +

Roadmap

In the following section you can learn about what features we're working on, what stage they're in, and when we expect to bring them to you. Have any questions or comments about items on the roadmap? Join the discussions on Compass Github forum.

If you would like to suggest new items or request timeline changes to the existing items, please submit a GitHub feature request.

We’re planning to iterate on the format of the roadmap itself, and we see potential to engage more in discussions about the future of Compass features. If you have feedback about this roadmap section itself, such as how the issues are presented, let us know through discussions.

Compass 0.2.x​

  • User Activity and Notification
- + \ No newline at end of file diff --git a/tour/asset-lineage/index.html b/tour/asset-lineage/index.html index fe4bdb32..eebe290b 100644 --- a/tour/asset-lineage/index.html +++ b/tour/asset-lineage/index.html @@ -8,7 +8,7 @@ 3. Asset Lineage | Compass - + @@ -19,7 +19,7 @@ From the example above main-postgres:my-database.orders is the source of the dashboard, so we put it inside upstreams field.

And just like that we created a lineage :)

Querying Lineage​

Once lineage is defined, we can easily fetch them using a single asset URN to be the center of the lineage like below

$ compass lineage tableau:my-dashboard.daily-orders

And you will get this as the response

{
    "data": [
        {
            "source": "main-postgres:my-database.orders",
            "target": "tableau:my-dashboard.daily-orders",
            "prop": {
                "root": "tableau:my-dashboard.daily-orders"
            }
        }
    ]
}

You can also get the lineage using the URN main-postgres:my-database.orders, even when you have only defined upstreams on tableau:my-dashboard.daily-orders.

$ compass lineage main-postgres:my-database.orders

Conclusion​

This is merely a simple example of how Compass can help you manage and build your Data Lineage. You just need to dump all of your assets along with its upstreams and downstreams as shown above and Compass will take care of the rest.

And that's it, we have just covered all the basics of Compass and how you can use it to manage and maintain your metadata. Aside from features introduced in this tour, Compass also has additional features such as Asset starring and discussion, you can check those in the Guides section.

- + \ No newline at end of file diff --git a/tour/introduction/index.html b/tour/introduction/index.html index f346eac4..7550a514 100644 --- a/tour/introduction/index.html +++ b/tour/introduction/index.html @@ -8,14 +8,14 @@ Introduction | Compass - +

Introduction

This tour introduces you to Compass. Along the way you will learn how to ingest assets in Compass database, list, search and manage asset lineage.

Prerequisites​

This tour requires you to have a Compass CLI tool installed on your local machine. You can run compass to verify the installation. Please follow installation and configuration guides if you do not have it installed already.

Compass CLI and clients talks to Compass server to publish and fetch assets, search and lineage. Please make sure you also have a Compass server running. You can also run server locally with compass server start command. For more details check deployment guide.

Help​

At any time you can run the following commands.

# See the help for a command
$ compass --help

The list of all available commands are as follows:

Core commands
  asset          Manage assets
  discussion     Manage discussions
  lineage        observe the lineage of metadata
  search         query the metadata available

Other commands
  completion     Generate shell completion scripts
  config         Manage server and client configurations
  help           Help about any command
  server         Manage server
  version        Print version information

Help topics
  environment    List of supported environment variables
  reference      Comprehensive reference of all commands

Help command can also be run on any sub command with syntax compass <command> <subcommand> --help Here is an example for the same.

$ compass asset --help

Background for this tutorial​

Let's imagine we have a postgres instance running with a database called my-database that has plenty of tables. One of the tables is named orders. We will ingest this asset, list and search the metadata from Compass. If you don't know what an asset is, don't worry we have got you covered in the next page. We will also be defining certain rules to inserting and quering lineage between tables dailyorders and orders in this example guide.

- + \ No newline at end of file diff --git a/tour/my-first-asset/index.html b/tour/my-first-asset/index.html index a8e9c234..30ac66c0 100644 --- a/tour/my-first-asset/index.html +++ b/tour/my-first-asset/index.html @@ -8,13 +8,13 @@ 1. My First Asset | Compass - +

1. My First Asset

Pre-Requisites​

  1. Setting up server
  2. Setting up the CLI (if you want to use the CLI client)

1.1 Introduction​

In Compass, we call every metadata that you input as an Asset. All your tables, dashboards, topics, jobs are an example of assets.

In this section, we will help you to build your first Asset and hopefully it will give your clear idea about what an Asset is in Compass.

1.2 Hello, World Asset!​

Let's imagine we have a postgres instance that we keep referring to as our main-postgres. Inside it there is a database called my-database that has plenty of tables. One of the tables is named orders, and below is how you represent that table as a Compass' Asset.

{
  "urn": "main-postgres:my-database.orders",
  "type": "table",
  "service": "postgres",
  "name": "orders",
  "data": {
    "database": "my-database",
    "namespace": "main-postgres"
  }
}

  • urn is a unique name you assign to an asset. You need to make sure you don't have a duplicate urns across all of your assets because Compass treats urn as an identifier of your asset. For this example, we use the following format to make sure our urn is unique, {NAMESPACE}:{DB_NAME}.{TABLE_NAME}.

  • type is your Asset's type. The value for type has to be recognizable by Compass. More info about Asset's Type can be found here.

  • service can be seen as the source of your asset. service can be anything, in this case since our orders table resides in postgres, we can just put postgres as the service.

  • name is the name of your asset, it does not have to be unique. We don't need to worry to get mixed up if there are other tables with the same name, urn will be the main identifier for your asset, that is why we need to make it unique across all of your assets.

  • data can hold your asset's extra details if there is any. In the example, we use it to store information of the database name and the alias/namespace that we use when referring the postgres instance.

1.3 Sending your first asset to Compass​

Assets can be created ingested in Compass using the following ways:

  1. Using compass asset edit CLI command
  2. Calling to PATCH /v1beta1/assets API

Let's send this into Compass so that it would be discoverable.

$ compass asset edit --body=<path to the asset.json file>
{
    "asset": {
        "urn": "main-postgres:my-database.orders",
        "type": "table",
        "service": "postgres",
        "name": "orders",
        "data": {
            "database": "my-database",
            "namespace": "main-postgres"
        }
    }
}

There are a few things to notice here:

  1. The HTTP method used is PATCH. This is because Compass does not have a dedicated Create API, it uses a single API to Patch / Create an asset instead. So when updating or patching your asset, you can use the same API. Similarly we use compass asset edit for upserting via the Compass CLI tool

  2. Compass requires Compass-User-UUID header to be in the request. More information about the identity header can be found here. To simplify this tour, let's just use john.doe@example.com. For CLI, these configurations are to be done in the config file discussed here

  3. When sending our asset to Compass, we need to put our asset object inside an asset field as shown in the example above

  4. For using the CLI tool, create a .json file using the example configurations shown above and provide the path to it here.

On a success insertion, your will receive below response:

{ "id": "cebeb793-8933-434c-b38f-beb6dbad91a5" }

id is an identifier of your asset. Unlike urn which is provided by you, id is auto generated by Compass if there was no asset found with the given URN.

Conclusion​

Now that you have successfully ingested your asset to Compass, we can now search and find it via Compass.

In the next section, we will see how Compass can help you in searching and discovering your assets.

- + \ No newline at end of file diff --git a/tour/querying-assets/index.html b/tour/querying-assets/index.html index 3bc59bad..a5d6d8ec 100644 --- a/tour/querying-assets/index.html +++ b/tour/querying-assets/index.html @@ -8,13 +8,13 @@ 2. Querying your Assets | Compass - +

2. Querying your Assets

In this section, we will learn how we can find and search our assets using the following approaches:

2.1 Using Asset URN or ID​

Using the Asset URN or ID returned from when you are uploading your asset, you can easily find your asset like below

$ compass asset view main-postgres:my-database.orders

Response from the above query

{
  "data": {
    "id": "cebeb793-8933-434c-b38f-beb6dbad91a5",
    "urn": "main-postgres:my-database.orders",
    "type": "table",
    "service": "postgres",
    "name": "orders",
    "description": "",
    "data": {
      "database": "my-database",
      "namespace": "main-postgres"
    },
    "labels": null,
    "owners": [],
    "version": "0.2",
    "updated_by": {
      "uuid": "john.doe@example.com"
    },
    "changelog": [],
    "created_at": "2021-03-22T22:45:11.160593Z",
    "updated_at": "2021-03-22T22:45:11.160593Z"
  }
}

2.2 Adding more assets​

Before we try other APIs let's first add 5 additional assets to Compass.

curl --location --request PATCH 'http://localhost:8080/v1beta1/assets' \
--header 'Content-Type: application/json' \
--header 'Compass-User-UUID: john.doe@example.com' \
--data-raw '{
    "asset": {
        "urn": "main-postgres:my-database.products",
        "type": "table",
        "service": "postgres",
        "name": "products",
        "data": {
            "database": "my-database",
            "namespace": "main-postgres"
        }
    }
}
'

2.3 Using Search API​

Search API is the preferred way when browsing through your assets in Compass. Let's see how powerful Compass is for discovering your assets.

Now that we have added more assets to Compass here, let's try to search for our newly added products table. To use Search API, we just need to provide a query/text/term.

Let's search for our products table using a typo query "podcts".

$ compass search "podcts"

Search results:

{
    "data": [
        {
            "id": "7c0759f4-feec-4b5e-bf26-bf0d0b1236b1",
            "urn": "main-postgres:my-database.products",
            "type": "table",
            "service": "postgres",
            "name": "products",
            "description": ""
        }
    ]
}

Compass Search API supports fuzzy search, so even when you give "podcts", it will still be able to fetch your products table.

Conclusion​

Search API is a really powerful discovery tool that you can leverage when storing your assets. It has lots of feature like fuzzy search which we just saw, you can also easily filter through asset's type, service and much more.

Up to this point, you have learnt how to create assets, inserting assets and querying them. Using these features, you can start leveraging Compass to be your Metadata Discovery Service.

Next we will see how you can use Compass to build a Lineage between your assets.

- + \ No newline at end of file