TM Forum · Schema

Milestone

Milestone schema from TM Forum API

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tmf622-product-ordering-milestone-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-schema/tmf622-product-ordering-milestone-schema.json",
  "title": "Milestone",
  "description": "Milestone schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Extensible"
    },
    {
      "type": "object",
      "description": "Milestone represents an action or event marking a significant change or stage in a process like an order process.",
      "properties": {
        "description": {
          "type": "string",
          "description": "free-text description of the Milestone"
        },
        "id": {
          "type": "string",
          "description": "identifier of the Milestone"
        },
        "status": {
          "description": "The milestone status",
          "type": "string",
          "enum": [
            "Yet-To-Reach",
            "Completed",
            "Violated"
          ]
        },
        "milestoneDate": {
          "type": "string",
          "format": "date-time",
          "description": "A date time( DateTime). The date that the milestone happens"
        },
        "name": {
          "type": "string",
          "description": "A string used to give a name to the milestone"
        },
        "message": {
          "type": "string",
          "description": "A string represents the message of the milestone"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "Milestone": "#/components/schemas/Milestone",
      "ProductOrderMilestone": "#/components/schemas/ProductOrderMilestone"
    }
  }
}