Applicability
The “REST API Design Guidelines” document provides guidelines and design patterns used in developing TM Forum REST APIs. The document is organized in seven parts as follow
- Part One Practical guidelines for RESTful APIs naming, CRUD, filtering, notifications
- Part Two Advanced guidelines for RESTful APIs polymorphism, extension patterns, depth and expand directive, entity RefOrValue
- Part Three Guidelines for extending TMF Open API’s with hypermedia support
- Part Four Advanced guidelines for RESTful APIs lifecycle management, common tasks
- Part Five JSON Patch extension to manage arrays
- Part Six JSON Path extension
- Part Seven JSON Schema patterns
Responsible Party
Status
- UUID
- 73b0ee5f-2900-43bf-ab68-343480c7d337