Skip to content

Commit

Permalink
refactor: format all files
Browse files Browse the repository at this point in the history
  • Loading branch information
Sonny93 committed Aug 29, 2023
1 parent ce2ec77 commit db3859c
Show file tree
Hide file tree
Showing 47 changed files with 1,639 additions and 1,652 deletions.
112 changes: 52 additions & 60 deletions .adonisrc.json
Original file line number Diff line number Diff line change
@@ -1,62 +1,54 @@
{
"typescript": true,
"commands": [
"./commands",
"@adonisjs/core/build/commands/index.js",
"@adonisjs/repl/build/commands",
"@adonisjs/lucid/build/commands",
"@rocketseat/adonis-bull/build/commands",
"@eidellev/inertia-adonisjs/build/commands"
],
"exceptionHandlerNamespace": "App/Exceptions/Handler",
"aliases": {
"App": "app",
"Config": "config",
"Database": "database",
"Contracts": "contracts"
},
"preloads": [
"./start/routes",
"./start/kernel",
{
"file": "./start/inertia",
"environment": [
"web"
]
}
],
"providers": [
"./providers/AppProvider",
"@adonisjs/core",
"@adonisjs/lucid",
"@adonisjs/redis",
"@adonisjs/auth",
"@rocketseat/adonis-bull",
"@eidellev/inertia-adonisjs",
"@adonisjs/view",
"@adonisjs/session"
],
"aceProviders": [
"@adonisjs/repl"
],
"tests": {
"suites": [
{
"name": "functional",
"files": [
"tests/functional/**/*.spec(.ts|.js)"
],
"timeout": 60000
}
]
},
"testProviders": [
"@japa/preset-adonis/TestsProvider"
],
"metaFiles": [
{
"pattern": "resources/views/**/*.edge",
"reloadServer": false
}
]
"typescript": true,
"commands": [
"./commands",
"@adonisjs/core/build/commands/index.js",
"@adonisjs/repl/build/commands",
"@adonisjs/lucid/build/commands",
"@rocketseat/adonis-bull/build/commands",
"@eidellev/inertia-adonisjs/build/commands"
],
"exceptionHandlerNamespace": "App/Exceptions/Handler",
"aliases": {
"App": "app",
"Config": "config",
"Database": "database",
"Contracts": "contracts"
},
"preloads": [
"./start/routes",
"./start/kernel",
{
"file": "./start/inertia",
"environment": ["web"]
}
],
"providers": [
"./providers/AppProvider",
"@adonisjs/core",
"@adonisjs/lucid",
"@adonisjs/redis",
"@adonisjs/auth",
"@rocketseat/adonis-bull",
"@eidellev/inertia-adonisjs",
"@adonisjs/view",
"@adonisjs/session"
],
"aceProviders": ["@adonisjs/repl"],
"tests": {
"suites": [
{
"name": "functional",
"files": ["tests/functional/**/*.spec(.ts|.js)"],
"timeout": 60000
}
]
},
"testProviders": ["@japa/preset-adonis/TestsProvider"],
"metaFiles": [
{
"pattern": "resources/views/**/*.edge",
"reloadServer": false
}
]
}
38 changes: 23 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,22 +57,24 @@ _/register_

```json
{
"first_name": "string",
"last_name": "string",
"email": "string",
"password": "string"
"first_name": "string",
"last_name": "string",
"email": "string",
"password": "string"
}
```

_/login_

```json
{
"email": "string",
"password": "string"
"email": "string",
"password": "string"
}
```
___

---

#### Files

| Type | Url | Middleware(s) |
Expand All @@ -88,7 +90,7 @@ _/fileDownload/:fileId_

```json
{
"fileId": "string"
"fileId": "string"
}
```

Expand All @@ -97,47 +99,53 @@ _/fileUpload_

```json
{
"files": "array of files"
"files": "array of files"
}
```

_/fileUpdate_

```json
{
"fileId": "string",
"name": "string",
"fileId": "string",
"name": "string"
}
```

_/fileDelete_

```json
{
"fileId": "string"
"fileId": "string"
}
```
___

---

#### Monitoring

| Type | Url | Middleware(s) |
| :-------------------------------------: | :-------- | :------------ |
| <span style="color: #26B260">GET</span> | _/health_ | None |

___
---

## Middlewares

#### Auth

Ensures the protection and authentication of resources by verifying the provided credentials in the HTTP authorization header. This ensures that only authenticated users can access the secured parts of the application.

```
Authorization: Bearer <token>
```

#### StorageCapacity

Ensures that the user does not exceed the storage capacity allocated to him.

#### FileAccess

Ensures that the user has access to the requested resource.

---
---
Loading

0 comments on commit db3859c

Please sign in to comment.