wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add securityDefintions to generated swagger JSON

Browse source 
Also factor out to a common file
This commit is contained in:
Richard van der Hoff 2016-05-03 13:57:16 +01:00
parent cf87120d78
commit 23c4ffbc1b
33 changed files with 46 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

6
api/client-server/account-data.yaml
View file

@ -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:

6
api/client-server/admin.yaml
View file

@ -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:

6
api/client-server/administrative_contact.yaml
View file

@ -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:

6
api/client-server/banning.yaml
View file

@ -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:

6
api/client-server/create_room.yaml
View file

@ -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:

5
api/client-server/definitions/security.yaml Normal file
View file

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

6
api/client-server/directory.yaml
View file

@ -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:

6
api/client-server/event_context.yaml
View file

@ -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:

6
api/client-server/filter.yaml
View file

@ -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:

6
api/client-server/inviting.yaml
View file

@ -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.

6
api/client-server/joining.yaml
View file

@ -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:

6
api/client-server/kicking.yaml
View file

@ -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:

6
api/client-server/leaving.yaml
View file

@ -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:

6
api/client-server/login.yaml
View file

@ -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:

6
api/client-server/message_pagination.yaml
View file

@ -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:

6
api/client-server/old_sync.yaml
View file

@ -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:

6
api/client-server/peeking_events.yaml
View file

@ -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:

6
api/client-server/presence.yaml
View file

@ -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:

6
api/client-server/profile.yaml
View file

@ -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:

6
api/client-server/pusher.yaml
View file

@ -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:

6
api/client-server/pushrules.yaml
View file

@ -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:

6
api/client-server/receipts.yaml
View file

@ -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:

6
api/client-server/redaction.yaml
View file

@ -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:

6
api/client-server/room_send.yaml
View file

@ -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:

6
api/client-server/room_state.yaml
View file

@ -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:

6
api/client-server/rooms.yaml
View file

@ -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:

6
api/client-server/search.yaml
View file

@ -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:

6
api/client-server/sync.yaml
View file

@ -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:

6
api/client-server/tags.yaml
View file

@ -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:

6
api/client-server/third_party_membership.yaml
View file

@ -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:

6
api/client-server/typing.yaml
View file

@ -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:

6
api/client-server/voip.yaml
View file

@ -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:

10
scripts/dump-swagger.py
View file

@ -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: