Add securityDefintions to generated swagger JSON

Also factor out to a common file
9 years ago · 23c4ffbc1b
parent cf87120d78
commit 23c4ffbc1b
33 changed files with 46 additions and 155 deletions
--- a/api/client-server/account-data.yaml
+++ b/api/client-server/account-data.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/user/{userId}/account_data/{type}":
    put:
--- a/api/client-server/admin.yaml
+++ b/api/client-server/admin.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/admin/whois/{userId}":
    get:
--- a/api/client-server/administrative_contact.yaml
+++ b/api/client-server/administrative_contact.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/account/password":
    post:
--- a/api/client-server/banning.yaml
+++ b/api/client-server/banning.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/ban":
    post:
--- a/api/client-server/create_room.yaml
+++ b/api/client-server/create_room.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/createRoom":
    post:
--- a/api/client-server/definitions/security.yaml
+++ b/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
--- a/api/client-server/directory.yaml
+++ b/api/client-server/directory.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/room/{roomAlias}":
    put:
--- a/api/client-server/event_context.yaml
+++ b/api/client-server/event_context.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/context/{eventId}":
    get:
--- a/api/client-server/filter.yaml
+++ b/api/client-server/filter.yaml
@ -11,11 +11,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/user/{userId}/filter":
    post:
--- a/api/client-server/inviting.yaml
+++ b/api/client-server/inviting.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 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.
--- a/api/client-server/joining.yaml
+++ b/api/client-server/joining.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/join":
    post:
--- a/api/client-server/kicking.yaml
+++ b/api/client-server/kicking.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/kick":
    post:
--- a/api/client-server/leaving.yaml
+++ b/api/client-server/leaving.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/leave":
    post:
--- a/api/client-server/login.yaml
+++ b/api/client-server/login.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/login":
    post:
--- a/api/client-server/message_pagination.yaml
+++ b/api/client-server/message_pagination.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/messages":
    get:
--- a/api/client-server/old_sync.yaml
+++ b/api/client-server/old_sync.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/events":
    get:
--- a/api/client-server/peeking_events.yaml
+++ b/api/client-server/peeking_events.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/events":
    get:
--- a/api/client-server/presence.yaml
+++ b/api/client-server/presence.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/presence/{userId}/status":
    put:
--- a/api/client-server/profile.yaml
+++ b/api/client-server/profile.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/profile/{userId}/displayname":
    put:
--- a/api/client-server/pusher.yaml
+++ b/api/client-server/pusher.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/pushers":
    get:
--- a/api/client-server/pushrules.yaml
+++ b/api/client-server/pushrules.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/pushrules/":
    get:
--- a/api/client-server/receipts.yaml
+++ b/api/client-server/receipts.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/receipt/{receiptType}/{eventId}":
    post:
--- a/api/client-server/redaction.yaml
+++ b/api/client-server/redaction.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/redact/{eventId}/{txnId}":
    put:
--- a/api/client-server/room_send.yaml
+++ b/api/client-server/room_send.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/send/{eventType}/{txnId}":
    put:
--- a/api/client-server/room_state.yaml
+++ b/api/client-server/room_state.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/state/{eventType}/{stateKey}":
    put:
--- a/api/client-server/rooms.yaml
+++ b/api/client-server/rooms.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/state/{eventType}/{stateKey}":
    get:
--- a/api/client-server/search.yaml
+++ b/api/client-server/search.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/search":
    post:
--- a/api/client-server/sync.yaml
+++ b/api/client-server/sync.yaml
@ -11,11 +11,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/sync":
    get:
--- a/api/client-server/tags.yaml
+++ b/api/client-server/tags.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/user/{userId}/rooms/{roomId}/tags":
    get:
--- a/api/client-server/third_party_membership.yaml
+++ b/api/client-server/third_party_membership.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/invite":
    post:
--- a/api/client-server/typing.yaml
+++ b/api/client-server/typing.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/rooms/{roomId}/typing/{userId}":
    put:
--- a/api/client-server/voip.yaml
+++ b/api/client-server/voip.yaml
@ -12,11 +12,7 @@ consumes:
 produces:
  - application/json
 securityDefinitions:
-  accessToken:
-    type: apiKey
-    description: The user_id or application service access_token
-    name: access_token
-    in: query
+  $ref: definitions/security.yaml
 paths:
  "/voip/turnServer":
    get:
--- a/scripts/dump-swagger.py
+++ b/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: