jksdhgjkasdnh

This commit is contained in:
Kreyren 2020-02-06 06:06:53 +00:00
parent 8d773126c1
commit bdaa0c7cc9
14 changed files with 29 additions and 199 deletions

@ -1 +0,0 @@
WIP

@ -1,3 +0,0 @@
# Review process of RXT0112
1. Everything has to pass tests unless the merge request is not causing the test failure

2
docs/.gitignore vendored

@ -1,4 +1,4 @@
.*
.jekyll-cache/
!.gitignore
!.gitmodules
*~

9
docs/.gitpod.yml Normal file

@ -0,0 +1,9 @@
image:
file: gitpod/gitpod.Dockerfile
ports:
- port: 4000
onOpen: open-preview
tasks:
- init: gem install jekyll

@ -1,6 +1,6 @@
---
exclude: ['README.markdown']
exclude: ['README.markdown', 'gitpod']
permalink: ':title'
pygments: true
safe: false
title: 'Carte'
title: 'Zernit'

@ -1,28 +0,0 @@
---
category: Stuff
path: '/stuff/:id'
title: 'Delete a thing'
type: 'DELETE'
layout: nil
---
This method allows the user to post a new thing to his stuff.
### Request
* **`:id`** is the id the thing to delete.
* The headers must include a **valid authentication token**.
* **The body is omitted**.
### Response
Sends back a collection of things.
```Status: 200 Deleted```
```{
code: 200,
message: 'Your thing (id: 736) was deleted'
}```
For errors responses, see the [response status codes documentation](#response-status-codes).

@ -1,39 +0,0 @@
---
category: Stuff
path: '/stuff/:id'
title: 'Update a thing'
type: 'PUT'
layout: nil
---
This method allows the user to retrieve his stuff.
### Request
* **`:id`** is the id the thing to update.
* The headers must include a **valid authentication token**.
* **The body can't be empty** and must include at least the name attribute, a `string` that will be used as the name of the thing.
```Authentication: bearer f862f658-ad89-4fcb-995b-7a4c50554ff6```
```{
name: 'My new thing'
}```
### Response
Sends back a collection of things.
```Status: 200 OK```
```{
{
id: thing_1,
name: 'My first thing'
},
{
id: thing_2,
name: 'My second thing'
}
}```
For errors responses, see the [response status codes documentation](#response-status-codes).

@ -1,32 +0,0 @@
---
category: Stuff
path: '/stuff'
title: 'Post a thing'
type: 'POST'
layout: nil
---
This method allows users to create a new thing.
### Request
* The headers must include a **valid authentication token**.
* **The body can't be empty** and must include at least the name attribute, a `string` that will be used as the name of the thing.
```Authentication: bearer TOKEN```
```{
name: 'My new thing'
}```
### Response
**If succeeds**, returns the created thing.
```Status: 201 Created```
```{
id: new_thing,
name: 'My new thing'
}```
For errors responses, see the [response status codes documentation](#response-status-codes).

@ -1,32 +0,0 @@
---
category: Stuff
path: '/stuff'
title: 'Get stuff'
type: 'GET'
layout: nil
---
This method allows users to retrieve stuff.
### Request
* The headers must include a **valid authentication token**.
### Response
Sends back a collection of things.
```Status: 200 OK```
```{
{
id: thing_1,
name: 'My first thing'
},
{
id: thing_2,
name: 'My second thing'
}
}```
For errors responses, see the [response status codes documentation](#response-status-codes).

@ -1,20 +0,0 @@
---
path: '/login'
title: 'Authenticate'
layout: nil
---
This method allows users to retrieve stuff.
### Response
Sends back a collection of things.
```Authentication: bearer TOKEN```
```{
id: thing_2,
name: 'My second thing'
}```
For errors responses, see the [response status codes documentation](#response-status-codes).

@ -1,41 +0,0 @@
---
title: 'Response status codes'
layout: nil
---
### Success
Successes differ from errors in that their body may not be a simple response object with a code and a message. The headers however are consistent across all calls:
* `GET`, `PUT`, `DELETE` returns `200 OK` on success,
* `POST ` returns 201 on success,
When [retrieving stuff](#get-stuff) for example:
```Status: 200 OK```
```{
{
id: thing_1,
name: 'My first thing'
},
{
id: thing_2,
name: 'My second thing'
}
}```
### Error
Error responses are simply returning [standard HTTP error codes](http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) along with some additional information:
* The error code is sent back as a status header,
* The body includes an object describing both the code and message (for debugging and/or display purposes),
For a call with an invalid authentication token for example:
```Status: 401 Access denied```
```{
code: 401,
message: 'Access denied: invalid authentication token.'
}```

@ -0,0 +1,10 @@
---
category: Maintainance
title: 'Review process'
layout: nil
---
FIXME-DOCS: preamble
1. Everything has to pass tests unless the merge request is not causing the test failure

@ -0,0 +1,7 @@
FROM gitpod/workspace-full-vnc
USER root
## JEKYLL ##
RUN apt update && apt install -y ruby ruby-dev firefox