| --- |
| id: grant-privilege-to-role |
| title: "Grant privileges to a role" |
| description: "Grant privileges to a role" |
| sidebar_label: "Grant privileges to a role" |
| hide_title: true |
| hide_table_of_contents: true |
| api: eJztWltv47YS/isEz3locRRf0hY41ZvWUdK0Tmz4gkWRY3QZaWxzVxJVknIcGP7vB0PqatnOZfuYIEBMiRzOcL75ZjjOjmq2UtR9oCwIQCkSiERLEdGFQ0UKkmkuktuQunQlWaLHkm94BCuYiYmIgDpUwt8ZKP1JhM/U3VFcDonGjyxNIx4YAd2vSiT4TAVriBl+0s8pUJeKx68Q6FwOlxCiKmmxi0I1UomKaA4K19XeVVKYlOyZOjQEFUie4pbUpbM1kGo6SQBCogUxhlCHcg2xekmVhMVoZSCSkBuxLYXMjEqK0pInK+pQSLIYJQwmvjfz/xp4M284uqEOnU/ro/z1dPCbf+flb8tB/nLmfRr61KF3o6vb6z/L4dQf+oNZOcwnX98O/ak/ow79PLltjCe+d1UbFsJH49sBdeh4MrqaD6rxYHQ/nd9V4zvv3rvx/5pP/cm0Gt5MRvPxtJI2GVlNi7fe/WyKZ9b2DJ4bEUui616i+/pZnzlVbzgcfaYOvfLv/zwuvxTT2sQhX8zyL0RI8gUlfKH7vUM11xFuNq60Ofr4BgE0sbhHhWHL4jSyaDg+yd3RDYsyOATwQwGfQ1/WziA3db/Ymx+Ep0pFoux+l70e/mmaPwGdyUQZqw3aISRSREBKiJ8I000SdlaSbbjmiehs+v95OW6bwRCIsB4MPNGwAkkduhQyZto++umyFapTzXSG5BOWmCjMrJzeW6D1SDuvCdpXB+p5aJr99oeyDndvyvBIzFIUUC0iSyEreQ5Nsihij2iKlhmggCXLInTI3qEstM5n0fjYrrnmiAUFQSZRzsho8jIneiTiSqNu5dIcFeq1lLjMouje0qKZ1jrocsKrDhtnN078UDE8fSvmDMmWfFpyZxFKFeGVTObPvKH3h3+cN3CLc6q8IQFVh11b9JF4PhLP2xLPtBnkzZemDDt8MCm48yA73UiRpeXLelayxN2r+DXPSzjst2j+W5+6dNOnRxnooc4ANGCaRWLV79gU0u9onNwvyMMt4/T9eTHPjHuH/nwsG46ZZDFokIQrwpMNi3hILgi6SqUQ8CWHsPJRbdI/miebOv0+Hd0TkFJIkrLnSLCQSJO0ISQ8IazMfuSJ6zVZZlKvQZIQNOORIiIxwDICDngjBqXYqiRnx3q2RR4nE3XMEx4j1Pu9Xs+hMdvmwz4Om1b8NpuNK02NyBJvRsDlGepuirpNNMiERZZ+Q1jypBFD1tS9U9r3okSPrLOYJRcSWGgovFiJoNUs+HaEvg+Zucy0tfjyUZM7EUJEm8F1G0WwwpSdI8nfBpAWdPJvCUvq0n91AxGnIoFEq26xuHt6ZQXsn9vAvheaXIssaaM5hpBplictJBtT/YUCb0FCE9hiWuIWRPVVmkXsG3zg/gP3Z3F/kFXuxTQL1nc5ehqwP8gv/V7vp5L4Ty2r2UqvGY/srd02I6AE6Q/qR/KgQekFKfsU5GE48q4WDpHAFA5PbLGg5VE8UCFXHZayYA01aEMxVXVOyHBJ8YigFgfBRR3a6XToAg+wEoBBadPkOw7p2OL6URVziqhvKfQOi4/sae0+u9GB5ViQvNHe5pK6lZM2kb3dtIZ4lxyXmVth+feX7bbNvx5RIDcgLxQPscoTjxHERK+ZJjFfrbUR9wiEhaFEAzAYl1LEJrCDiEOiCS7tkLmC0NwQrUDyy3ZrI18ZHhSZJrGQJVcHJBRBFkOiLew5/oZ8w8OMRUSKTIPqfLD4B4u/ksUbsXhZxuIkSzSPTwRiafLUQtbPvVmG4le2YZ2IJavOoRyXHF+8yIOteRKmkVbv42qBCLNtlLSo7RuXhlohw1FEyvT6xUZPbVGFSNucacVF1YFpXJTetJ+s+udv3StuUPPMRsr5netdjbhJ4G9QoroGlz0U51zvZTAazu/ujzdhRlf+EHsDeG9fnLbuuuo2nbew1Ud6v5n7/QKhrtcCv/hIM9PnxH1d2i1gorq74uO+m4KMuVKYYrroV9Xd4Z+9ndN0VethYeG+W3wzYbOAhXQmI+rSnVEV9m63u1sLpffuLhVS77u7R6ZgzPR63zqUG0hA8oDgjCKxzCdDx5IyiyKSMqnNNz5LvrKXeMwaGyY5flZlSoB27jP3DfOuOO755NYhwA3Tr7VO8dqBf00mKtubFB8h9aAVx8XimyJnlm3T6pZiLWnIjETAIiMQ+3NCnhCMb0iGqfZpDUmxBU9WZgezvi71v71feyiwOOG20FFqu7QklbDkW2QmTPdpCkloq1Y8ZZuPG6JZypGWF3n7hOtn4+uRl+n15Weu179/nmGUoa08AC8LOSQB0AWGySemeIAzqfuwqMuYGn8Ytx1IqhI6w+ctqNjpFhi4wKHLSDzZVGvqlIGEEBLNWWQTjPgGydwg07jY7XZhayn9wmxxYb3UCUTcNZMR1YFIc1AdmGXdw/KhDWLjopuiSkG3KWLUJMx+sYHboEoB00J2qE0dtbMpbTaIc0okoz95gI79A+QjSKFemJ/ASmjOtG2zYa00qb7z9KsMeryB1erCHm1hIbkthVEiT9SV6RN/OiPe+JY6NOIB5J27XLxnil1y2elRJ+eKwiNPT09FLSzkqpuvVd3h7cC/n/oXl51eZ61jUwgg3ViVep1fO/0WQK6wpAFVD0VbTJYBuuRSaZLLKTihbUTnf4kNUqVjltQMOZvmG8qUjtKw1d00YtyINMbvcp5+KGsADDy3lttrVE1tt9PMyDdyj6ZW92RKsoy9KOjsge4MIc9ltN/j478zkBjbi4pWDThCbq4DIXWXLFLQsrCs3OkPkzxp/UjOVCxHT6QoD5Nnw+rm0kWpQ7/Bc71IQk75R/TJz/AduuRfsn2HHufrm3cezwEQvkvBV5Qn361lCUzDKGtgIUgDNzt5YHW7yFFdCGv9nwbaaVd4AZbsJ+Yev0Y2SqfxHHPJY/6/IbG5YlDJnjDy2JM1RNirOU4wz3YULw2ZvWVYkfjzfxvAztk= |
| sidebar_class_name: "put api-method" |
| info_path: docs/api/rest/gravitino-rest-api |
| custom_edit_url: null |
| --- |
| |
| import ApiTabs from "@theme/ApiTabs"; |
| import DiscriminatorTabs from "@theme/DiscriminatorTabs"; |
| import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; |
| import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes"; |
| import MimeTabs from "@theme/MimeTabs"; |
| import ParamsItem from "@theme/ParamsItem"; |
| import ResponseSamples from "@theme/ResponseSamples"; |
| import SchemaItem from "@theme/SchemaItem"; |
| import SchemaTabs from "@theme/SchemaTabs"; |
| import Heading from "@theme/Heading"; |
| import OperationTabs from "@theme/OperationTabs"; |
| import TabItem from "@theme/TabItem"; |
| |
| <Heading |
| as={"h1"} |
| className={"openapi__heading"} |
| children={"Grant privileges to a role"} |
| > |
| </Heading> |
| |
| <MethodEndpoint |
| method={"put"} |
| path={"/metalakes/{metalake}/permissions/roles/{role}/{metadataObjectType}/{metadataObjectFullName}/grant"} |
| > |
| |
| </MethodEndpoint> |
| |
| |
| |
| Grant privileges to a role |
| |
| <Heading |
| id={"request"} |
| as={"h2"} |
| className={"openapi-tabs__heading"} |
| children={"Request"} |
| > |
| </Heading> |
| |
| <details |
| style={{"marginBottom":"1rem"}} |
| className={"openapi-markdown__details"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| > |
| <h3 |
| className={"openapi-markdown__details-summary-header-params"} |
| > |
| Path Parameters |
| </h3> |
| </summary><div> |
| <ul> |
| <ParamsItem |
| className={"paramsItem"} |
| param={{"name":"metalake","in":"path","description":"The name of the metalake","required":true,"schema":{"type":"string"}}} |
| > |
| |
| </ParamsItem><ParamsItem |
| className={"paramsItem"} |
| param={{"name":"role","in":"path","description":"The name of the role","required":true,"schema":{"type":"string"}}} |
| > |
| |
| </ParamsItem><ParamsItem |
| className={"paramsItem"} |
| param={{"name":"metadataObjectType","in":"path","description":"The type of the metadata object","required":true,"schema":{"type":"string","enum":["METALAKE","CATALOG","SCHEMA","TABLE","COLUMN","FILESET","TOPIC","MODEL","ROLE"]}}} |
| > |
| |
| </ParamsItem><ParamsItem |
| className={"paramsItem"} |
| param={{"name":"metadataObjectFullName","in":"path","description":"The full name of the metadata object","required":true,"schema":{"type":"string"}}} |
| > |
| |
| </ParamsItem> |
| </ul> |
| </div> |
| </details><MimeTabs |
| className={"openapi-tabs__mime"} |
| > |
| <TabItem |
| label={"application/json"} |
| value={"application/json-schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details mime"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-mime"} |
| > |
| <h3 |
| className={"openapi-markdown__details-summary-header-body"} |
| > |
| Body |
| </h3> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| privileges |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object[] |
| </span><span |
| className={"openapi-schema__divider"} |
| > |
| |
| </span><span |
| className={"openapi-schema__required"} |
| > |
| required |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| The privileges need to grant |
| |
| |
| </div><li> |
| <div |
| style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}} |
| > |
| Array [ |
| </div> |
| </li><SchemaItem |
| collapsible={false} |
| name={"name"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={"**Possible values:** [`CREATE_CATALOG`, `USE_CATALOG`, `CREATE_SCHEMA`, `USE_SCHEMA`, `CREATE_TABLE`, `MODIFY_TABLE`, `SELECT_TABLE`, `CREATE_FILESET`, `WRITE_FILESET`, `READ_FILESET`, `CREATE_TOPIC`, `PRODUCE_TOPIC`, `CONSUME_TOPIC`, `MANAGE_USERS`, `MANAGE_GROUPS`, `CREATE_ROLE`, `MANAGE_GRANTS`]"} |
| schema={{"type":"string","enum":["CREATE_CATALOG","USE_CATALOG","CREATE_SCHEMA","USE_SCHEMA","CREATE_TABLE","MODIFY_TABLE","SELECT_TABLE","CREATE_FILESET","WRITE_FILESET","READ_FILESET","CREATE_TOPIC","PRODUCE_TOPIC","CONSUME_TOPIC","MANAGE_USERS","MANAGE_GROUPS","CREATE_ROLE","MANAGE_GRANTS"],"description":"The name of the privilege"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"condition"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={"**Possible values:** [`ALLOW`, `DENY`]"} |
| schema={{"type":"string","enum":["ALLOW","DENY"],"description":"The condition of the privilege, `ALLOW` or `DENY`"}} |
| > |
| |
| </SchemaItem><li> |
| <div |
| style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}} |
| > |
| ] |
| </div> |
| </li> |
| </div> |
| </details> |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem> |
| </MimeTabs><div> |
| <div> |
| <ApiTabs |
| label={undefined} |
| id={undefined} |
| > |
| <TabItem |
| label={"200"} |
| value={"200"} |
| > |
| <div> |
| |
| |
| Returns the granted role object |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={false} |
| schemaName={"int32"} |
| qualifierMessage={"**Possible values:** [`0`]"} |
| schema={{"type":"integer","format":"int32","description":"Status code of the response","enum":[0]}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| role |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"name"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"The name of the role"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| properties |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object |
| </span><span |
| className={"openapi-schema__divider"} |
| > |
| |
| </span><span |
| className={"openapi-schema__nullable"} |
| > |
| nullable |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| A map of properties for the role |
| |
| |
| </div><SchemaItem |
| name={"property name*"} |
| required={false} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string"}} |
| collapsible={false} |
| discriminator={false} |
| > |
| |
| </SchemaItem> |
| </div> |
| </details> |
| </SchemaItem><SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| securableObjects |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object[] |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| A list of securable objects |
| |
| |
| </div><li> |
| <div |
| style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}} |
| > |
| Array [ |
| </div> |
| </li><SchemaItem |
| collapsible={false} |
| name={"fullName"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"The full name of the securable object"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"type"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={"**Possible values:** [`CATALOG`, `SCHEMA`, `TABLE`, `FILESET`, `TOPIC`, `METALAKE`]"} |
| schema={{"type":"string","enum":["CATALOG","SCHEMA","TABLE","FILESET","TOPIC","METALAKE"],"description":"The type of the securable object"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={true} |
| className={"schemaItem"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details"} |
| > |
| <summary |
| style={{}} |
| > |
| <span |
| className={"openapi-schema__container"} |
| > |
| <strong |
| className={"openapi-schema__property"} |
| > |
| privileges |
| </strong><span |
| className={"openapi-schema__name"} |
| > |
| object[] |
| </span> |
| </span> |
| </summary><div |
| style={{"marginLeft":"1rem"}} |
| > |
| <div |
| style={{"marginTop":".5rem","marginBottom":".5rem"}} |
| > |
| |
| |
| A list of privileges |
| |
| |
| </div><li> |
| <div |
| style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}} |
| > |
| Array [ |
| </div> |
| </li><SchemaItem |
| collapsible={false} |
| name={"name"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={"**Possible values:** [`CREATE_CATALOG`, `USE_CATALOG`, `CREATE_SCHEMA`, `USE_SCHEMA`, `CREATE_TABLE`, `MODIFY_TABLE`, `SELECT_TABLE`, `CREATE_FILESET`, `WRITE_FILESET`, `READ_FILESET`, `CREATE_TOPIC`, `PRODUCE_TOPIC`, `CONSUME_TOPIC`, `MANAGE_USERS`, `MANAGE_GROUPS`, `CREATE_ROLE`, `MANAGE_GRANTS`]"} |
| schema={{"type":"string","enum":["CREATE_CATALOG","USE_CATALOG","CREATE_SCHEMA","USE_SCHEMA","CREATE_TABLE","MODIFY_TABLE","SELECT_TABLE","CREATE_FILESET","WRITE_FILESET","READ_FILESET","CREATE_TOPIC","PRODUCE_TOPIC","CONSUME_TOPIC","MANAGE_USERS","MANAGE_GROUPS","CREATE_ROLE","MANAGE_GRANTS"],"description":"The name of the privilege"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"condition"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={"**Possible values:** [`ALLOW`, `DENY`]"} |
| schema={{"type":"string","enum":["ALLOW","DENY"],"description":"The condition of the privilege, `ALLOW` or `DENY`"}} |
| > |
| |
| </SchemaItem><li> |
| <div |
| style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}} |
| > |
| ] |
| </div> |
| </li> |
| </div> |
| </details> |
| </SchemaItem><li> |
| <div |
| style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}} |
| > |
| ] |
| </div> |
| </li> |
| </div> |
| </details> |
| </SchemaItem> |
| </div> |
| </details> |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 0,\n \"role\": {\n \"name\": \"string\",\n \"properties\": {},\n \"securableObjects\": [\n {\n \"fullName\": \"string\",\n \"type\": \"CATALOG\",\n \"privileges\": [\n {\n \"name\": \"CREATE_CATALOG\",\n \"condition\": \"ALLOW\"\n }\n ]\n }\n ]\n }\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"GroupResponse"} |
| value={"GroupResponse"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 0,\n \"role\": {\n \"name\": \"role1\",\n \"properties\": {\n \"k1\": \"v1\"\n },\n \"securableObjects\": [\n {\n \"fullName\": \"catalog1.schema1.table1\",\n \"type\": \"TABLE\",\n \"privileges\": [\n {\n \"name\": \"SELECT_TABLE\",\n \"condition\": \"ALLOW\"\n }\n ]\n }\n ]\n }\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem><TabItem |
| label={"400"} |
| value={"400"} |
| > |
| <div> |
| |
| |
| Parameter is invalid - The specified privilege is invalid |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={true} |
| schemaName={"integer"} |
| qualifierMessage={"**Possible values:** `>= 1000` and `<= 1100`"} |
| schema={{"type":"integer","minimum":1000,"maximum":1100,"description":"HTTP response code","example":1002}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"type"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"Internal type definition of the error"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"message"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A human-readable message"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"stack"} |
| required={false} |
| schemaName={"string[]"} |
| qualifierMessage={undefined} |
| schema={{"type":"array","items":{"type":"string"}}} |
| > |
| |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"string\",\n \"message\": \"string\",\n \"stack\": [\n \"string\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem><TabItem |
| label={"404"} |
| value={"404"} |
| > |
| <div> |
| |
| |
| Not Found - The specified medata object or role does not exist in the specified metalake |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={true} |
| schemaName={"integer"} |
| qualifierMessage={"**Possible values:** `>= 1000` and `<= 1100`"} |
| schema={{"type":"integer","minimum":1000,"maximum":1100,"description":"HTTP response code","example":1002}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"type"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"Internal type definition of the error"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"message"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A human-readable message"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"stack"} |
| required={false} |
| schemaName={"string[]"} |
| qualifierMessage={undefined} |
| schema={{"type":"array","items":{"type":"string"}}} |
| > |
| |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"string\",\n \"message\": \"string\",\n \"stack\": [\n \"string\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"NoSuchMetalakeException"} |
| value={"NoSuchMetalakeException"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1003,\n \"type\": \"NoSuchMetalakeException\",\n \"message\": \"Failed to operate metalake(s) [test] operation [LOAD], reason [NoSuchMetalakeException]\",\n \"stack\": [\n \"org.apache.gravitino.exceptions.NoSuchMetalakeException: Metalake test does not exist\",\n \"...\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"NoSuchMetadataObjectException"} |
| value={"NoSuchMetadataObjectException"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1003,\n \"type\": \"NoSuchMetadataObjectException\",\n \"message\": \"Metadata object does not exist\",\n \"stack\": [\n \"org.apache.gravitino.exceptions.NoSuchMetadataObjectException: Metadata object does not exist\",\n \"...\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"NoSuchRoleException"} |
| value={"NoSuchRoleException"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1003,\n \"type\": \"NoSuchRoleException\",\n \"message\": \"Role does not exist\",\n \"stack\": [\n \"org.apache.gravitino.exceptions.NoSuchRoleException: Role does not exist\",\n \"...\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem><TabItem |
| label={"5xx"} |
| value={"5xx"} |
| > |
| <div> |
| |
| |
| A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. |
| |
| |
| </div><div> |
| <MimeTabs |
| className={"openapi-tabs__mime"} |
| schemaType={"response"} |
| > |
| <TabItem |
| label={"application/vnd.gravitino.v1+json"} |
| value={"application/vnd.gravitino.v1+json"} |
| > |
| <SchemaTabs |
| className={"openapi-tabs__schema"} |
| > |
| <TabItem |
| label={"Schema"} |
| value={"Schema"} |
| > |
| <details |
| style={{}} |
| className={"openapi-markdown__details response"} |
| data-collapsed={false} |
| open={true} |
| > |
| <summary |
| style={{}} |
| className={"openapi-markdown__details-summary-response"} |
| > |
| <strong> |
| Schema |
| </strong> |
| </summary><div |
| style={{"textAlign":"left","marginLeft":"1rem"}} |
| > |
| |
| </div><ul |
| style={{"marginLeft":"1rem"}} |
| > |
| <SchemaItem |
| collapsible={false} |
| name={"code"} |
| required={true} |
| schemaName={"integer"} |
| qualifierMessage={"**Possible values:** `>= 1000` and `<= 1100`"} |
| schema={{"type":"integer","minimum":1000,"maximum":1100,"description":"HTTP response code","example":1002}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"type"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"Internal type definition of the error"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"message"} |
| required={true} |
| schemaName={"string"} |
| qualifierMessage={undefined} |
| schema={{"type":"string","description":"A human-readable message"}} |
| > |
| |
| </SchemaItem><SchemaItem |
| collapsible={false} |
| name={"stack"} |
| required={false} |
| schemaName={"string[]"} |
| qualifierMessage={undefined} |
| schema={{"type":"array","items":{"type":"string"}}} |
| > |
| |
| </SchemaItem> |
| </ul> |
| </details> |
| </TabItem><TabItem |
| label={"Example (from schema)"} |
| value={"Example (from schema)"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"string\",\n \"message\": \"string\",\n \"stack\": [\n \"string\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem><TabItem |
| label={"Example"} |
| value={"Example"} |
| > |
| <ResponseSamples |
| responseExample={"{\n \"code\": 1002,\n \"type\": \"RuntimeException\",\n \"message\": \"Internal Server Error\",\n \"stack\": [\n \"java.lang.RuntimeException: Internal Server Error\"\n ]\n}"} |
| language={"json"} |
| > |
| |
| </ResponseSamples> |
| </TabItem> |
| </SchemaTabs> |
| </TabItem> |
| </MimeTabs> |
| </div> |
| </TabItem> |
| </ApiTabs> |
| </div> |
| </div> |
| |
