mirror of
https://github.com/anna-sara/vbytes_lan.git
synced 2025-12-23 21:17:12 +01:00
Docs
This commit is contained in:
Anna-Sara Sélea
parent
cc960f7d3f
commit
5000e589b8
3 changed files with 298 additions and 54 deletions
55
README.md
55
README.md
|
|
@ -1,60 +1,7 @@
|
|||
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
|
||||
## vBytes LAN
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
|
||||
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
|
||||
</p>
|
||||
|
||||
## About Laravel
|
||||
|
||||
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
|
||||
|
||||
- [Simple, fast routing engine](https://laravel.com/docs/routing).
|
||||
- [Powerful dependency injection container](https://laravel.com/docs/container).
|
||||
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
|
||||
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
|
||||
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
|
||||
- [Robust background job processing](https://laravel.com/docs/queues).
|
||||
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
|
||||
|
||||
Laravel is accessible, powerful, and provides tools required for large, robust applications.
|
||||
|
||||
## Learning Laravel
|
||||
|
||||
Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
|
||||
|
||||
You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
|
||||
|
||||
If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
|
||||
|
||||
## Laravel Sponsors
|
||||
|
||||
We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).
|
||||
|
||||
### Premium Partners
|
||||
|
||||
- **[Vehikl](https://vehikl.com)**
|
||||
- **[Tighten Co.](https://tighten.co)**
|
||||
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
|
||||
- **[64 Robots](https://64robots.com)**
|
||||
- **[Curotec](https://www.curotec.com/services/technologies/laravel)**
|
||||
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
|
||||
- **[Redberry](https://redberry.international/laravel-development)**
|
||||
- **[Active Logic](https://activelogic.com)**
|
||||
|
||||
## Contributing
|
||||
|
||||
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).
|
||||
|
||||
## Security Vulnerabilities
|
||||
|
||||
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [taylor@laravel.com](mailto:taylor@laravel.com). All security vulnerabilities will be promptly addressed.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
287
docs/endpoints.md
Normal file
287
docs/endpoints.md
Normal file
|
|
@ -0,0 +1,287 @@
|
|||
## Endpoints
|
||||
|
||||
<details>
|
||||
<summary><code>GET</code> <code><b>/data/{api_token}</b></code></summary>
|
||||
|
||||
##### Parameters
|
||||
|
||||
> | name | type | data type | description |
|
||||
> |-------------|------------|----------------|--------------------------------------------------------------|
|
||||
> | `api_token` | required | string | Api key with permission |
|
||||
|
||||
|
||||
##### Responses
|
||||
|
||||
> | http code | content-type | response |
|
||||
> |---------------|-----------------------------------|---------------------------------------------------------------------|
|
||||
> | `200` | `application/json` | json object |
|
||||
> | `401` | `application/json` | {"code": 401,"message": "Unauthorized" } |
|
||||
|
||||
|
||||
|
||||
##### Example response different keys
|
||||
|
||||
|
||||
> KEY 1
|
||||
```json
|
||||
{
|
||||
"participants": [
|
||||
{
|
||||
"id": 1,
|
||||
"lan_id": 1,
|
||||
"first_name": "John",
|
||||
"surname": "Doe",
|
||||
"grade": "8",
|
||||
"phone": null,
|
||||
"email": null,
|
||||
"guardian_name": "John Doe",
|
||||
"guardian_phone": "070123456",
|
||||
"guardian_email": "mail@mail.com",
|
||||
"is_visiting": 1,
|
||||
"friends": null,
|
||||
"special_diet": null,
|
||||
"status": "lan",
|
||||
"created_at": "2025-11-19T17:44:22.000000Z",
|
||||
"updated_at": "2025-11-19T17:47:17.000000Z"
|
||||
}
|
||||
],
|
||||
"volunteers": [
|
||||
{
|
||||
"id": 1,
|
||||
"lan_id": 300,
|
||||
"first_name": "Jane",
|
||||
"surname": "Doe",
|
||||
"phone": "070123456",
|
||||
"email": "mail@mail.com",
|
||||
"areas": [
|
||||
"Städ",
|
||||
"Kiosk"
|
||||
],
|
||||
"comment": null,
|
||||
"created_at": "2025-11-19T17:45:15.000000Z",
|
||||
"updated_at": "2025-11-19T17:48:05.000000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> KEY 2
|
||||
```json
|
||||
{
|
||||
"participants": [
|
||||
{
|
||||
"first_name": "John",
|
||||
"surname": "Doe"
|
||||
}
|
||||
],
|
||||
"volunteers": [
|
||||
{
|
||||
"first_name": "Jane",
|
||||
"surname": "Doe"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> KEY 3
|
||||
```json
|
||||
{
|
||||
"participants": [
|
||||
{
|
||||
"id": 1,
|
||||
"lan_id": 1,
|
||||
"first_name": "John",
|
||||
"surname": "Doe",
|
||||
"grade": "8",
|
||||
"phone": null,
|
||||
"email": null,
|
||||
"guardian_name": "John Doe",
|
||||
"guardian_phone": "070123456",
|
||||
"guardian_email": "mail@mail.com",
|
||||
"is_visiting": 1,
|
||||
"friends": null,
|
||||
"special_diet": null,
|
||||
"status": "lan",
|
||||
"created_at": "2025-11-19T17:44:22.000000Z",
|
||||
"updated_at": "2025-11-19T17:47:17.000000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> KEY 4
|
||||
```json
|
||||
{
|
||||
"participants": [
|
||||
{
|
||||
"first_name": "John",
|
||||
"surname": "Doe"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><code>GET</code> <code><b>/version/{api_token}</b></code></summary>
|
||||
|
||||
##### Parameters
|
||||
|
||||
> | name | type | data type | description |
|
||||
> |-------------|------------|----------------|--------------------------------------------------------------|
|
||||
> | `api_token` | required | string | Api key with permission |
|
||||
|
||||
##### Responses
|
||||
|
||||
> | http code | content-type | response |
|
||||
> |---------------|-----------------------------------|---------------------------------------------------------------------|
|
||||
> | `200` | `application/json` | json object |
|
||||
> | `401` | `application/json` | {"code": 401,"message": "Unauthorized" } |
|
||||
|
||||
|
||||
|
||||
##### Example response different keys
|
||||
|
||||
|
||||
> KEY 1
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"participants": 3,
|
||||
"volunteers": 2
|
||||
}
|
||||
```
|
||||
|
||||
> KEY 2
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"participants": 3,
|
||||
"volunteers": 2
|
||||
}
|
||||
```
|
||||
|
||||
> KEY 3
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"participants": 3
|
||||
}
|
||||
```
|
||||
|
||||
> KEY 4
|
||||
```json
|
||||
{
|
||||
"success": true,
|
||||
"participants": 3
|
||||
}
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><code>POST</code> <code><b>/participant/{api_token}</b></code></summary>
|
||||
|
||||
##### Parameters
|
||||
|
||||
> | name | type | data type | description |
|
||||
> |-------------|-----------|-------------------------|-----------------------------------------------------------------------|
|
||||
> | `api_token` | required | string | Api key with permission |
|
||||
|
||||
##### Body data
|
||||
|
||||
> | name | type | data type | description |
|
||||
> |------------------|-----------|--------------------------|-----------------------------------------------------------------------|
|
||||
> | `first_name` | required | string | Participant first name |
|
||||
> | `surame` | required | string | Participant surname |
|
||||
> | `grade` | required | string | Participant grade |
|
||||
> | `phone` | nullable | string | Participant phone number |
|
||||
> | `email` | nullable | string | Participant email |
|
||||
> | `guardian_name` | required | string | Participant guardian name |
|
||||
> | `guardian_phone` | required | string | Participant guardian phone |
|
||||
> | `guardian_email` | required | string | Participant guardian email |
|
||||
> | `is_visiting` | required | boolean | 1 = Visiting , 0 = LAN |
|
||||
> | `gdpr` | required | booelan | Participant accepts gdpr |
|
||||
> | `friends` | nullable | string | Participant want to sit with |
|
||||
> | `special_diet` | nullable | string | Participant special diet |
|
||||
|
||||
|
||||
```json
|
||||
{
|
||||
"first_name": "Joe",
|
||||
"surname": "Doe",
|
||||
"grade": "8",
|
||||
"phone": null,
|
||||
"email": null,
|
||||
"guardian_name": "Jane Doe",
|
||||
"guardian_phone": "070123456",
|
||||
"guardian_email": "email@email.com",
|
||||
"is_visiting": 1,
|
||||
"gdpr": 1,
|
||||
"friends": "Jake, James",
|
||||
"special_diet": "Laktos"
|
||||
}
|
||||
```
|
||||
>
|
||||
|
||||
|
||||
##### Responses
|
||||
|
||||
> | http code | content-type | response |
|
||||
> |---------------|-----------------------------------|---------------------------------------------------------------------|
|
||||
> | `200` | `application/json` | {"code": 200, "message": "Participant was created successfully" } |
|
||||
> | `401` | `application/json` | {"code": 401,"message": "Unauthorized" } |
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary><code>POST</code> <code><b>/volunteer/{api_token}</b></code></summary>
|
||||
|
||||
##### Parameters
|
||||
|
||||
> | name | type | data type | description |
|
||||
> |-------------|-----------|-------------------------|-----------------------------------------------------------------------|
|
||||
> | `api_token` | required | string | Api key with permission |
|
||||
|
||||
|
||||
##### Body data
|
||||
|
||||
> | name | type | data type | description |
|
||||
> |------------------|-----------|--------------------------|-----------------------------------------------------------------------|
|
||||
> | `first_name` | required | string | Volunteer first name |
|
||||
> | `surame` | required | string | Volunteer surname |
|
||||
> | `phone` | required | string | Volunteer phone number |
|
||||
> | `email` | required | string | Volunteer email |
|
||||
> | `gdpr` | required | booelan | Volunteer accepts gdpr |
|
||||
> | `areas` | required | json | Volunteer want to help put in this areas |
|
||||
|
||||
>
|
||||
```json
|
||||
{
|
||||
"first_name": "Jane",
|
||||
"surname": "Doe",
|
||||
"phone": "0700123456",
|
||||
"email": "email@email.com",
|
||||
"gdpr": 1,
|
||||
"areas": [
|
||||
"Städ", "Kiosk"
|
||||
]
|
||||
}
|
||||
```
|
||||
>
|
||||
|
||||
|
||||
##### Responses
|
||||
|
||||
> | http code | content-type | response |
|
||||
> |---------------|-----------------------------------|---------------------------------------------------------------------|
|
||||
> | `200` | `application/json` | {"code": 200, "message": "Volunteer was created successfully" } |
|
||||
> | `401` | `application/json` | {"code": 401,"message": "Unauthorized" } |
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
|
||||
10
docs/keys.md
Normal file
10
docs/keys.md
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
## API Keys
|
||||
|
||||
> | key | permissions |
|
||||
> |--------------|-----------------------------------------------------------------------|
|
||||
> | `KEY 1` | All data from Participants and Volunteers. Can post |
|
||||
> | `KEY 2` | {lan_id, first_name, surname} from table Participants and Volunteers |
|
||||
> | `KEY 3` | All data from table Participants |
|
||||
> | `KEY 4` | {lan_id, first_name, surname} from table Participants |
|
||||
|
||||
|
||||
Loading…
Reference in a new issue