Skip to content
Merged
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
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@

Backend/.php-cs-fixer.cache
2 changes: 1 addition & 1 deletion Backend/.php-cs-fixer.cache

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions Backend/.scribe/.filehashes
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# GENERATED. YOU SHOULDN'T MODIFY OR DELETE THIS FILE.
# Scribe uses this file to know when you change something manually in your docs.
.scribe/intro.md=2d432f59f3d780ec094e1b4b0b024f33
.scribe/auth.md=7cec6a1c5e4916daf2548212cee2ff83
7 changes: 7 additions & 0 deletions Backend/.scribe/auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Authenticating requests

To authenticate requests, include an **`Authorization`** header with the value **`"Bearer {YOUR_AUTH_KEY}"`**.

All authenticated endpoints are marked with a `requires authentication` badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking <b>Generate API token</b>.
150 changes: 150 additions & 0 deletions Backend/.scribe/endpoints.cache/00.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,150 @@
## Autogenerated by Scribe. DO NOT MODIFY.

name: Auth
description: '*'
endpoints:
-
httpMethods:
- POST
uri: api/register
metadata:
groupName: Auth
groupDescription: '*'
subgroup: ''
subgroupDescription: ''
title: ''
description: ''
authenticated: false
custom: []
headers:
Content-Type: application/json
Accept: application/json
urlParameters: []
cleanUrlParameters: []
queryParameters: []
cleanQueryParameters: []
bodyParameters:
name:
name: name
description: ''
required: true
example: aspernatur
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
email:
name: email
description: 'Must be a valid email address.'
required: true
example: jamison69@example.org
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
password:
name: password
description: ''
required: true
example: ut
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
name: aspernatur
email: jamison69@example.org
password: ut
fileParameters: []
responses: []
responseFields: []
auth: []
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: api/login
metadata:
groupName: Auth
groupDescription: '*'
subgroup: ''
subgroupDescription: ''
title: ''
description: ''
authenticated: false
custom: []
headers:
Content-Type: application/json
Accept: application/json
urlParameters: []
cleanUrlParameters: []
queryParameters: []
cleanQueryParameters: []
bodyParameters:
email:
name: email
description: 'Must be a valid email address. The <code>email</code> of an existing record in the users table.'
required: true
example: kamryn22@example.com
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
password:
name: password
description: ''
required: true
example: at
type: string
enumValues: []
exampleWasSpecified: false
nullable: false
custom: []
cleanBodyParameters:
email: kamryn22@example.com
password: at
fileParameters: []
responses: []
responseFields: []
auth: []
controller: null
method: null
route: null
custom: []
-
httpMethods:
- POST
uri: api/logout
metadata:
groupName: Auth
groupDescription: '*'
subgroup: ''
subgroupDescription: ''
title: ''
description: ''
authenticated: false
custom: []
headers:
Content-Type: application/json
Accept: application/json
urlParameters: []
cleanUrlParameters: []
queryParameters: []
cleanQueryParameters: []
bodyParameters: []
cleanBodyParameters: []
fileParameters: []
responses: []
responseFields: []
auth: []
controller: null
method: null
route: null
custom: []
Loading
Loading