Skip to content

Commit ae191c7

Browse files
authored
Expand README for src/rest (#58904)
1 parent 41fa67c commit ae191c7

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

src/rest/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,36 @@ Slack: `#docs-engineering`
7878
Repo: `github/docs-engineering`
7979

8080
If you have a question about the REST pipeline, you can ask in the `#docs-engineering` Slack channel. If you notice a problem with the REST pipeline, you can open an issue in the `github/docs-engineering` repository.
81+
82+
## Ownership & Escalation
83+
84+
### Ownership
85+
- **Team**: Docs Engineering
86+
- **Source data**: API Platform team (github/rest-api-description)
87+
88+
### Escalation path
89+
1. **Pipeline failures** → #docs-engineering Slack
90+
2. **OpenAPI schema issues** → #api-platform Slack
91+
92+
### On-call procedures
93+
If the REST pipeline fails:
94+
1. Check workflow logs in `.github/workflows/sync-openapi.yml`
95+
2. Verify access to `github/rest-api-description` repo
96+
3. Check for OpenAPI schema validation errors
97+
4. Review changes in generated files for unexpected output
98+
5. Check `config.json` for version mapping issues
99+
6. Escalate to API Platform team if schema issue
100+
101+
### Monitoring
102+
- Pipeline runs automatically on daily schedule (shared with Webhooks/GitHub Apps)
103+
- PRs created with `github-openapi-bot` label
104+
- SHA tracking in `config.json` for version history
105+
- Failures visible in GitHub Actions
106+
107+
We will continue to support changes incoming from the API Platform including new, deleted, changed endpoints and additional information as provided. We do not expect any significant new functionality moving forward.
108+
109+
### Known limitations
110+
- **Shared pipeline** - Can't run REST independently of Webhooks/GitHub Apps
111+
- **Version overwrite** - Pipeline overwrites `versions` frontmatter
112+
- **Introduction placement** - Must be above auto-generation comment
113+
- **API version sync** - Calendar-date versions require manual config updates

0 commit comments

Comments
 (0)