groove/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-07-12 12:21:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update: bundled spec

Browse source
This commit is contained in:
Nicholas Wallace 2024-06-23 18:27:27 +00:00
parent 820f8a9d2a
commit ef79dfbb3f
1 changed files with 35 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

59
docs/openapi.json
View file

@ -430,9 +430,14 @@
"content": { "content": {
"application/json": { "application/json": {
"schema": { "schema": {
"type": "array", "type": "object",
"items": { "properties": {
"$ref": "#/components/schemas/library" "libraries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/library"
}
}
} }
} }
} }
@ -1109,9 +1114,15 @@
"application/json": { "application/json": {
"schema": { "schema": {
"type": "object", "type": "object",
"required": [
"eventName",
"urls",
"titleTemplate",
"bodyTemplate"
],
"properties": { "properties": {
"libraryId": { "libraryId": {
"$ref": "#/components/schemas/libraryId" "$ref": "#/components/schemas/libraryIdNullable"
}, },
"eventName": { "eventName": {
"$ref": "#/components/schemas/notificationEventName" "$ref": "#/components/schemas/notificationEventName"
@ -1131,13 +1142,7 @@
"type": { "type": {
"$ref": "#/components/schemas/notificationType" "$ref": "#/components/schemas/notificationType"
} }
}, }
"required": [
"eventName",
"urls",
"titleTemplate",
"bodyTemplate"
]
} }
} }
} }
@ -1263,8 +1268,8 @@
} }
}, },
"patch": { "patch": {
"operationId": "createNotification", "operationId": "updateNotification",
"description": "Update Notification settings.", "description": "Update individual Notification",
"tags": [ "tags": [
"Notification" "Notification"
], ],
@ -1274,9 +1279,6 @@
"schema": { "schema": {
"type": "object", "type": "object",
"properties": { "properties": {
"id": {
"$ref": "#/components/schemas/notificationId"
},
"libraryId": { "libraryId": {
"$ref": "#/components/schemas/libraryId" "$ref": "#/components/schemas/libraryId"
}, },
@ -1298,10 +1300,7 @@
"type": { "type": {
"$ref": "#/components/schemas/notificationType" "$ref": "#/components/schemas/notificationType"
} }
}, }
"required": [
"id"
]
} }
} }
} }
@ -2196,7 +2195,12 @@
"$ref": "#/components/schemas/libraryItemBase" "$ref": "#/components/schemas/libraryItemBase"
}, },
{ {
"$ref": "#/components/schemas/sequence" "type": "object",
"properties": {
"sequence": {
"$ref": "#/components/schemas/sequence"
}
}
} }
] ]
}, },
@ -2363,14 +2367,20 @@
"notificationId": { "notificationId": {
"type": "string", "type": "string",
"description": "The ID of the notification.", "description": "The ID of the notification.",
"format": "uuid", "example": "notification-settings"
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
}, },
"appriseApiUrl": { "appriseApiUrl": {
"type": "string", "type": "string",
"nullable": true, "nullable": true,
"description": "The full URL where the Apprise API to use is located." "description": "The full URL where the Apprise API to use is located."
}, },
"libraryIdNullable": {
"type": "string",
"description": "The ID of the library. Applies to all libraries if `null`.",
"format": "uuid",
"nullable": true,
"example": "e4bb1afb-4a4f-4dd6-8be0-e615d233185b"
},
"notificationEventName": { "notificationEventName": {
"type": "string", "type": "string",
"description": "The name of the event the notification will fire on.", "description": "The name of the event the notification will fire on.",
@ -2410,6 +2420,7 @@
"warning", "warning",
"failure" "failure"
], ],
"nullable": true,
"default": "info", "default": "info",
"description": "The notification's type." "description": "The notification's type."
}, },
@ -2420,7 +2431,7 @@
"$ref": "#/components/schemas/notificationId" "$ref": "#/components/schemas/notificationId"
}, },
"libraryId": { "libraryId": {
"$ref": "#/components/schemas/libraryId" "$ref": "#/components/schemas/libraryIdNullable"
}, },
"eventName": { "eventName": {
"$ref": "#/components/schemas/notificationEventName" "$ref": "#/components/schemas/notificationEventName"