docs(openapi): enrich incident/info + channel/list per fc-event#1674#89
Merged
Conversation
Propagate the three public-API field additions from fc-event#1674 into the OpenAPI specs (per-module on-call.openapi.* and consolidated openapi.*, en+zh): - IncidentInfoRequest: relax incident_id to optional, add `num` — the 6-char short id shown in the UI; supply either incident_id or num. - ChannelItem: add team_name and creator_name (resolved from the team/member directories; empty when unavailable).
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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 free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Propagate the three public-API field additions from fc-event#1674 into the OpenAPI specs. Head of the docs → SDK → CLI chain.
Changes (per-module
on-call.openapi.{en,zh}.json+ consolidatedopenapi.{en,zh}.json)IncidentInfoRequest— relaxincident_idto optional, addnum(the 6-char short id shown in the UI; supply eitherincident_idornum). Mirrors the handlerbinding:"required"→omitempty+ newNumfield.ChannelItem— addteam_name+creator_name(resolved from the team/member directories; empty when unavailable).Surgical field-level edits, format byte-preserved (every file round-trips under
json.dumps(ensure_ascii=False, indent=2)), so the diff is only the 3 fields × 4 files (+52 / −16, the deletions being theincident_idrequiredarray). All 4 files re-validate; path/schema counts unchanged.Chain (merge in order)
mainmake sync-spec+make generate→ main (then release/tag)