Skip to content

Commit

Permalink
Better Goals and Non-Goals
Browse files Browse the repository at this point in the history
  • Loading branch information
humitos committed Jun 26, 2019
1 parent 71d07cf commit 250ee1f
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions docs/development/design/apiv3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,31 @@ from where most of the endpoint will be based on it.
Goals
-----

* Easy to use for our users
* Easy to use for our users (access most of resources by ``slug``)
* Useful to perform read and write operations
* Cover most useful cases
* Authentication/Authorization

* Authentication based on scoped-tokens
* Handle Authorization nicely using an abstraction layer

* Cover most useful cases:

* Integration on CI (check build status, trigger new build, etc)
* Usage from public Sphinx/MkDocs extensions
* Allow creation of flyout menu client-side
* Simplify migration from other services (import projects, create multiple redirects, etc)


Non-Goals
---------

* Filter by arbitrary and non-useful fields

* "Builds with ``exit_code=1``"
* "Builds containing ``ERROR`` on their output"
* "Projects created after X datetime"
* "Versions with tag ``python``"

* Cover *all the actions* available from the WebUI


Expand Down

0 comments on commit 250ee1f

Please sign in to comment.