Add securityDefintions to generated swagger JSON

Also factor out to a common file

api/client-server/account-data.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/user/{userId}/account_data/{type}":
     put:

api/client-server/admin.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/admin/whois/{userId}":
     get:

api/client-server/administrative_contact.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/account/password":
     post:

api/client-server/banning.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/ban":
     post:

api/client-server/create_room.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/createRoom":
     post:

api/client-server/definitions/security.yaml

@@ -0,0 +1,5 @@
+accessToken:
+  type: apiKey
+  description: The access_token returned by a call to ``/login`` or ``/tokenrefresh``
+  name: access_token
+  in: query

api/client-server/directory.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/room/{roomAlias}":
     put:

api/client-server/event_context.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/context/{eventId}":
     get:

api/client-server/filter.yaml

@@ -11,11 +11,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/user/{userId}/filter":
     post:

api/client-server/inviting.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   # With an extra " " to disambiguate from the 3pid invite endpoint
   # The extra space makes it sort first for what I'm sure is a good reason.

api/client-server/joining.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/join":
     post:

api/client-server/kicking.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/kick":
     post:

api/client-server/leaving.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/leave":
     post:

api/client-server/login.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/login":
     post:

api/client-server/message_pagination.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/messages":
     get:

api/client-server/old_sync.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/events":
     get:

api/client-server/peeking_events.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/events":
     get:

api/client-server/presence.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/presence/{userId}/status":
     put:

api/client-server/profile.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/profile/{userId}/displayname":
     put:

api/client-server/pusher.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/pushers":
     get:

api/client-server/pushrules.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/pushrules/":
     get:

api/client-server/receipts.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/receipt/{receiptType}/{eventId}":
     post:

api/client-server/redaction.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/redact/{eventId}/{txnId}":
     put:

api/client-server/room_send.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/send/{eventType}/{txnId}":
     put:

api/client-server/room_state.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/state/{eventType}/{stateKey}":
     put:

api/client-server/rooms.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/state/{eventType}/{stateKey}":
     get:

api/client-server/search.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/search":
     post:

api/client-server/sync.yaml

@@ -11,11 +11,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/sync":
     get:

api/client-server/tags.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/user/{userId}/rooms/{roomId}/tags":
     get:

api/client-server/third_party_membership.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/invite":
     post:

api/client-server/typing.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/rooms/{roomId}/typing/{userId}":
     put:

api/client-server/voip.yaml

@@ -12,11 +12,7 @@ consumes:
 produces:
   - application/json
 securityDefinitions:
-  accessToken:
+  $ref: definitions/security.yaml
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
 paths:
   "/voip/turnServer":
     get:

scripts/dump-swagger.py

@@ -12,9 +12,12 @@ import os.path
 import re
 import shutil
 import sys
+import yaml
 
 scripts_dir = os.path.dirname(os.path.abspath(__file__))
 templating_dir = os.path.join(os.path.dirname(scripts_dir), "templating")
+api_dir = os.path.join(os.path.dirname(scripts_dir), "api")
+
 sys.path.insert(0, templating_dir)
 
 from matrix_templates.units import resolve_references, MatrixUnits
@@ -50,10 +53,15 @@ output = {
         "title": "Matrix Client-Server API",
         "version": release_label,
     },
+    "securityDefinitions": {},
     "paths": {},
     "swagger": "2.0",
 }
 
+with open(os.path.join(api_dir, 'client-server', 'definitions',
+                       'security.yaml')) as f:
+    output['securityDefinitions'] = yaml.load(f)
+
 for file, contents in apis.items():
     for path, methods in contents["paths"].items():
         for method, spec in methods.items():
@@ -62,6 +70,8 @@ for file, contents in apis.items():
                     output["paths"][path] = {}
                 output["paths"][path][method] = spec
 
+
+
 print "Generating %s" % output_file
 
 try: