def response_list()

in services/ui_backend_service/doc.py [0:0]


def response_list(ref_definition: str):
    return {
        "type": "object",
        "properties": {
            "data": {
                "type": "array",
                "items": {
                    "$ref": ref_definition
                }
            },
            "status": {
                "type": "integer",
                "description": "Response status",
                "default": 200
            },
            "links": {
                "type": "object",
                "properties": {
                    "self": {
                        "type": "string",
                        "description": "Full URL to current page",
                        "default": "http://localhost:8083/path"
                    },
                    "first": {
                        "type": "string",
                        "description": "Full URL to first page",
                        "default": "http://localhost:8083/path?_page=1"
                    },
                    "prev": {
                        "type": "string",
                        "description": "Full URL to previous page",
                        "default": "http://localhost:8083/path?_page=1"
                    },
                    "next": {
                        "type": "string",
                        "description": "Full URL to next page",
                        "default": "http://localhost:8083/path?_page=2"
                    }
                }
            },
            "pages": {
                "type": "object",
                "properties": {
                    "self": {
                        "type": "integer",
                        "description": "Current page number",
                        "default": 1
                    },
                    "first": {
                        "type": "integer",
                        "description": "First page number",
                        "default": 1
                    },
                    "prev": {
                        "type": "integer",
                        "description": "Previous page number",
                        "default": 1
                    },
                    "next": {
                        "type": "integer",
                        "description": "Next page number",
                        "default": 2
                    }
                }
            },
            "query": {
                "type": "object",
                "description": "Object of query parameters"
            }
        }
    }