Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
F
fuss-manager
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
32
Issues
32
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Package Registry
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
FUSS
fuss-manager
Commits
7ed75c35
Commit
7ed75c35
authored
Aug 18, 2020
by
Elena Grandi
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Migrate old documentation to sphinx
parent
21682b0e
Changes
7
Hide whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
72 additions
and
60 deletions
+72
-60
doc/rest_api.md
doc/rest_api.md
+0
-58
docs/configuration.rst
docs/configuration.rst
+0
-0
docs/index.rst
docs/index.rst
+4
-0
docs/rest_api.rst
docs/rest_api.rst
+66
-0
docs/web_interface.rst
docs/web_interface.rst
+2
-2
examples/fuss_manager.yaml.example
examples/fuss_manager.yaml.example
+0
-0
examples/perms.yaml.example
examples/perms.yaml.example
+0
-0
No files found.
doc/rest_api.md
deleted
100644 → 0
View file @
21682b0e
# fuss-manager REST API
## General description
The main API entry point is at
`/api/1.0`
. All methods return
`JSON`
results,
and the result is always an Object whether the request is successful or not.
All successful requests return objects with the
`time`
key set to the server
time as a Unix timestamp.
All failed requests return objects with three keys:
*
`error`
:
`true`
*
`code`
: the HTTP error code
*
`message`
: a string describing the error
`GET`
requests can take extra arguments in a query string.
`POST`
requests take their input from the
`POST`
body encoded as
`JSON`
.
## API methods
### `ping`
Takes no arguments.
Returns:
*
`pong`
:
`true`
### `async_ping`
Takes no arguments.
Returns:
*
`pong`
:
`true`
### `machines`
Takes no arguments.
Returns:
*
`machines`
: list of machine objects.
Each machine object contains the following keys:
*
`mac`
: MAC address, as a string
*
`ip`
: IP address, as a string
*
`name`
: machine name
*
`first_seen`
: time the machine was first seen, as a Unix timestamp
*
`last_seen`
: time the machine was last seen, as a Unix timestamp
You can use the response
`time`
timestamp to compute how long ago a machine was
first or last seen without introducing errors due to the clock difference
between the browser and the server.
doc/configuration.rst
→
doc
s
/configuration.rst
View file @
7ed75c35
File moved
docs/index.rst
View file @
7ed75c35
...
...
@@ -10,6 +10,10 @@ Welcome to fuss-manager's documentation!
:maxdepth: 2
:caption: Contents:
configuration
web_interface
rest_api
reference
...
...
docs/rest_api.rst
0 → 100644
View file @
7ed75c35
***********************
fuss-manager REST API
***********************
General description
===================
The main API entry point is at ``/api/1.0``. All methods return ``JSON``
results, and the result is always an Object whether the request is
successful or not.
All successful requests return objects with the ``time`` key set to the
server time as a Unix timestamp.
All failed requests return objects with three keys:
- ``error``: ``true``
- ``code``: the HTTP error code
- ``message``: a string describing the error
``GET`` requests can take extra arguments in a query string.
``POST`` requests take their input from the ``POST`` body encoded as
``JSON``.
API methods
===========
``ping``
--------
Takes no arguments.
Returns:
- ``pong``: ``true``
``async_ping``
--------------
Takes no arguments.
Returns:
- ``pong``: ``true``
``machines``
------------
Takes no arguments.
Returns:
- ``machines``: list of machine objects.
Each machine object contains the following keys:
- ``mac``: MAC address, as a string
- ``ip``: IP address, as a string
- ``name``: machine name
- ``first_seen``: time the machine was first seen, as a Unix timestamp
- ``last_seen``: time the machine was last seen, as a Unix timestamp
You can use the response ``time`` timestamp to compute how long ago a
machine was first or last seen without introducing errors due to the
clock difference between the browser and the server.
doc/web_interface.rst
→
doc
s
/web_interface.rst
View file @
7ed75c35
Fuss Manager web interface
==========================
Fuss Manager web interface
specs
==========================
======
Browser compatibility
---------------------
...
...
doc
/fuss_manager.yaml.example
→
examples
/fuss_manager.yaml.example
View file @
7ed75c35
File moved
doc
/perms.yaml.example
→
examples
/perms.yaml.example
View file @
7ed75c35
File moved
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment