v1

package
v0.0.0-...-1a7f21c Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 17, 2021 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var SwaggerInfo = swaggerInfo{
	Version:     "1.0",
	Host:        "devsdk.net/api/dfd",
	BasePath:    "/",
	Schemes:     []string{},
	Title:       "DFD API",
	Description: "# This is a DFD server\nMost of api endpoints aim to restful.\n## Permissions\nAPI endpoints request a permission.\nIf not described, It is public API.\nPermissions are described below table:\n| Permission        | Description                         | Role               |\n|-------------------|-------------------------------------|--------------------|\n| user.patch        | Allows edit user information.       | Admin <br/> User   |\n| user.get          | Allows get user information         | Admin <br/> User   |\n| imagelist.get     |  Allows get own image list          | Admin <br /> User  |\n| image.post        | Allows image upload                 | Admin  <br /> User |\n| image.delete      | Allows image delete                 | Admin  <br /> User |\n| states.get        | Allows get states history           | Admin  <br /> User |\n| states.post       | Allows create states                | Admin  <br /> User |\n| announces.get     | Allows get states announce list     | Admin  <br /> User |\n| announce.post     | Allows create announce              | Admin  <br /> User |\n| announce.get      | Allows get announce                 | Admin  <br /> User |\n| announce.delete   | Allows delete my announce           | Admin  <br /> User |\n| announce.patch    | Allows patch announce               | Admin  <br /> User |\n| admin.token.create| Allows create and patch admin token | Admin              |\n## Authentication\nLogin is working with discord Oauth2.\nAfter login, the access and refresh token stored in Cookie.\nYou should get from the tokens via /token endpoint.\nHowever, all requests take a access token in **Authorization** header for security.\nThe access token is JWT statless token.\nRefresh token is stored and used cookie.",
}

SwaggerInfo holds exported Swagger Info so clients can modify it

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL