Skip to content

docs: update service-permissions api snapshot #13

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

Open
grounds-openapi-publisher wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: update service-permissions api snapshot #13

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
99 changes: 88 additions & 11 deletions public/specs/service-permissions/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@
"EffectiveGrantResponse" : {
"description" : "Effective allow or deny grant and its origin.",
"type" : "object",
"required" : [ "effect", "permissionPattern", "scopeKind", "scopeValue", "expiresAt", "source", "grantId", "roleKey", "mappingId", "inheritedPath", "editable" ],
"required" : [ "effect", "permissionPattern", "scopeKind", "scopeValue", "startsAt", "expiresAt", "source", "grantId", "roleKey", "mappingId", "inheritedPath", "editable" ],
"properties" : {
"effect" : {
"$ref" : "#/components/schemas/PermissionEffect"
Expand All @@ -89,6 +89,13 @@
"scopeValue" : {
"type" : [ "string", "null" ]
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand Down Expand Up @@ -305,6 +312,13 @@
"pattern" : "\\S",
"description" : "Absent for GLOBAL; a nonblank value is required for other scope kinds."
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand Down Expand Up @@ -457,6 +471,13 @@
"minLength" : 1,
"pattern" : "^[a-z0-9._-]+$"
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand All @@ -469,7 +490,7 @@
"KeycloakGroupMappingResponse" : {
"description" : "Mapping from a Keycloak group to a permission role.",
"type" : "object",
"required" : [ "id", "keycloakGroup", "roleKey", "expiresAt" ],
"required" : [ "id", "keycloakGroup", "roleKey", "startsAt", "expiresAt" ],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UUID"
Expand All @@ -480,6 +501,13 @@
"roleKey" : {
"type" : "string"
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand Down Expand Up @@ -921,7 +949,7 @@
"PlayerEffectiveRoleResponse" : {
"description" : "Effective player role and the assignments that contributed it.",
"type" : "object",
"required" : [ "id", "roleKey", "roleName", "source", "expiresAt", "editable", "directGrant", "inherited", "assignments" ],
"required" : [ "id", "roleKey", "roleName", "source", "startsAt", "expiresAt", "editable", "directGrant", "inherited", "assignments" ],
"properties" : {
"id" : {
"type" : "string"
Expand All @@ -935,6 +963,13 @@
"source" : {
"$ref" : "#/components/schemas/PermissionGrantOriginKind"
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand Down Expand Up @@ -966,7 +1001,7 @@
"PlayerGrantResponse" : {
"description" : "Direct permission grant assigned to a player.",
"type" : "object",
"required" : [ "id", "playerId", "effect", "permissionPattern", "scopeKind", "scopeValue", "expiresAt" ],
"required" : [ "id", "playerId", "effect", "permissionPattern", "scopeKind", "scopeValue", "startsAt", "expiresAt" ],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UUID"
Expand All @@ -986,6 +1021,13 @@
"scopeValue" : {
"type" : [ "string", "null" ]
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand Down Expand Up @@ -1041,6 +1083,13 @@
"minLength" : 1,
"pattern" : "^[a-z0-9._-]+$"
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand All @@ -1053,7 +1102,7 @@
"PlayerRoleGrantResponse" : {
"type" : "object",
"description" : "Direct role assignment for a player.",
"required" : [ "id", "playerId", "roleKey", "expiresAt" ],
"required" : [ "id", "playerId", "roleKey", "startsAt", "expiresAt" ],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UUID"
Expand All @@ -1064,6 +1113,13 @@
"roleKey" : {
"type" : "string"
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand Down Expand Up @@ -1133,7 +1189,7 @@
"RoleGrantResponse" : {
"description" : "Permission grant assigned to a role.",
"type" : "object",
"required" : [ "id", "roleKey", "effect", "permissionPattern", "scopeKind", "scopeValue", "expiresAt" ],
"required" : [ "id", "roleKey", "effect", "permissionPattern", "scopeKind", "scopeValue", "startsAt", "expiresAt" ],
"properties" : {
"id" : {
"$ref" : "#/components/schemas/UUID"
Expand All @@ -1153,6 +1209,13 @@
"scopeValue" : {
"type" : [ "string", "null" ]
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
},
"expiresAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
Expand Down Expand Up @@ -1547,6 +1610,13 @@
}, {
"type" : "null"
} ]
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
}
}
},
Expand Down Expand Up @@ -1624,6 +1694,13 @@
}, {
"type" : "null"
} ]
},
"startsAt" : {
"anyOf" : [ {
"$ref" : "#/components/schemas/Instant"
}, {
"type" : "null"
} ]
}
}
},
Expand Down Expand Up @@ -2629,7 +2706,7 @@
"in" : "query",
"schema" : {
"type" : [ "string", "null" ],
"enum" : [ "group", "role", "expiration" ]
"enum" : [ "group", "role", "activation", "expiration" ]
},
"required" : false,
"description" : "Field used to order results."
Expand Down Expand Up @@ -3363,7 +3440,7 @@
"in" : "query",
"schema" : {
"type" : [ "string", "null" ],
"enum" : [ "permission", "effect", "scope", "source", "expiration" ]
"enum" : [ "permission", "effect", "scope", "source", "activation", "expiration" ]
},
"required" : false,
"description" : "Field used to order results."
Expand Down Expand Up @@ -3669,7 +3746,7 @@
"in" : "query",
"schema" : {
"type" : [ "string", "null" ],
"enum" : [ "permission", "effect", "scope", "expiration" ]
"enum" : [ "permission", "effect", "scope", "activation", "expiration" ]
},
"required" : false,
"description" : "Field used to order results."
Expand Down Expand Up @@ -4332,7 +4409,7 @@
"in" : "query",
"schema" : {
"type" : [ "string", "null" ],
"enum" : [ "role", "source", "expiration" ]
"enum" : [ "role", "source", "activation", "expiration" ]
},
"required" : false,
"description" : "Field used to order results."
Expand Down Expand Up @@ -5257,7 +5334,7 @@
"in" : "query",
"schema" : {
"type" : [ "string", "null" ],
"enum" : [ "permission", "effect", "scope", "expiration" ]
"enum" : [ "permission", "effect", "scope", "activation", "expiration" ]
},
"required" : false,
"description" : "Field used to order results."
Expand Down