Uh oh!
There was an error while loading. Please reload this page.
docs: add runtime services API reference chapter for services.{data,sharing,audit,queue,email,settings,storage} - #1347
Merged
Conversation
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Closed
3 tasks
Agent-Logs-Url: https://github.com/objectstack-ai/framework/sessions/5dbbfda7-7e8d-436a-8df1-fb54194a5a10 Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
CopilotAI
changed the title
[WIP] Add documentation for services API methodsdocs: add runtime services API reference chapter for May 25, 2026
services.{data,sharing,audit,queue,email,settings,storage}hotlong
marked this pull request as ready for review
May 25, 2026 10:05
hotlong
approved these changes
May 25, 2026
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
services.*runtime APIs were discoverable only by reading source, which created a DX gap for template/plugin authors. This PR adds a dedicated docs chapter covering signatures, params, returns, errors, examples, and API stability labeling for the requested service surfaces.New chapter: Runtime Services API reference
content/docs/guides/runtime-services/with per-service pages:services.dataservices.sharingservices.auditservices.queueservices.emailservices.settingsservices.storageExamples added (M2 scope)
Versioning/stability (M3 scope)
stable/experimentalsemantics.Docs IA + gap tracking updates
content/docs/guides/meta.json+ chaptermeta.json).docs/PLATFORM_GAPS_FROM_TEMPLATES.mditem chore(ci)(deps): bump codelytv/pr-size-labeler from 1.10.1 to 1.10.3 #23 as resolved with traceable reference to the new chapter.CHANGELOG.mdwith the runtime services docs addition.Example
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
fastdl.mongodb.org/home/REDACTED/work/_temp/ghcca-node/node/bin/node node ./postinstall.js(dns block)/opt/hostedtoolcache/node/24.15.0/x64/bin/node /opt/hostedtoolcache/node/24.15.0/x64/bin/node --experimental-import-meta-resolve --require /home/REDACTED/work/framework/framework/node_modules/.pnpm/vitest@4.1.7_@opentelemetry+api@1.9.1_@types+node@25.9.1_@vitest+coverage-v8@4.1.7_happ_72174171d7a0abbbb70f6d3c93d7d962/node_modules/vitest/suppress-warnings.cjs --conditions node --conditions development /home/REDACTED/work/framework/framework/node_modules/.pnpm/vitest@4.1.7_@opentelemetry+api@1.9.1_@types+node@25.9.1_@vitest+coverage-v8@4.1.7_happ_72174171d7a0abbbb70f6d3c93d7d962/node_modules/vitest/dist/workers/forks.js --global(dns block)If you need me to access, download, or install something from one of these locations, you can either: