AIP Knowledge

Quick reference for API Improvement Proposals adapted to REST/OpenAPI.

When to Load References

Based on the task, load the relevant reference file:

Implemented Linter Rules

The AIP reviewer includes 17 automated rules across 6 categories:

Naming (AIP-122)

Standard Methods (AIP-131 to 135)

Pagination (AIP-158)

Filtering (AIP-132, 160)

Errors (AIP-193)

Idempotency (AIP-155)

Topics Without Automated Rules (Reference Only)

The following topics have detailed reference documentation but no automated linter rules yet:

• Field Masks (field-masks.md) - AIP-134 partial update patterns (only aip134/patch-over-put checks for PATCH availability)
• Batch Operations (batch.md) - AIP-231+ batch patterns
• Long-Running Operations (lro.md) - AIP-151, 155 async patterns
• Proto → REST Mapping (rest-mapping.md) - Translation guide

Quick Reference

Standard Methods → HTTP

*Use Idempotency-Key header for safe retries

Naming Rules (AIP-122)

• /users, /orders, /products (plural nouns)
• /user, /order (singular - triggers aip122/plural-resources)
• /getUsers, /createOrder (verbs - triggers aip122/no-verbs)
• /users/{id}/orders (nested ownership)

Pagination (AIP-158)

Request: ?page_size=20&page_token=xxx

Response:

{
  "data": [...],
  "next_page_token": "yyy"
}

Error Response (AIP-193)

{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Human-readable message",
    "details": [...],
    "request_id": "req_abc123"
  }
}

Fetch AIPs On Demand

For detailed guidance, fetch from:

• https://google.aip.dev/{number} (e.g., /158 for pagination)
• Only fetch when user needs deeper explanation