Skip to content

docs: sync automation API docs#138

Merged
ysyneu merged 7 commits into
mainfrom
doc-review/20260703-031622
Jul 3, 2026
Merged

docs: sync automation API docs#138
ysyneu merged 7 commits into
mainfrom
doc-review/20260703-031622

Conversation

@ysyneu

@ysyneu ysyneu commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

Doc Review — 2026-07-03

Mode: diff (2026-07-02T03:16:10.538Z -> 2026-07-03T03:16:22Z)
Findings: 2 total — 1 high, 1 medium, 0 low

Changes

Finding Type Module Doc Action
f001 missing_coverage ai-sre api-reference/safari.openapi.{zh,en}.json Added POST /safari/automation/rule/run operation, schemas, examples, and docs navigation
f002 config_drift ai-sre zh/en/ai-sre/automations.mdx + OpenAPI Documented On-call incident trigger API fields and updated trigger_kind enums to include manual and oncall_incident

Validation

  • JSON parse passed for Safari and consolidated OpenAPI files
  • zh/en OpenAPI path, operationId, schema, required-field parity passed
  • git diff --check origin/main...HEAD passed
  • PATH=/Users/ysy/.cache/codex-runtimes/codex-primary-runtime/dependencies/node/bin:$PATH mint broken-links passed

Mapping warnings

  • terraform-provider-flashduty: remote reflog did not contain the exact start timestamp, so diff scan used rev-list --before; no mapped-path changes were found.

Skipped

  • fc-event alert related-event cursor pagination: backend correctness/performance fix; existing docs do not claim cursor semantics.
  • fc-pgy SSO model diff: formatting-only.
  • flashduty-cli / go-flashduty: RUM data query, facets, and sourcemap API docs were already present in docs main.

@ysyneu ysyneu added the documentation Improvements or additions to documentation label Jul 3, 2026
@mintlify

mintlify Bot commented Jul 3, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
flashduty 🟢 Ready View Preview Jul 3, 2026, 6:16 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

ysyneu and others added 6 commits July 2, 2026 23:16
…omain allowlist step

- Replace non-existent npm package @flashcatcloud/fc-sdk-miniprogram with
  the actually published @flashcatcloud/miniprogram-rum (zh/en, 8 files)
- Fix tracing.sampleRate semantics: it is a 0-100 percentage with default
  100, not a 0-1 fraction; update example from 1 to 100
- Add WeChat request legal-domain allowlist configuration to prerequisites
- Document the three additional auto-collected error sources:
  page-not-found, lazy-load, network
- Mark startPage name parameter as optional

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…w-fixes

docs: fix WeChat miniprogram SDK docs (package name, tracing sampleRate, domain allowlist, error sources)
…-api-20260703-031708

docs(api): sync automation trigger APIs
@ysyneu
ysyneu merged commit d99d94c into main Jul 3, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants