Update API documentation to reflect PyP100 migration
- Updated printer (socket) API endpoints to use the new data structure - Updated job API endpoints to match the current implementation - Added documentation for new endpoints: job status, abort, finish, and extend - Updated field names to match the camelCase convention used in the backend 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
root
parent
7c1d0069c6
commit
6cdc437d3e
@ -222,18 +222,19 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
|
|
||||||
**Endpunkt:** `GET /api/printers`
|
**Endpunkt:** `GET /api/printers`
|
||||||
|
|
||||||
**Beschreibung:** Gibt eine Liste aller Drucker zurück.
|
**Beschreibung:** Gibt eine Liste aller Drucker (Steckdosen) zurück.
|
||||||
|
|
||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"name": "string",
|
"name": "string",
|
||||||
"location": "string",
|
"description": "string",
|
||||||
"type": "string",
|
"status": 0, // 0 = available, 1 = busy
|
||||||
"status": "string",
|
"latestJob": {
|
||||||
"description": "string"
|
// Job-Objekt oder null, wenn kein aktiver Job
|
||||||
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
@ -250,21 +251,19 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "string",
|
"name": "string",
|
||||||
"location": "string",
|
"description": "string",
|
||||||
"type": "string",
|
"ipAddress": "string" // IP-Adresse der Tapo-Steckdose
|
||||||
"description": "string"
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"name": "string",
|
"name": "string",
|
||||||
"location": "string",
|
"description": "string",
|
||||||
"type": "string",
|
"status": 0, // 0 = available, 1 = busy
|
||||||
"status": "available",
|
"latestJob": null
|
||||||
"description": "string"
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -277,12 +276,13 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"name": "string",
|
"name": "string",
|
||||||
"location": "string",
|
"description": "string",
|
||||||
"type": "string",
|
"status": 0, // 0 = available, 1 = busy
|
||||||
"status": "string",
|
"latestJob": {
|
||||||
"description": "string"
|
// Job-Objekt oder null, wenn kein aktiver Job
|
||||||
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -305,22 +305,22 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "string",
|
"name": "string",
|
||||||
"location": "string",
|
"description": "string",
|
||||||
"type": "string",
|
"ipAddress": "string", // IP-Adresse der Tapo-Steckdose
|
||||||
"status": "string",
|
"status": 0 // 0 = available, 1 = busy
|
||||||
"description": "string"
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"name": "string",
|
"name": "string",
|
||||||
"location": "string",
|
"description": "string",
|
||||||
"type": "string",
|
"status": 0, // 0 = available, 1 = busy
|
||||||
"status": "string",
|
"latestJob": {
|
||||||
"description": "string"
|
// Job-Objekt oder null, wenn kein aktiver Job
|
||||||
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -351,16 +351,15 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
```json
|
```json
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"title": "string",
|
"socketId": "uuid-string",
|
||||||
"start_time": "string (ISO 8601)",
|
"userId": "uuid-string",
|
||||||
"end_time": "string (ISO 8601)",
|
"startAt": "string (ISO 8601)",
|
||||||
"duration": 60,
|
"durationInMinutes": 60,
|
||||||
"status": "string",
|
|
||||||
"comments": "string",
|
"comments": "string",
|
||||||
"user_id": 1,
|
"aborted": false,
|
||||||
"printer_id": 1,
|
"abortReason": null,
|
||||||
"remaining_time": 30
|
"remainingMinutes": 30
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
@ -374,9 +373,8 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
**Request-Body:**
|
**Request-Body:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"title": "string",
|
"printerId": "uuid-string",
|
||||||
"duration": 60,
|
"durationInMinutes": 60,
|
||||||
"printer_id": 1,
|
|
||||||
"comments": "string"
|
"comments": "string"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
@ -384,16 +382,15 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"title": "string",
|
"socketId": "uuid-string",
|
||||||
"start_time": "string (ISO 8601)",
|
"userId": "uuid-string",
|
||||||
"end_time": "string (ISO 8601)",
|
"startAt": "string (ISO 8601)",
|
||||||
"duration": 60,
|
"durationInMinutes": 60,
|
||||||
"status": "active",
|
|
||||||
"comments": "string",
|
"comments": "string",
|
||||||
"user_id": 1,
|
"aborted": false,
|
||||||
"printer_id": 1,
|
"abortReason": null,
|
||||||
"remaining_time": 60
|
"remainingMinutes": 60
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -413,16 +410,15 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"title": "string",
|
"socketId": "uuid-string",
|
||||||
"start_time": "string (ISO 8601)",
|
"userId": "uuid-string",
|
||||||
"end_time": "string (ISO 8601)",
|
"startAt": "string (ISO 8601)",
|
||||||
"duration": 60,
|
"durationInMinutes": 60,
|
||||||
"status": "string",
|
|
||||||
"comments": "string",
|
"comments": "string",
|
||||||
"user_id": 1,
|
"aborted": false,
|
||||||
"printer_id": 1,
|
"abortReason": null,
|
||||||
"remaining_time": 30
|
"remainingMinutes": 30
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -433,34 +429,109 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
### Druckauftrag aktualisieren
|
### Druckauftrag Kommentare aktualisieren
|
||||||
|
|
||||||
**Endpunkt:** `PUT /api/jobs/{jobId}`
|
**Endpunkt:** `PUT /api/jobs/{jobId}/comments`
|
||||||
|
|
||||||
**Beschreibung:** Aktualisiert die Daten eines Druckauftrags.
|
**Beschreibung:** Aktualisiert die Kommentare eines Druckauftrags.
|
||||||
|
|
||||||
**Request-Body:**
|
**Request-Body:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"status": "string",
|
"comments": "string"
|
||||||
"comments": "string",
|
|
||||||
"duration": 30
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"id": 1,
|
"id": "uuid-string",
|
||||||
"title": "string",
|
"socketId": "uuid-string",
|
||||||
"start_time": "string (ISO 8601)",
|
"userId": "uuid-string",
|
||||||
"end_time": "string (ISO 8601)",
|
"startAt": "string (ISO 8601)",
|
||||||
"duration": 90,
|
"durationInMinutes": 60,
|
||||||
"status": "string",
|
|
||||||
"comments": "string",
|
"comments": "string",
|
||||||
"user_id": 1,
|
"aborted": false,
|
||||||
"printer_id": 1,
|
"abortReason": null,
|
||||||
"remaining_time": 60
|
"remainingMinutes": 30
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Druckauftrag abbrechen
|
||||||
|
|
||||||
|
**Endpunkt:** `POST /api/jobs/{jobId}/abort`
|
||||||
|
|
||||||
|
**Beschreibung:** Bricht einen laufenden Druckauftrag ab.
|
||||||
|
|
||||||
|
**Request-Body:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"reason": "string" // Optional
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Erfolgsantwort:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "uuid-string",
|
||||||
|
"socketId": "uuid-string",
|
||||||
|
"userId": "uuid-string",
|
||||||
|
"startAt": "string (ISO 8601)",
|
||||||
|
"durationInMinutes": 60,
|
||||||
|
"comments": "string",
|
||||||
|
"aborted": true,
|
||||||
|
"abortReason": "string",
|
||||||
|
"remainingMinutes": 0
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Druckauftrag vorzeitig beenden
|
||||||
|
|
||||||
|
**Endpunkt:** `POST /api/jobs/{jobId}/finish`
|
||||||
|
|
||||||
|
**Beschreibung:** Beendet einen laufenden Druckauftrag vorzeitig.
|
||||||
|
|
||||||
|
**Erfolgsantwort:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "uuid-string",
|
||||||
|
"socketId": "uuid-string",
|
||||||
|
"userId": "uuid-string",
|
||||||
|
"startAt": "string (ISO 8601)",
|
||||||
|
"durationInMinutes": 45, // Tatsächliche Dauer bis zum Beenden
|
||||||
|
"comments": "string",
|
||||||
|
"aborted": false,
|
||||||
|
"abortReason": null,
|
||||||
|
"remainingMinutes": 0
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Druckauftrag verlängern
|
||||||
|
|
||||||
|
**Endpunkt:** `POST /api/jobs/{jobId}/extend`
|
||||||
|
|
||||||
|
**Beschreibung:** Verlängert die Laufzeit eines Druckauftrags.
|
||||||
|
|
||||||
|
**Request-Body:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"minutes": 30, // Zusätzliche Minuten
|
||||||
|
"hours": 0 // Zusätzliche Stunden (optional)
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Erfolgsantwort:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"id": "uuid-string",
|
||||||
|
"socketId": "uuid-string",
|
||||||
|
"userId": "uuid-string",
|
||||||
|
"startAt": "string (ISO 8601)",
|
||||||
|
"durationInMinutes": 90, // Aktualisierte Gesamtdauer
|
||||||
|
"comments": "string",
|
||||||
|
"aborted": false,
|
||||||
|
"abortReason": null,
|
||||||
|
"remainingMinutes": 60
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
@ -486,7 +557,35 @@ Die meisten Endpunkte erfordern eine Authentifizierung. Diese erfolgt über Cook
|
|||||||
**Erfolgsantwort:**
|
**Erfolgsantwort:**
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"remaining_minutes": 30
|
"remaining_minutes": 30,
|
||||||
|
"job_status": "active", // active, completed
|
||||||
|
"socket_status": "busy" // busy, available
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### Status eines Druckauftrags abrufen
|
||||||
|
|
||||||
|
**Endpunkt:** `GET /api/job/{jobId}/status`
|
||||||
|
|
||||||
|
**Beschreibung:** Gibt detaillierte Statusinformationen zu einem Druckauftrag zurück.
|
||||||
|
|
||||||
|
**Erfolgsantwort:**
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"job": {
|
||||||
|
"id": "uuid-string",
|
||||||
|
"socketId": "uuid-string",
|
||||||
|
"userId": "uuid-string",
|
||||||
|
"startAt": "string (ISO 8601)",
|
||||||
|
"durationInMinutes": 60,
|
||||||
|
"comments": "string",
|
||||||
|
"aborted": false,
|
||||||
|
"abortReason": null,
|
||||||
|
"remainingMinutes": 30
|
||||||
|
},
|
||||||
|
"status": "active", // active, completed, aborted
|
||||||
|
"socketStatus": "busy", // busy, available
|
||||||
|
"remainingMinutes": 30
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user