nextcloud-neon/specs/templates/notifications.json

{
  "openapi": "3.0.3",
  "info": {
    "title": "Notifications",
    "version": "2.12.1",
    "description": "This app provides a backend and frontend for the notification API available in Nextcloud.",
    "license": {
      "name": "agpl"
    }
  },
  "servers": [
    {
      "url": "https://{hostname}:{port}/ocs/v1.php/apps/notifications",
      "variables": {
        "hostname": {
          "default": "localhost"
        },
        "port": {
          "default": "8080"
        }
      }
    }
  ],
  "security": [
    {
      "basic_auth": []
    }
  ],
  "components": {
    "securitySchemes": {
      "basic_auth": {
        "type": "http",
        "scheme": "basic"
      }
    }
  },
  "paths": {
    "/api/{apiVersion}/notifications": {
      "parameters": [
        {
          "name": "apiVersion",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "operationId": "endpoint-listnotifications-TODO",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "endpoint-deleteallnotifications-TODO",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/api/{apiVersion}/notifications/{id}": {
      "parameters": [
        {
          "name": "apiVersion",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "id",
          "in": "path",
          "required": true,
          "schema": {
            "type": "integer"
          }
        }
      ],
      "get": {
        "operationId": "endpoint-getnotification-TODO",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "endpoint-deletenotification-TODO",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/api/{apiVersion}/push": {
      "parameters": [
        {
          "name": "apiVersion",
          "in": "path",
          "required": true,
          "schema": {
            "type": "TODO"
          }
        }
      ],
      "post": {
        "operationId": "push-registerdevice-TODO",
        "parameters": [
          {
            "name": "pushTokenHash",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "devicePublicKey",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "proxyServer",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "delete": {
        "operationId": "push-removedevice-TODO",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/api/{apiVersion}/admin_notifications/{userId}": {
      "parameters": [
        {
          "name": "apiVersion",
          "in": "path",
          "required": true,
          "schema": {
            "type": "TODO"
          }
        },
        {
          "name": "userId",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "operationId": "api-generatenotification-TODO",
        "parameters": [
          {
            "name": "shortMessage",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "longMessage",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "default": ""
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    },
    "/api/{apiVersion}/settings": {
      "parameters": [
        {
          "name": "apiVersion",
          "in": "path",
          "required": true,
          "schema": {
            "type": "TODO"
          }
        }
      ],
      "post": {
        "operationId": "settings-personal-TODO",
        "parameters": [
          {
            "name": "batchSetting",
            "in": "query",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "soundNotification",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "soundTalk",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}