aljaz/CTFd
1
0
Fork 0
mirror of https://github.com/aljazceru/CTFd.git synced 2025-12-18 14:34:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

Document API authentication (#2021)

Browse Source 
* Document API authentication and Content-Type header requirement
This commit is contained in:
Nikita Stupin
2021-11-22 13:38:19 +03:00
committed by GitHub
parent 7fc05bd4e3
commit a0783c334c
1 changed files with 20 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
CTFd/api/__init__.py
View File

@@ -26,7 +26,26 @@ from CTFd.api.v1.unlocks import unlocks_namespace
from CTFd.api.v1.users import users_namespace from CTFd.api.v1.users import users_namespace
api = Blueprint("api", __name__, url_prefix="/api/v1") api = Blueprint("api", __name__, url_prefix="/api/v1")
CTFd_API_v1 = Api(api, version="v1", doc=current_app.config.get("SWAGGER_UI_ENDPOINT")) CTFd_API_v1 = Api(
api,
version="v1",
doc=current_app.config.get("SWAGGER_UI_ENDPOINT"),
authorizations={
"AccessToken": {
"type": "apiKey",
"in": "header",
"name": "Authorization",
"description": "Generate access token in the settings page of your user account.",
},
"ContentType": {
"type": "apiKey",
"in": "header",
"name": "Content-Type",
"description": "Must be set to `application/json`",
},
},
security=["AccessToken", "ContentType"],
)
CTFd_API_v1.schema_model("APISimpleErrorResponse", APISimpleErrorResponse.schema()) CTFd_API_v1.schema_model("APISimpleErrorResponse", APISimpleErrorResponse.schema())
CTFd_API_v1.schema_model( CTFd_API_v1.schema_model(