From c8393306d161dc73340dd0dd7a09ab765e7e542f Mon Sep 17 00:00:00 2001
From: Maxime Dor <max@kamax.io>
Date: Tue, 27 Feb 2018 17:26:50 +0100
Subject: [PATCH] Add IS ping endpoint

---
 api/identity/ping.yaml                 | 44 ++++++++++++++++++++++++++
 specification/identity_service_api.rst |  5 +++
 2 files changed, 49 insertions(+)
 create mode 100644 api/identity/ping.yaml

diff --git a/api/identity/ping.yaml b/api/identity/ping.yaml
new file mode 100644
index 00000000..005160a3
--- /dev/null
+++ b/api/identity/ping.yaml
@@ -0,0 +1,44 @@
+# Copyright 2018 Kamax Sàrl
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+swagger: "2.0"
+info:
+  title: "Matrix Client-Identity Versions API"
+  version: "1.0.0"
+host: localhost:8090
+schemes:
+  - https
+basePath: /_matrix/identity
+produces:
+  - application/json
+paths:
+  "/api/v1":
+    get:
+      summary: Checks that an Identity server is available at this API endpopint.
+      description: |-
+        Checks that an Identity server is available at this API endpopint.
+
+        To discover that an Identity server is available at a specific URL,
+        this endpoint can be queried and will return an empty object.
+
+        This is primarly used for auto-discovery and health check purposes
+        by entities acting as a client for the Identity server.
+      operationId: ping
+      responses:
+        200:
+          description: An Identity server is ready to serve requests.
+          examples:
+            application/json: {}
+          schema:
+            type: object
diff --git a/specification/identity_service_api.rst b/specification/identity_service_api.rst
index 19275593..89fcc3e6 100644
--- a/specification/identity_service_api.rst
+++ b/specification/identity_service_api.rst
@@ -67,6 +67,11 @@ should allow a 3pid to be mapped to a Matrix user identity, but not in the other
 direction (i.e. one should not be able to get all 3pids associated with a Matrix
 user ID, or get all 3pids associated with a 3pid).
 
+Status check
+------------
+
+{{ping_is_http_api}}
+
 Key management
 --------------