Reference document

Org
TM-FORUM
Pubnum
TMF630 (2021/05)
Date
2021-05-25
Version
Title
TMF630 API Design Guidelines 3.0 R17.5.0

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

Name
FMN CPWG

Status

URI
https://www.tmforum.org/resources/specification/tmf630-rest-api-design-guidelines-4-2-0/

History

Flag Date RFC Version
added 2022-05-06 14.032 15.0
UUID
73b0ee5f-2900-43bf-ab68-343480c7d337

Relationships

This standard is used by the following service profiles: