qas_api

README

Qas | API

Qas backend API built against Golang net/http.

Endpoints

Method	Pattern	Code	Action
GET	/config/list	200	Fetches all configurations.
GET	/config/one?lang	200	Fetch a single configuration.
POST	/config/new	201	Create a new configuration.
PUT	/config/replace?lang	200	Overwrite a configuration.
PATCH	/config/update?lang?info	200	Append project to configuration.
DELETE	/config/destroy?lang	204	Deletes a configuration.

Port

Default port is at :5000/VERSION

Configurations

qas looks for configuration files at $XDG_CONFIG/qas:

$XDG_CONFIG/qas/misc.json

[
  {
    "name": "awesomewm",
    "branch": "master",
    "url": "https://github.com/awesomeWM/awesome"
  },
  {
    "name": "nuxt",
    "branch": "main",
    "url": "https://github.com/nuxt/framework"
  },
  {
    "name": "swift_format",
    "branch": "main",
    "url": "https://github.com/apple/swift-format"
  }
]

GNU Guix

To load all system dependencies, just run guix shell

TODO

• implement simpler Alice-like chaining
• config: branch defaults to master

LICENSE

GPL-v3

Documentation

Overview

* Qas is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version.

* Qas is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details.

* You should have received a copy of the GNU General Public License * along with Qas. If not, see <https://www.gnu.org/licenses/>.