Skip to content
AEP
Search
Ctrl
K
Cancel
GitHub
BlueSky
YouTube
RSS
Blog
Select theme
Dark
Light
Auto
Overview
AEPs
Tooling
Blog
Blog
Meta
1. AEP Purpose and Guidelines
2. AEP Numbering and Organization
8. AEP Style and Guidance
General
3. Glossary
5. Designing an API
101. OpenAPI
Resources
4. Resource types
121. Resource-oriented design
122. Resource paths
124. Resource association
126. Enumerations
156. Singleton resources
159. Reading across collections
Standard Methods
130. Methods
131. Get
132. List
133. Create
134. Update
135. Delete
136. Custom methods
137. Apply
Fields
140. Field names
141. Quantities
142. Time and duration
144. Array fields
145. Ranges
146. Generic fields
148. Standard fields
203. Field behavior documentation
Types
143. Standardized codes
210. Unicode
213. Common components
215. Common component versions
Design Patterns
151. Long-running operations
154. Resource freshness validation
155. Idempotency
157. Partial responses
158. Pagination
160. Filtering
161. Field masks
162. Resource Revisions
164. Soft delete
193. Errors
211. Authorization checks
214. Resource expiration
216. States
217. Unreachable resources
Batch Methods
231. Batch methods- Get
233. Batch methods- Create
234. Batch methods- Update
235. Batch methods- Delete
Security
Governance
100. API Design Review FAQ
205. Beta-blocking changes
Best Practices
180. Backwards compatibility
181. Stability levels
192. Documentation
200. Precedent
Protocol buffers
127. HTTP and gRPC Transcoding
191. File and directory structure
GitHub
BlueSky
YouTube
RSS
Blog
Select theme
Dark
Light
Auto
Batch methods- Create