Skip to content

chore: update swagger #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miparnisari merged 1 commit into from
Apr 30, 2026
+21 −2
Merged

chore: update swagger #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 21 additions & 2 deletions docs/apidocs.swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1032,6 +1032,14 @@
"changeAt": {
"$ref": "#/definitions/ZedToken",
"description": "change_at is the revision at which a breaking schema event has happened."
},
"affectedPermissions": {
"type": "array",
"items": {
"type": "object",
"$ref": "#/definitions/WatchedPermission"
},
"description": "affected_permissions lists all the watched permissions that were directly affected by the breaking schema change."
}
},
"description": "BreakingSchemaChange is used to signal a breaking schema change has happened, and that the consumer should\nexpect delays in the ingestion of new changes, because the permission set snapshot needs to be rebuilt from scratch.\nOnce the snapshot is ready, the consumer will receive a LookupPermissionSetsRequired event."
Expand Down Expand Up @@ -1404,7 +1412,8 @@
"PERMISSIONSHIP_HAS_PERMISSION",
"PERMISSIONSHIP_CONDITIONAL_PERMISSION"
],
"default": "PERMISSIONSHIP_UNSPECIFIED"
"default": "PERMISSIONSHIP_UNSPECIFIED",
"description": " - PERMISSIONSHIP_UNSPECIFIED: PERMISSIONSHIP_UNSPECIFIED is the default value and should not be used or\nrelied upon. Servers should not return this value.\n - PERMISSIONSHIP_NO_PERMISSION: PERMISSIONSHIP_NO_PERMISSION indicates that the subject does not have the\nrequested permission on the resource.\n - PERMISSIONSHIP_HAS_PERMISSION: PERMISSIONSHIP_HAS_PERMISSION indicates that the subject has the requested\npermission on the resource.\n - PERMISSIONSHIP_CONDITIONAL_PERMISSION: PERMISSIONSHIP_CONDITIONAL_PERMISSION indicates that the subject has the\nrequested permission on the resource, but only if a caveat condition is met.\nThe `partial_caveat_info` field in the response should contain the missing\ncontext fields that must be provided to fully evaluate the caveat."
},
"ComputablePermissionsRequest": {
"type": "object",
Expand Down Expand Up @@ -1628,6 +1637,11 @@
"$ref": "#/definitions/File"
},
"title": "files contains the list of downloadable files with their URLs"
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "timestamp represents the time associated with the returned data revision."
}
}
},
Expand Down Expand Up @@ -2213,6 +2227,7 @@
"LOOKUP_PERMISSIONSHIP_CONDITIONAL_PERMISSION"
],
"default": "LOOKUP_PERMISSIONSHIP_UNSPECIFIED",
"description": "- LOOKUP_PERMISSIONSHIP_UNSPECIFIED: LOOKUP_PERMISSIONSHIP_UNSPECIFIED is the default value and should not be used or\nrelied upon. Servers should not return this value.\n - LOOKUP_PERMISSIONSHIP_HAS_PERMISSION: LOOKUP_PERMISSIONSHIP_HAS_PERMISSION indicates that the subject has permission\non the resource with no missing caveat context.\n - LOOKUP_PERMISSIONSHIP_CONDITIONAL_PERMISSION: LOOKUP_PERMISSIONSHIP_CONDITIONAL_PERMISSION indicates that the subject has\npermission on the resource, but only if a caveat condition is met. The\n`partial_caveat_info` field in the response should contain the missing context\nfields that must be provided to fully evaluate the caveat.",
"title": "LookupPermissionship represents whether a Lookup response was partially evaluated or not"
},
"LookupResourcesRequest": {
Expand Down Expand Up @@ -2245,6 +2260,10 @@
"optionalCursor": {
"$ref": "#/definitions/v1.Cursor",
"description": "optional_cursor, if specified, indicates the cursor after which results should resume being returned.\nThe cursor can be found on the LookupResourcesResponse object."
},
"withDebug": {
"type": "boolean",
"description": "with_debug, if true, indicates that the response should return debug information\nif present and available. For now, ONLY enables debugging of maximum recursion depth\nerrors, with additional context being returned in error details, but this may be\nextended in the future."
}
},
"description": "LookupResourcesRequest performs a lookup of all resources of a particular\nkind on which the subject has the specified permission or the relation in\nwhich the subject exists, streaming back the IDs of those resources."
Expand Down Expand Up @@ -2308,7 +2327,7 @@
},
"optionalCursor": {
"$ref": "#/definitions/v1.Cursor",
"description": "optional_cursor is currently unimplemented for LookupSubjects\nand will be ignored as of SpiceDB version 1.40.1. This will\nbe implemented in a future version of SpiceDB."
"description": "optional_cursor is not currently supported for LookupSubjects and this\nfield will be ignored. Cursoring support will be added in a future version."
},
"wildcardOption": {
"$ref": "#/definitions/WildcardOption",
Expand Down
Loading