Skip to content

Commit 7d6ecc7

Browse files
inabhi9inabhi9
committed
chore: update protobuf and docs
1 parent 3657f71 commit 7d6ecc7

File tree

7 files changed

+2515
-423
lines changed

7 files changed

+2515
-423
lines changed

‎docs/api-reference/apidocs.swagger.json‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -651,6 +651,47 @@
651651
]
652652
}
653653
},
654+
"/v1/tenants/{tenant_id}/permissions/bulk-check": {
655+
"post": {
656+
"summary": "bulk check api",
657+
"description": "Check multiple permissions in a single request. Maximum 100 requests allowed.",
658+
"operationId": "permissions.bulk-check",
659+
"responses": {
660+
"200": {
661+
"description": "A successful response.",
662+
"schema": {
663+
"$ref": "#/definitions/PermissionBulkCheckResponse"
664+
}
665+
},
666+
"default": {
667+
"description": "An unexpected error response.",
668+
"schema": {
669+
"$ref": "#/definitions/Status"
670+
}
671+
}
672+
},
673+
"parameters": [
674+
{
675+
"name": "tenant_id",
676+
"description": "Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant \u003ccode\u003et1\u003c/code\u003e for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.",
677+
"in": "path",
678+
"required": true,
679+
"type": "string"
680+
},
681+
{
682+
"name": "body",
683+
"in": "body",
684+
"required": true,
685+
"schema": {
686+
"$ref": "#/definitions/BulkCheckBody"
687+
}
688+
}
689+
],
690+
"tags": [
691+
"Permission"
692+
]
693+
}
694+
},
654695
"/v1/tenants/{tenant_id}/permissions/check": {
655696
"post": {
656697
"summary": "check api",
@@ -1479,6 +1520,36 @@
14791520
"default": "ATTRIBUTE_TYPE_UNSPECIFIED",
14801521
"description": "Enumerates the types of attribute.\n\n - ATTRIBUTE_TYPE_UNSPECIFIED: Not specified attribute type. This is the default value.\n - ATTRIBUTE_TYPE_BOOLEAN: A boolean attribute type.\n - ATTRIBUTE_TYPE_BOOLEAN_ARRAY: A boolean array attribute type.\n - ATTRIBUTE_TYPE_STRING: A string attribute type.\n - ATTRIBUTE_TYPE_STRING_ARRAY: A string array attribute type.\n - ATTRIBUTE_TYPE_INTEGER: An integer attribute type.\n - ATTRIBUTE_TYPE_INTEGER_ARRAY: An integer array attribute type.\n - ATTRIBUTE_TYPE_DOUBLE: A double attribute type.\n - ATTRIBUTE_TYPE_DOUBLE_ARRAY: A double array attribute type."
14811522
},
1523+
"BulkCheckBody": {
1524+
"type": "object",
1525+
"properties": {
1526+
"metadata": {
1527+
"$ref": "#/definitions/PermissionCheckRequestMetadata",
1528+
"description": "Metadata associated with this request, required."
1529+
},
1530+
"items": {
1531+
"type": "array",
1532+
"items": {
1533+
"type": "object",
1534+
"$ref": "#/definitions/PermissionBulkCheckRequestItem"
1535+
},
1536+
"description": "List of permission check requests, maximum 100 items."
1537+
},
1538+
"context": {
1539+
"$ref": "#/definitions/Context",
1540+
"description": "Contextual data that can be dynamically added to permission check requests. See details on [Contextual Data](../../operations/contextual-tuples)"
1541+
},
1542+
"arguments": {
1543+
"type": "array",
1544+
"items": {
1545+
"type": "object",
1546+
"$ref": "#/definitions/Argument"
1547+
},
1548+
"description": "Additional arguments associated with this request."
1549+
}
1550+
},
1551+
"description": "PermissionBulkCheckRequest is the request message for the BulkCheck method in the Permission service."
1552+
},
14821553
"Bundle.DeleteBody": {
14831554
"type": "object",
14841555
"properties": {
@@ -2487,6 +2558,39 @@
24872558
},
24882559
"description": "PermissionExpandRequest is the request message for the Expand method in the Permission service."
24892560
},
2561+
"PermissionBulkCheckRequestItem": {
2562+
"type": "object",
2563+
"properties": {
2564+
"entity": {
2565+
"$ref": "#/definitions/Entity",
2566+
"example": "repository:1",
2567+
"description": "Entity on which the permission needs to be checked, required."
2568+
},
2569+
"permission": {
2570+
"type": "string",
2571+
"description": "The action the user wants to perform on the resource"
2572+
},
2573+
"subject": {
2574+
"$ref": "#/definitions/Subject",
2575+
"description": "Subject for which the permission needs to be checked, required."
2576+
}
2577+
},
2578+
"title": "BULK CHECK"
2579+
},
2580+
"PermissionBulkCheckResponse": {
2581+
"type": "object",
2582+
"properties": {
2583+
"results": {
2584+
"type": "array",
2585+
"items": {
2586+
"type": "object",
2587+
"$ref": "#/definitions/PermissionCheckResponse"
2588+
},
2589+
"description": "List of permission check responses corresponding to each request."
2590+
}
2591+
},
2592+
"description": "PermissionBulkCheckResponse is the response message for the BulkCheck method in the Permission service."
2593+
},
24902594
"PermissionCheckRequestMetadata": {
24912595
"type": "object",
24922596
"properties": {

‎docs/api-reference/openapiv2/apidocs.swagger.json‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -651,6 +651,47 @@
651651
]
652652
}
653653
},
654+
"/v1/tenants/{tenant_id}/permissions/bulk-check": {
655+
"post": {
656+
"summary": "bulk check api",
657+
"description": "Check multiple permissions in a single request. Maximum 100 requests allowed.",
658+
"operationId": "permissions.bulk-check",
659+
"responses": {
660+
"200": {
661+
"description": "A successful response.",
662+
"schema": {
663+
"$ref": "#/definitions/PermissionBulkCheckResponse"
664+
}
665+
},
666+
"default": {
667+
"description": "An unexpected error response.",
668+
"schema": {
669+
"$ref": "#/definitions/Status"
670+
}
671+
}
672+
},
673+
"parameters": [
674+
{
675+
"name": "tenant_id",
676+
"description": "Identifier of the tenant, if you are not using multi-tenancy (have only one tenant) use pre-inserted tenant \u003ccode\u003et1\u003c/code\u003e for this field. Required, and must match the pattern \\“[a-zA-Z0-9-,]+\\“, max 64 bytes.",
677+
"in": "path",
678+
"required": true,
679+
"type": "string"
680+
},
681+
{
682+
"name": "body",
683+
"in": "body",
684+
"required": true,
685+
"schema": {
686+
"$ref": "#/definitions/BulkCheckBody"
687+
}
688+
}
689+
],
690+
"tags": [
691+
"Permission"
692+
]
693+
}
694+
},
654695
"/v1/tenants/{tenant_id}/permissions/check": {
655696
"post": {
656697
"summary": "check api",
@@ -1477,6 +1518,36 @@
14771518
],
14781519
"description": "Enumerates the types of attribute.\n\n - ATTRIBUTE_TYPE_BOOLEAN: A boolean attribute type.\n - ATTRIBUTE_TYPE_BOOLEAN_ARRAY: A boolean array attribute type.\n - ATTRIBUTE_TYPE_STRING: A string attribute type.\n - ATTRIBUTE_TYPE_STRING_ARRAY: A string array attribute type.\n - ATTRIBUTE_TYPE_INTEGER: An integer attribute type.\n - ATTRIBUTE_TYPE_INTEGER_ARRAY: An integer array attribute type.\n - ATTRIBUTE_TYPE_DOUBLE: A double attribute type.\n - ATTRIBUTE_TYPE_DOUBLE_ARRAY: A double array attribute type."
14791520
},
1521+
"BulkCheckBody": {
1522+
"type": "object",
1523+
"properties": {
1524+
"metadata": {
1525+
"$ref": "#/definitions/PermissionCheckRequestMetadata",
1526+
"description": "Metadata associated with this request, required."
1527+
},
1528+
"items": {
1529+
"type": "array",
1530+
"items": {
1531+
"type": "object",
1532+
"$ref": "#/definitions/PermissionBulkCheckRequestItem"
1533+
},
1534+
"description": "List of permission check requests, maximum 100 items."
1535+
},
1536+
"context": {
1537+
"$ref": "#/definitions/Context",
1538+
"description": "Contextual data that can be dynamically added to permission check requests. See details on [Contextual Data](../../operations/contextual-tuples)"
1539+
},
1540+
"arguments": {
1541+
"type": "array",
1542+
"items": {
1543+
"type": "object",
1544+
"$ref": "#/definitions/Argument"
1545+
},
1546+
"description": "Additional arguments associated with this request."
1547+
}
1548+
},
1549+
"description": "PermissionBulkCheckRequest is the request message for the BulkCheck method in the Permission service."
1550+
},
14801551
"Bundle.DeleteBody": {
14811552
"type": "object",
14821553
"properties": {
@@ -2471,6 +2542,39 @@
24712542
},
24722543
"description": "PermissionExpandRequest is the request message for the Expand method in the Permission service."
24732544
},
2545+
"PermissionBulkCheckRequestItem": {
2546+
"type": "object",
2547+
"properties": {
2548+
"entity": {
2549+
"$ref": "#/definitions/Entity",
2550+
"example": "repository:1",
2551+
"description": "Entity on which the permission needs to be checked, required."
2552+
},
2553+
"permission": {
2554+
"type": "string",
2555+
"description": "The action the user wants to perform on the resource"
2556+
},
2557+
"subject": {
2558+
"$ref": "#/definitions/Subject",
2559+
"description": "Subject for which the permission needs to be checked, required."
2560+
}
2561+
},
2562+
"title": "BULK CHECK"
2563+
},
2564+
"PermissionBulkCheckResponse": {
2565+
"type": "object",
2566+
"properties": {
2567+
"results": {
2568+
"type": "array",
2569+
"items": {
2570+
"type": "object",
2571+
"$ref": "#/definitions/PermissionCheckResponse"
2572+
},
2573+
"description": "List of permission check responses corresponding to each request."
2574+
}
2575+
},
2576+
"description": "PermissionBulkCheckResponse is the response message for the BulkCheck method in the Permission service."
2577+
},
24742578
"PermissionCheckRequestMetadata": {
24752579
"type": "object",
24762580
"properties": {

0 commit comments

Comments
 (0)