Skip to content

AEPs

Meta

300 AEP Editions

8 AEP Style and Guidance

2 AEP Numbering and Organization

1 AEP Purpose and Guidelines Reviewing

General

101 OpenAPI

5 Designing an API

Resources

159 Reading across collections

156 Singleton resources

126 Enumerations

124 Resource association

122 Resource paths

121 Resource-oriented design

4 Resource types

Standard Methods

130 Methods

131 Get

132 List

133 Create

134 Update

135 Delete

137 Apply

136 Custom methods

Fields

148 Standard fields

146 Generic fields

142 Time and duration

144 Array fields

145 Ranges

140 Field names

Types

215 Common component versions Reviewing

213 Common components Reviewing

210 Unicode

143 Standardized codes Reviewing

Design Patterns

217 Unreachable resources

216 States

214 Resource expiration Reviewing

193 Errors

162 Resource Revisions

161 Field masks Reviewing

157 Partial responses

154 Resource freshness validation

151 Long-running operations

164 Soft delete

211 Authorization checks

155 Idempotency

Batch Methods

235 Batch methods- Delete Reviewing

234 Batch methods- Update Reviewing

233 Batch methods- Create Reviewing

231 Batch methods- Get

Security

Governance

205 Beta-blocking changes

100 API Design Review FAQ Reviewing

Best Practices

192 Documentation

Protocol buffers

203 Field behavior documentation

191 File and directory structure

180 Protobuf Backwards compatibility

127 HTTP and gRPC Transcoding