Added TOC

Change-Id: Iadf943bd36fbb991e0a87ae22761714e41deef00
2014-08-12 15:21:26 -06:00
parent 0821e0410b
commit a612bc9e33
1 changed files with 234 additions and 0 deletions
--- a/docs/monasca-api-spec.md
+++ b/docs/monasca-api-spec.md
@@ -4,6 +4,240 @@ Date: July 18, 2014

 Document Version: v2.0

+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](http://doctoc.herokuapp.com/)*
+
+- [Monasca API](#monasca-api)
+- [Overview](#overview)
+  - [Metric Name and Dimensions](#metric-name-and-dimensions)
+    - [Name](#name)
+    - [Dimensions](#dimensions)
+  - [Alarm Expressions](#alarm-expressions)
+    - [Syntax](#syntax)
+      - [Simple Example](#simple-example)
+      - [More Complex Example](#more-complex-example)
+      - [Compound alarm example](#compound-alarm-example)
+- [Common Request Headers](#common-request-headers)
+  - [Common Http Request Headers](#common-http-request-headers)
+  - [Non-standard request headers](#non-standard-request-headers)
+- [Common Responses](#common-responses)
+- [Versions](#versions)
+  - [List Versions](#list-versions)
+    - [GET](#get)
+      - [Headers](#headers)
+      - [Path Parameters](#path-parameters)
+      - [Query Parameters](#query-parameters)
+      - [Request Body](#request-body)
+      - [Request Examples](#request-examples)
+    - [Response](#response)
+      - [Status code](#status-code)
+      - [Response Body](#response-body)
+      - [Response Examples](#response-examples)
+  - [Get Version](#get-version)
+    - [Get /{version_id}](#get-version_id)
+      - [Headers](#headers-1)
+      - [Path Parameters](#path-parameters-1)
+      - [Query Parameters](#query-parameters-1)
+      - [Request Body](#request-body-1)
+      - [Request Examples](#request-examples-1)
+    - [Response](#response-1)
+      - [Status code](#status-code-1)
+      - [Response Body](#response-body-1)
+      - [Response Examples](#response-examples-1)
+- [Metrics](#metrics)
+  - [Create Metric](#create-metric)
+    - [POST /v2.0/metrics](#post-v20metrics)
+      - [Headers](#headers-2)
+      - [Path Parameters](#path-parameters-2)
+      - [Query Parameters](#query-parameters-2)
+      - [Request Body](#request-body-2)
+      - [Request Examples](#request-examples-2)
+        - [Single metric](#single-metric)
+        - [Array of metrics](#array-of-metrics)
+    - [Response](#response-2)
+      - [Status Code](#status-code)
+      - [Response Body](#response-body-2)
+  - [List metrics](#list-metrics)
+      - [GET /v2.0/metrics](#get-v20metrics)
+      - [Headers](#headers-3)
+      - [Path Parameters](#path-parameters-3)
+      - [Query Parameters](#query-parameters-3)
+      - [Request Body](#request-body-3)
+      - [Request Examples](#request-examples-3)
+    - [Response](#response-3)
+      - [Status Code](#status-code-1)
+      - [Response Body](#response-body-3)
+      - [Response Examples](#response-examples-2)
+- [Measurements](#measurements)
+  - [List measurements](#list-measurements)
+    - [GET /v2.0/metrics/measurements](#get-v20metricsmeasurements)
+      - [Headers](#headers-4)
+      - [Path Parameters](#path-parameters-4)
+      - [Query Parameters](#query-parameters-4)
+      - [Request Body](#request-body-4)
+      - [Request Examples](#request-examples-4)
+    - [Response](#response-4)
+      - [Status Code](#status-code-2)
+      - [Response Body](#response-body-4)
+      - [Response Examples](#response-examples-3)
+- [Statistics](#statistics)
+  - [List statistics](#list-statistics)
+    - [GET /v2.0/metrics/statistics](#get-v20metricsstatistics)
+      - [Headers](#headers-5)
+      - [Path Parameters](#path-parameters-5)
+      - [Query Parameters](#query-parameters-5)
+      - [Request Body](#request-body-5)
+      - [Request Examples](#request-examples-5)
+    - [Response](#response-5)
+      - [Status Code](#status-code-3)
+      - [Response Body](#response-body-5)
+      - [Response Examples](#response-examples-4)
+- [Notification Methods](#notification-methods)
+  - [Create Notification Method](#create-notification-method)
+    - [POST /v2.0/notification-methods](#post-v20notification-methods)
+      - [Headers](#headers-6)
+      - [Path Parameters](#path-parameters-6)
+      - [Query Parameters](#query-parameters-6)
+      - [Request Body](#request-body-6)
+      - [Request Examples](#request-examples-6)
+    - [Response](#response-6)
+      - [Status Code](#status-code-4)
+      - [Response Body](#response-body-6)
+      - [Response Examples](#response-examples-5)
+  - [List Notification Methods](#list-notification-methods)
+    - [GET /v2.0/notification-methods](#get-v20notification-methods)
+      - [Headers](#headers-7)
+      - [Path Parameters](#path-parameters-7)
+      - [Query Parameters](#query-parameters-7)
+      - [Request Body](#request-body-7)
+      - [Request Examples](#request-examples-7)
+    - [Response](#response-7)
+      - [Status Code](#status-code-5)
+      - [Response Body](#response-body-7)
+      - [Response Examples](#response-examples-6)
+  - [Get Notification Method](#get-notification-method)
+    - [GET /v2.0/notification-methods/{notification_method_id}](#get-v20notification-methodsnotification_method_id)
+      - [Headers](#headers-8)
+      - [Path Parameters](#path-parameters-8)
+      - [Query Parameters](#query-parameters-8)
+      - [Request Body](#request-body-8)
+      - [Request Examples](#request-examples-8)
+    - [Response](#response-8)
+      - [Status Code](#status-code-6)
+      - [Response Body](#response-body-8)
+      - [Response Examples](#response-examples-7)
+  - [Update Notification Method](#update-notification-method)
+    - [PUT /v2.0/notification-methods/{notification_method_id}](#put-v20notification-methodsnotification_method_id)
+      - [Headers](#headers-9)
+      - [Path Parameters](#path-parameters-9)
+      - [Query Parameters](#query-parameters-9)
+      - [Request Body](#request-body-9)
+      - [Request Examples](#request-examples-9)
+    - [Response](#response-9)
+      - [Status Code](#status-code-7)
+      - [Response Body](#response-body-9)
+      - [Response Examples](#response-examples-8)
+  - [Delete Notification Method](#delete-notification-method)
+    - [DELETE /v2.0/notification-methods/{notification_method_id}](#delete-v20notification-methodsnotification_method_id)
+      - [Headers](#headers-10)
+      - [Path Parameters](#path-parameters-10)
+      - [Query Parameters](#query-parameters-10)
+      - [Request Body](#request-body-10)
+      - [Request Examples](#request-examples-10)
+    - [Response](#response-10)
+      - [Status Code](#status-code-8)
+      - [Response Body](#response-body-10)
+- [Alarms](#alarms)
+  - [Create Alarm](#create-alarm)
+    - [POST /v2.0/alarms](#post-v20alarms)
+      - [Headers](#headers-11)
+      - [Path Parameters](#path-parameters-11)
+      - [Query Parameters](#query-parameters-11)
+      - [Request Body](#request-body-11)
+      - [Request Examples](#request-examples-11)
+    - [Response](#response-11)
+      - [Status Code](#status-code-9)
+      - [Response Body](#response-body-11)
+      - [Response Examples](#response-examples-9)
+  - [List Alarms](#list-alarms)
+    - [GET /v2.0/alarms](#get-v20alarms)
+      - [Headers](#headers-12)
+      - [Path Parameters](#path-parameters-12)
+      - [Query Parameters](#query-parameters-12)
+      - [Request Body](#request-body-12)
+      - [Request Examples](#request-examples-12)
+    - [Response"](#response)
+      - [Status Code](#status-code-10)
+      - [Response Body](#response-body-12)
+      - [Response Examples](#response-examples-10)
+  - [List Alarms State History](#list-alarms-state-history)
+    - [GET /v2.0/alarms/state-history](#get-v20alarmsstate-history)
+      - [Headers](#headers-13)
+      - [Path Parameters](#path-parameters-13)
+      - [Query Parameters](#query-parameters-13)
+      - [Request Body](#request-body-13)
+    - [Response](#response-12)
+      - [Status Code](#status-code-11)
+      - [Response Body](#response-body-13)
+      - [Response Examples](#response-examples-11)
+  - [Get Alarm](#get-alarm)
+    - [GET /v2.0/alarms/{alarm_id}](#get-v20alarmsalarm_id)
+      - [Headers](#headers-14)
+      - [Path Parameters](#path-parameters-14)
+      - [Query Parameters](#query-parameters-14)
+      - [Request Body](#request-body-14)
+    - [Response](#response-13)
+      - [Status Code](#status-code-12)
+      - [Response Body](#response-body-14)
+      - [Response Examples](#response-examples-12)
+  - [Update Alarm](#update-alarm)
+    - [PUT /v2.0/alarms/{alarm_id}](#put-v20alarmsalarm_id)
+      - [Headers](#headers-15)
+      - [Path Parameters](#path-parameters-15)
+      - [Query Parameters](#query-parameters-15)
+      - [Request Body](#request-body-15)
+      - [Request Examples](#request-examples-13)
+    - [Response](#response-14)
+      - [Status Code](#status-code-13)
+      - [Response Body](#response-body-15)
+      - [Response Examples](#response-examples-13)
+  - [Update Alarm](#update-alarm-1)
+    - [PATCH /v2.0/alarms/{alarm_id}](#patch-v20alarmsalarm_id)
+      - [Headers](#headers-16)
+      - [Path Parameters](#path-parameters-16)
+      - [Query Parameters](#query-parameters-16)
+      - [Request Body](#request-body-16)
+      - [Request Examples](#request-examples-14)
+    - [Response](#response-15)
+      - [Status Code](#status-code-14)
+      - [Response Body](#response-body-16)
+      - [Response Examples](#response-examples-14)
+  - [Delete Alarm](#delete-alarm)
+    - [DELETE /v2.0/alarms/{alarm_id}](#delete-v20alarmsalarm_id)
+      - [Headers](#headers-17)
+      - [Path Parameters](#path-parameters-17)
+      - [Query Parameters](#query-parameters-17)
+      - [Request Body](#request-body-17)
+      - [Request Examples](#request-examples-15)
+    - [Response](#response-16)
+      - [Status Code](#status-code-15)
+      - [Response Body](#response-body-17)
+  - [List Alarm State History](#list-alarm-state-history)
+    - [GET /v2.0/alarms/{alarm_id}/state-history](#get-v20alarmsalarm_idstate-history)
+      - [Headers](#headers-18)
+      - [Path Parameters](#path-parameters-18)
+      - [Query Parameters](#query-parameters-18)
+      - [Request Body](#request-body-18)
+      - [Request Data](#request-data)
+    - [Response](#response-17)
+      - [Status Code](#status-code-16)
+      - [Response Body](#response-body-18)
+      - [Response Examples](#response-examples-15)
+- [License](#license)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 # Overview
 This document describes the Monasca API v2.0, which supports Monitoring as a Service (MONaaS). The Monasca API provides a RESTful JSON interface for interacting with and managing monitoring related resources.