consensus-backend

command module
v0.0.0-...-c8b7d6d Latest Latest
Warning

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

Go to latest
Published: Jun 23, 2021 License: Apache-2.0 Imports: 8 Imported by: 0

README

consensus-backend


backend for online polls with user-definable answers

API

Authentication: Cookie
Name: AuthToken
Description: The AuthToken cookie holds a JWT token with a 'username´ claim. The signing method is HMAC.

ListAnswers
GET /api/list
Response headers:
  Content-Type: application/json
Response body:
{
  answerID: answer,
  ...
}
Description: get JSON dump of answers

AddAnswer
POST /api/add
FormData
  content string
Request headers:
  Content-Type: application/x-www-form-urlencoded
Description:
  Add a new answer to the list

Vote
GET /api/vote/{answerID}

---

Models:

answer:
  {
    content: string
    upvoted: bool
    votes: int
  }

answerID is the sha1 sum of its content encoded with base64

Documentation

Overview

Copyright © 2021 NAME HERE <EMAIL ADDRESS>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Directories

Path Synopsis
internal
pkg

Jump to

Keyboard shortcuts

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