| (window.webpackJsonp=window.webpackJsonp||[]).push([[115],{182:function(e,t,n){"use strict";n.r(t),n.d(t,"frontMatter",(function(){return s})),n.d(t,"metadata",(function(){return c})),n.d(t,"toc",(function(){return p})),n.d(t,"default",(function(){return o}));var a=n(3),r=n(7),l=(n(0),n(193)),s={title:"Serve REST API"},c={unversionedId:"api/registered-model",id:"api/registered-model",isDocsHomePage:!1,title:"Serve REST API",description:"\x3c!--",source:"@site/docs/api/registered-model.md",slug:"/api/registered-model",permalink:"/docs/next/api/registered-model",editUrl:"https://github.com/apache/submarine/edit/master/website/docs/api/registered-model.md",version:"current"},p=[{value:"Create a registered model",id:"create-a-registered-model",children:[{value:"List registered models",id:"list-registered-models",children:[]},{value:"Get a registered model",id:"get-a-registered-model",children:[]},{value:"Patch a registered model",id:"patch-a-registered-model",children:[]}]},{value:"Delete a registered model",id:"delete-a-registered-model",children:[]},{value:"Create a registered model tag",id:"create-a-registered-model-tag",children:[]},{value:"Delete a registered model tag",id:"delete-a-registered-model-tag",children:[]}],i={toc:p};function o(e){var t=e.components,n=Object(r.a)(e,["components"]);return Object(l.b)("wrapper",Object(a.a)({},i,n,{components:t,mdxType:"MDXLayout"}),Object(l.b)("blockquote",null,Object(l.b)("p",{parentName:"blockquote"},"Note: The Registered Model API is in the alpha stage which is subjected to incompatible changes in future releases.")),Object(l.b)("h2",{id:"create-a-registered-model"},"Create a registered model"),Object(l.b)("p",null,Object(l.b)("inlineCode",{parentName:"p"},"POST /api/v1/registered-model")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Request")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-sh"},'curl -X POST -H "Content-Type: application/json" -d \'\n{\n "name": "example_name",\n "description": "example_description",\n "tags": ["123", "456"]\n }\n\' http://127.0.0.1:32080/api/v1/registered-model\n')),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Response:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-json"},'{\n "status":"OK",\n "code":200,\n "success":true,\n "message":"Create a registered model instance",\n "result":null,\n "attributes":{}\n}\n')),Object(l.b)("h3",{id:"list-registered-models"},"List registered models"),Object(l.b)("p",null,Object(l.b)("inlineCode",{parentName:"p"},"GET /api/v1/registered-model")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Request:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-sh"},"curl -X GET http://127.0.0.1:32080/api/v1/registered-model\n")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Response:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "List all registered model instances",\n "result" : [\n {\n "creationTime" : "2021-12-16 10:14:06",\n "description" : "example_description",\n "lastUpdatedTime" : "2021-12-16 10:14:06",\n "name" : "example_name",\n "tags" : [\n "123",\n "456"\n ]\n },\n {\n "creationTime" : "2021-12-16 10:16:25",\n "description" : "example_description",\n "lastUpdatedTime" : "2021-12-16 10:16:25",\n "name" : "example_name1",\n "tags" : [\n "123",\n "456"\n ]\n },\n {\n "creationTime" : "2021-12-12 02:27:05",\n "description" : null,\n "lastUpdatedTime" : "2021-12-14 12:49:33",\n "name" : "register",\n "tags" : []\n }\n ],\n "status" : "OK",\n "success" : true\n}\n')),Object(l.b)("h3",{id:"get-a-registered-model"},"Get a registered model"),Object(l.b)("p",null,Object(l.b)("inlineCode",{parentName:"p"},"GET /api/v1/registered-model/{name}")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Request:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-sh"},"curl -X GET http://127.0.0.1:32080/api/v1/registered-model/example_name\n")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Response:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Get the registered model instance",\n "result" : {\n "creationTime" : "2021-12-16 10:14:06",\n "description" : "example_description",\n "lastUpdatedTime" : "2021-12-16 10:14:06",\n "name" : "example_name",\n "tags" : [\n "123",\n "456"\n ]\n },\n "status" : "OK",\n "success" : true\n}\n')),Object(l.b)("h3",{id:"patch-a-registered-model"},"Patch a registered model"),Object(l.b)("p",null,Object(l.b)("inlineCode",{parentName:"p"},"PATCH /api/v1/registered-model/{name}")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Request:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-sh"},'curl -X PATCH -H "Content-Type: application/json" -d \'\n{\n "name": "new_name",\n "description": "new_description"\n}\' http://127.0.0.1:32080/api/v1/registered-model/example_name\n')),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Response:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Update the registered model instance",\n "result" : null,\n "status" : "OK",\n "success" : true\n}\n')),Object(l.b)("h2",{id:"delete-a-registered-model"},"Delete a registered model"),Object(l.b)("p",null,Object(l.b)("inlineCode",{parentName:"p"},"DELETE /api/v1/registered-model/{name}")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Request")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-sh"},"curl -X DELETE http://127.0.0.1:32080/api/v1/registered-model/example_name\n")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Response:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Delete the registered model instance",\n "result" : null,\n "status" : "OK",\n "success" : true\n}\n')),Object(l.b)("h2",{id:"create-a-registered-model-tag"},"Create a registered model tag"),Object(l.b)("p",null,Object(l.b)("inlineCode",{parentName:"p"},"POST /api/v1/registered-model/tag?name={name}&tag={tag}")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Request")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-sh"},"curl -X POST http://127.0.0.1:32080/api/v1/registered-model/tag?name=example_name&tag=789\n")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Response:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-json"},'{\n "status":"OK",\n "code":200,\n "success":true,\n "message":"Create a registered model tag instance",\n "result":null,\n "attributes":{}\n}\n')),Object(l.b)("h2",{id:"delete-a-registered-model-tag"},"Delete a registered model tag"),Object(l.b)("p",null,Object(l.b)("inlineCode",{parentName:"p"},"DELETE /api/v1/registered-model/tag?name={name}&tag={tag}")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Request")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-sh"},"curl -X DELETE http://127.0.0.1:32080/api/v1/registered-model/tag?name=example_name&tag=789\n")),Object(l.b)("p",null,Object(l.b)("strong",{parentName:"p"},"Example Response:")),Object(l.b)("pre",null,Object(l.b)("code",{parentName:"pre",className:"language-json"},'{\n "attributes" : {},\n "code" : 200,\n "message" : "Delete a registered model tag instance",\n "result" : null,\n "status" : "OK",\n "success" : true\n}\n')))}o.isMDXComponent=!0},193:function(e,t,n){"use strict";n.d(t,"a",(function(){return d})),n.d(t,"b",(function(){return u}));var a=n(0),r=n.n(a);function l(e,t,n){return t in e?Object.defineProperty(e,t,{value:n,enumerable:!0,configurable:!0,writable:!0}):e[t]=n,e}function s(e,t){var n=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter((function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable}))),n.push.apply(n,a)}return n}function c(e){for(var t=1;t<arguments.length;t++){var n=null!=arguments[t]?arguments[t]:{};t%2?s(Object(n),!0).forEach((function(t){l(e,t,n[t])})):Object.getOwnPropertyDescriptors?Object.defineProperties(e,Object.getOwnPropertyDescriptors(n)):s(Object(n)).forEach((function(t){Object.defineProperty(e,t,Object.getOwnPropertyDescriptor(n,t))}))}return e}function p(e,t){if(null==e)return{};var n,a,r=function(e,t){if(null==e)return{};var n,a,r={},l=Object.keys(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||(r[n]=e[n]);return r}(e,t);if(Object.getOwnPropertySymbols){var l=Object.getOwnPropertySymbols(e);for(a=0;a<l.length;a++)n=l[a],t.indexOf(n)>=0||Object.prototype.propertyIsEnumerable.call(e,n)&&(r[n]=e[n])}return r}var i=r.a.createContext({}),o=function(e){var t=r.a.useContext(i),n=t;return e&&(n="function"==typeof e?e(t):c(c({},t),e)),n},d=function(e){var t=o(e.components);return r.a.createElement(i.Provider,{value:t},e.children)},m={inlineCode:"code",wrapper:function(e){var t=e.children;return r.a.createElement(r.a.Fragment,{},t)}},b=r.a.forwardRef((function(e,t){var n=e.components,a=e.mdxType,l=e.originalType,s=e.parentName,i=p(e,["components","mdxType","originalType","parentName"]),d=o(n),b=a,u=d["".concat(s,".").concat(b)]||d[b]||m[b]||l;return n?r.a.createElement(u,c(c({ref:t},i),{},{components:n})):r.a.createElement(u,c({ref:t},i))}));function u(e,t){var n=arguments,a=t&&t.mdxType;if("string"==typeof e||a){var l=n.length,s=new Array(l);s[0]=b;var c={};for(var p in t)hasOwnProperty.call(t,p)&&(c[p]=t[p]);c.originalType=e,c.mdxType="string"==typeof e?e:a,s[1]=c;for(var i=2;i<l;i++)s[i]=n[i];return r.a.createElement.apply(null,s)}return r.a.createElement.apply(null,n)}b.displayName="MDXCreateElement"}}]); |