mirror of
https://github.com/quay/quay.git
synced 2026-01-26 06:21:37 +03:00
a06cc6fa43
* chore(pre-commit): match black version with requirements-dev * run `make black` against repo * ci: switch to black 24.4.2 * fix: py312 * fix: flake8 errors * fix: flake8 conflicts * chore: add git blame ignore revs file
151 lines
4.6 KiB
Python
151 lines
4.6 KiB
Python
"""
|
|
Messages API.
|
|
"""
|
|
|
|
from flask import abort, make_response, request
|
|
|
|
import features
|
|
from .globalmessages_models_pre_oci import pre_oci_model as model
|
|
from auth import scopes
|
|
from auth.permissions import SuperUserPermission
|
|
from endpoints.api import (
|
|
ApiResource,
|
|
allow_if_superuser,
|
|
nickname,
|
|
require_fresh_login,
|
|
require_scope,
|
|
resource,
|
|
show_if,
|
|
validate_json_request,
|
|
verify_not_prod,
|
|
)
|
|
|
|
|
|
@resource("/v1/messages")
|
|
class GlobalUserMessages(ApiResource):
|
|
"""
|
|
Resource for getting a list of super user messages.
|
|
"""
|
|
|
|
schemas = {
|
|
"GetMessage": {
|
|
"id": "GetMessage",
|
|
"type": "object",
|
|
"description": "Messages that a super user has saved in the past",
|
|
"properties": {
|
|
"message": {
|
|
"type": "array",
|
|
"description": "A list of messages",
|
|
"itemType": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uuid": {
|
|
"type": "string",
|
|
"description": "The message id",
|
|
},
|
|
"content": {
|
|
"type": "string",
|
|
"description": "The actual message",
|
|
},
|
|
"media_type": {
|
|
"type": "string",
|
|
"description": "The media type of the message",
|
|
"enum": ["text/plain", "text/markdown"],
|
|
},
|
|
"severity": {
|
|
"type": "string",
|
|
"description": "The severity of the message",
|
|
"enum": ["info", "warning", "error"],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
"CreateMessage": {
|
|
"id": "CreateMessage",
|
|
"type": "object",
|
|
"description": "Create a new message",
|
|
"properties": {
|
|
"message": {
|
|
"type": "object",
|
|
"description": "A single message",
|
|
"required": [
|
|
"content",
|
|
"media_type",
|
|
"severity",
|
|
],
|
|
"properties": {
|
|
"content": {
|
|
"type": "string",
|
|
"description": "The actual message",
|
|
},
|
|
"media_type": {
|
|
"type": "string",
|
|
"description": "The media type of the message",
|
|
"enum": ["text/plain", "text/markdown"],
|
|
},
|
|
"severity": {
|
|
"type": "string",
|
|
"description": "The severity of the message",
|
|
"enum": ["info", "warning", "error"],
|
|
},
|
|
},
|
|
},
|
|
},
|
|
},
|
|
}
|
|
|
|
@nickname("getGlobalMessages")
|
|
def get(self):
|
|
"""
|
|
Return a super users messages.
|
|
"""
|
|
return {
|
|
"messages": [m.to_dict() for m in model.get_all_messages()],
|
|
}
|
|
|
|
@require_fresh_login
|
|
@verify_not_prod
|
|
@nickname("createGlobalMessage")
|
|
@validate_json_request("CreateMessage")
|
|
@require_scope(scopes.SUPERUSER)
|
|
def post(self):
|
|
"""
|
|
Create a message.
|
|
"""
|
|
if not features.SUPER_USERS:
|
|
abort(404)
|
|
|
|
if allow_if_superuser():
|
|
message_req = request.get_json()["message"]
|
|
message = model.create_message(
|
|
message_req["severity"], message_req["media_type"], message_req["content"]
|
|
)
|
|
if message is None:
|
|
abort(400)
|
|
return make_response("", 201)
|
|
abort(403)
|
|
|
|
|
|
@resource("/v1/message/<uuid>")
|
|
@show_if(features.SUPER_USERS)
|
|
class GlobalUserMessage(ApiResource):
|
|
"""
|
|
Resource for managing individual messages.
|
|
"""
|
|
|
|
@require_fresh_login
|
|
@verify_not_prod
|
|
@nickname("deleteGlobalMessage")
|
|
@require_scope(scopes.SUPERUSER)
|
|
def delete(self, uuid):
|
|
"""
|
|
Delete a message.
|
|
"""
|
|
if allow_if_superuser():
|
|
model.delete_message(uuid)
|
|
return make_response("", 204)
|
|
|
|
abort(403)
|