Skip to content

AEPs

Meta

1 AEP Purpose and Guidelines

2 AEP Numbering and Organization

8 AEP Style and Guidance

300 AEP Editions

General

5 Designing an API

101 OpenAPI

102 APIs and API terminology

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

142 Time and duration

144 Array fields

145 Ranges

146 Generic fields

148 Standard fields

Types

143 Standardized codes

210 Unicode

213 Common components

Design Patterns

151 Long-running operations

154 Preconditions

155 Idempotency

157 Partial responses

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 Reviewing

234 Batch methods- Update Reviewing

235 Batch methods- Delete Reviewing

Best Practices

192 Documentation

Protocol buffers

127 HTTP and gRPC Transcoding

161 Field masks

180 Protobuf Backwards compatibility

191 File and directory structure

203 Field behavior documentation