Skip to content
Install

Graft API versions

Grafts reach Orchard through doors. Each door has a version, and a stable door never changes shape: a change ships as a new version next to the old one, which stays for at least one major release. graft pack records which doors a graft uses, and orchardctl graft add refuses a graft that needs a door this Orchard does not have. Inject a door with @Inject(Doors.<name>) from @orchardlabs/graft-sdk/server.

19 doors are available.

DoorVersionCapabilityStatusMembers
Doors.apply1kube.applystableenqueue(), hasOpenItem(), registerHandler(), retryForSubject(), serverSideApply()
Doors.audit1auditstablelog()
Doors.auth1nonestableauthenticateTerminalUpgrade(), authenticateUpgrade(), can(), deviceName(), getOrgAccess(), getProjectAccess(), isSuperAdmin(), isUnrestrictedSuperAdmin(), listVisibleProjectIds(), mintDeviceToken(), originAllowed(), registerOrgScopedDevice(), rejectUpgrade(), requestContext(), require(), requireOrgAdmin(), requireOrgCanCreateProjects(), requireOrgMember(), requireOrgOwner(), requireProjectEdit(), requireProjectView(), revokeDeviceSessions(), runWithContext(), validateSession()
Doors.context1nonestableapiBase, id, manifest, role, schema, version
Doors.db1dbstablerole, schema, pool(), query()
Doors.events1eventsstableemitOrg(), stream()
Doors.exec1kube.execstableregister()
Doors.flags1flagsstableconfigured, isEnabled()
Doors.github1githubstablegithub, installationToken(), onIssueComment(), repoToken(), userToken()
Doors.http1http.upgradestablehostRouter(), onListen(), upgrade()
Doors.kube1kube.readstablekc, kubernetes, databaseTlsHostname(), isLeader(), onLeaderAcquired(), registerEngineShard(), registerMirrorShard()
Doors.metrics1metricsstableconfigured, vm, escapeLabel(), queryInstant()
Doors.notifications1notificationsstablenotifyAccount(), registerEvent()
Doors.projects1projects.readstablecreateAutoIngressForDeployment(), createDeploymentFromGitHub(), createEnvironment(), deleteEnvironment(), deleteEnvironmentFromCluster(), deployments(), environments(), onEnvironmentEnvChanged(), rebuildDeployment(), requireWrite(), setDeploymentBranch()
Doors.rateLimit1rateLimitstablelimits, throttle, check(), consume(), define()
Doors.secrets1secretsstableenabled, decrypt(), decryptForUser(), encrypt(), encryptForUser(), isEncrypted(), maybeDecrypt(), open(), seal()
Doors.settings1settingsstablegeneration, all(), flag(), isConfigured(), store(), storeIfAbsent(), stored(), validate(), value()
Doors.storage1storagestableconfigured, publicBase, delete(), owns(), upload()
Doors.users1users.readstablefindByUsername(), get(), getMany(), resolve()