Skip to content

Commit 9cbd77e

Browse files
authored
Expand README for src/article-api (#58897)
1 parent 9efb0eb commit 9cbd77e

1 file changed

Lines changed: 39 additions & 0 deletions

File tree

src/article-api/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,42 @@ A list of pages available for a fully qualified path containing the target langu
168168

169169
---
170170

171+
172+
## Local Development
173+
174+
### Bootstrap steps
175+
176+
1. Start the dev server:
177+
```bash
178+
npm run dev
179+
```
180+
181+
2. Test API endpoints locally:
182+
```bash
183+
curl http://localhost:4000/api/article/meta?pathname=/en/get-started
184+
curl http://localhost:4000/api/article/body?pathname=/en/get-started
185+
curl http://localhost:4000/api/pagelist/en/free-pro-team@latest
186+
```
187+
188+
### Running tests
189+
190+
```bash
191+
npm run test -- src/article-api/tests
192+
```
193+
194+
## Ownership
195+
196+
- Team: Docs Engineering
197+
198+
## Transformers
199+
200+
Currently implemented transformers:
201+
- **REST API transformer** (`rest-transformer.ts`) - Converts REST API autogenerated content
202+
- **GraphQL transformer** (`graphql-transformer.ts`) - Converts GraphQL API autogenerated content
203+
- **Audit logs transformer** (`audit-logs-transformer.ts`) - Converts audit log tables to markdown
204+
205+
### Known limitations
206+
- Some autogenerated content types don't have transformers yet
207+
- Cache invalidation is manual
208+
- No built-in rate limiting
209+
- Limited API versioning

0 commit comments

Comments
 (0)