Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Develop #12

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .gitattributes

This file was deleted.

1 change: 0 additions & 1 deletion .gitignore

This file was deleted.

21 changes: 0 additions & 21 deletions LICENSE

This file was deleted.

5 changes: 0 additions & 5 deletions contribution.md

This file was deleted.

Empty file removed documentation/activities.md
Empty file.
Empty file removed documentation/authorization.md
Empty file.
Empty file removed documentation/groups.md
Empty file.
Empty file removed documentation/rental.md
Empty file.
Empty file removed documentation/status-codes.md
Empty file.
Empty file removed documentation/users.md
Empty file.
47 changes: 25 additions & 22 deletions output.html

Large diffs are not rendered by default.

19 changes: 19 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"name": "api-docs",
"version": "1.0.0",
"description": "",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"repository": {
"type": "git",
"url": "git+https://github.com/Scouts-Sint-Joris/API-docs.git"
},
"author": "",
"license": "ISC",
"bugs": {
"url": "https://github.com/Scouts-Sint-Joris/API-docs/issues"
},
"homepage": "https://github.com/Scouts-Sint-Joris/API-docs#readme"
}
18 changes: 0 additions & 18 deletions readme.md

This file was deleted.

70 changes: 29 additions & 41 deletions apiary.apib → src/api-v1.apib
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ HOST: http://www.st-joris-turnhout.be

Deze referentie hoort bij de API die Scouts en Gidsen Sint-Joris, Turnhout. Heeft ontwikkeld voor intern gebruik.

# Group algemeen
# Group Algemeen
#### Authorization request headers

Bij elke(*) request moet een *Authorization-header* worden meegegeven:
Expand Down Expand Up @@ -43,56 +43,44 @@ Code | Reason Phrase
}
}
```
# Group Overzicht

### Oplijsting van alle verhuringen [GET /api/lease]

+ Response 200 (application/json)

+ Headers

X-Authorization: '<Uw API sleutel>'

+ Body

{
}
# Group Verhuringen

### Bekijk een specifieke verhuring [GET /{verhuring_id}]
+ Parameters
+ verhuring_id (integer) - De id van de verhuring in het systeem.

+ Response 401

## Oplijsting van alle Verhuringen [GET /api/lease]
## Informatie optrent verhuring [GET /api/lease/1]
## Verhuring invoegen [POST /api/lease/store]
## Verhuring aanpassen [PUT /api/lease/1]
## Verhuring verwijderen [DELETE /api/lease/1]

### Maak een verhuring aan [POST /api/lease]

+ Request (application/json)
+ Response 401 (application/json)
+ Attributes
+ choices: Swift, `Objective-C` (array, required) - test
- error (Resource unauthorized)

+ Response 200 (application/json)

+ Response 401
# Group Logins
# Group Takken
# Group Activiteiten

### Verwijder een verhuring [DELETE /{verhuring_id}]
# Group API sleutels

+ Parameters
:::note
**NOTE:** Je hebt admin rechten nodig in de website om dit deeltje van de api te gebruiken.
:::

+ verhuring_id (integer) - De id van de verhuring in het systeem.
## Sleutel aanmaken [POST /api/key/create]
## Sleutel verwijderen [DELETE /api/key/1]

+ Response 200 (application/json)
# Data Structures

+ Response 401 (application/json)
## Resource notfound (object)

## Resource created (object)

+ Body
## Resource updated (object)

```javascript
{
"error": {
"code": "401",
"http_code": "GEN-UNAUTHORIZED",
"message":"Unauthorized."
}
}
```
## Resource unauthorized (object)

+ Response 404 (application/json)
- code: 401 (number)
- http_code: `GEN-AUTHORIZED` (string)
- message: Unauthorized (string)
Loading