paulj/hpr_documentation
1
0
Fork 0
forked from HPR/hpr_documentation
Code Pull Requests Activity

2024-12-22_17-13-13Z_Sunday

Browse Source
This commit is contained in:
Ken Fallon
2024-12-22 18:13:13 +01:00
parent f9308d2784
commit 239ffa42a4
1 changed files with 28 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
workflow/uploading_a_show.md
View File

@@ -96,7 +96,7 @@ sequenceDiagram
```
> If an error occurs one of the following error codes will be returned.
### request_confirm.php Errors
### Possible request_confirm.php errors
| 412 Error Code | Check |
| --- | ------ |
@@ -146,14 +146,14 @@ sequenceDiagram
# Sequence Diagram uploading a show
[`upload.php`](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload.php)
[`upload_confirm.php`](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload_confirm.php)
`email`
> The Hosts clicks the link to upload the show
[`upload.php`](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload.php)
```mermaid
sequenceDiagram
host->>HPR: Host clicks on link from email
HPR->>DB: Set status to EMAIL_LINK_CLICKED
loop Preform Checks
alt If check fails
HPR->>HPR: Log Error
@@ -163,6 +163,23 @@ sequenceDiagram
HPR->>host: Upload Webform
```
### Possible upload.php errors
| 412 Error Code | Check |
| --- | ------ |
| 9a77e4ab24410cbf68a3a05ba97221e4 | Wrong method used |
| e8ac90fc2a8996e5fb7a83e73e636e80 | The format of the key is invalid |
| 91432866e3c9c36a9c4884345d578761 | Could not find reservation in the Database |
| b019bd29c1fe5b756e4b620a5428f730 | The Database entry is missing fields |
| 35a7f4e80ecba8284049e9d6261ae523 | Can't Delete entry from Database |
| 066c518314f0d3b1ad3e4af60fcf36ce | Unable to remove temporary lock |
| 5cb513b590ab5859bf7603b79402a5cb | Could not find Host in Database |
# Upload
> The Host fills out the
[`upload_confirm.php`](https://repo.anhonesthost.net/HPR/hpr_hub/src/branch/main/hub/upload_confirm.php)
```mermaid
@@ -180,17 +197,7 @@ sequenceDiagram
end
```
| 412 Error Code | Check |
| --- | ------ |
| 9a77e4ab24410cbf68a3a05ba97221e4 | Wrong method used |
| e8ac90fc2a8996e5fb7a83e73e636e80 | The format of the key is invalid |
| 91432866e3c9c36a9c4884345d578761 | Could not find reservation in the Database |
| b019bd29c1fe5b756e4b620a5428f730 | The Database entry is missing fields |
| 35a7f4e80ecba8284049e9d6261ae523 | Can't Delete entry from Database |
| 066c518314f0d3b1ad3e4af60fcf36ce | Unable to remove temporary lock |
| 5cb513b590ab5859bf7603b79402a5cb | Could not find Host in Database |
### Possible upload_confirm.php errors
| 412 Error Code | Check |
| --- | ------ |
@@ -233,3 +240,9 @@ end
| 3eb02d6b9ea801d4c5909b4fac0ccd96 | The shownotes.json is missing after write |
| c1381f1d2492f81074d8cb70c85f5fc8 | The host photo, has too long type |
| 76ec33229ca023336a2b1c649b0491f5 | Could not update Database |
# Upload Confirmation Email
> The Host receives an email telling them that their show has been successfully uploaded.
![The email containing the confirmation](email_confirmation_of_upload.png)