diff --git a/.vscode/settings.json b/.vscode/settings.json index c69b64ff..aa720e20 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,5 +1,9 @@ { "yaml.schemas": { - "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.1/schema.json": "file:///Users/luke.hagar/Documents/GitHub/plex-api-spec/paths/root.yaml" + "https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.1/schema.json": [ + "file:///Users/luke.hagar/Documents/GitHub/plex-api-spec/paths/root.yaml", + "file:///c%3A/Users/Luke/Documents/GitHub/plex-api-spec/referenced/plex-api-spec.yaml", + "file:///c%3A/Users/Luke/Documents/GitHub/plex-api-spec/referenced/paths/resources.yaml" + ] } } diff --git a/referenced/paths/resources.yaml b/referenced/paths/plex.tv/resources.yaml similarity index 100% rename from referenced/paths/resources.yaml rename to referenced/paths/plex.tv/resources.yaml diff --git a/referenced/paths/user.yaml b/referenced/paths/plex.tv/user.yaml similarity index 100% rename from referenced/paths/user.yaml rename to referenced/paths/plex.tv/user.yaml diff --git a/referenced/paths/activities-cancel.yaml b/referenced/paths/pms/activities-cancel.yaml similarity index 100% rename from referenced/paths/activities-cancel.yaml rename to referenced/paths/pms/activities-cancel.yaml diff --git a/referenced/paths/activities.yaml b/referenced/paths/pms/activities.yaml similarity index 100% rename from referenced/paths/activities.yaml rename to referenced/paths/pms/activities.yaml diff --git a/referenced/paths/all-libraries.yaml b/referenced/paths/pms/all-libraries.yaml similarity index 100% rename from referenced/paths/all-libraries.yaml rename to referenced/paths/pms/all-libraries.yaml diff --git a/referenced/paths/all-playlists.yaml b/referenced/paths/pms/all-playlists.yaml similarity index 100% rename from referenced/paths/all-playlists.yaml rename to referenced/paths/pms/all-playlists.yaml diff --git a/referenced/paths/butler-task.yaml b/referenced/paths/pms/butler-task.yaml similarity index 100% rename from referenced/paths/butler-task.yaml rename to referenced/paths/pms/butler-task.yaml diff --git a/referenced/paths/butler.yaml b/referenced/paths/pms/butler.yaml similarity index 100% rename from referenced/paths/butler.yaml rename to referenced/paths/pms/butler.yaml diff --git a/referenced/paths/clients.yaml b/referenced/paths/pms/clients.yaml similarity index 83% rename from referenced/paths/clients.yaml rename to referenced/paths/pms/clients.yaml index 61c06d85..6fe84549 100644 --- a/referenced/paths/clients.yaml +++ b/referenced/paths/pms/clients.yaml @@ -4,15 +4,6 @@ get: summary: Get Available Clients description: Get Available Clients operationId: getAvailableClients - parameters: - - $ref: "../parameters/X-Plex-Client-Identifier.yaml" - - $ref: "../parameters/X-Plex-Device-Name.yaml" - - $ref: "../parameters/X-Plex-Device.yaml" - - $ref: "../parameters/X-Plex-Platform-Version.yaml" - - $ref: "../parameters/X-Plex-Platform.yaml" - - $ref: "../parameters/X-Plex-Product.yaml" - - $ref: "../parameters/X-Plex-Provides.yaml" - - $ref: "../parameters/X-Plex-Version.yaml" responses: "200": description: Available Clients diff --git a/referenced/paths/hubs-search-voice.yaml b/referenced/paths/pms/hubs-search-voice.yaml similarity index 100% rename from referenced/paths/hubs-search-voice.yaml rename to referenced/paths/pms/hubs-search-voice.yaml diff --git a/referenced/paths/hubs-search.yaml b/referenced/paths/pms/hubs-search.yaml similarity index 100% rename from referenced/paths/hubs-search.yaml rename to referenced/paths/pms/hubs-search.yaml diff --git a/referenced/paths/hubs-section.yaml b/referenced/paths/pms/hubs-section.yaml similarity index 100% rename from referenced/paths/hubs-section.yaml rename to referenced/paths/pms/hubs-section.yaml diff --git a/referenced/paths/hubs.yaml b/referenced/paths/pms/hubs.yaml similarity index 100% rename from referenced/paths/hubs.yaml rename to referenced/paths/pms/hubs.yaml diff --git a/referenced/paths/library-content-all.yaml b/referenced/paths/pms/library-content-all.yaml similarity index 100% rename from referenced/paths/library-content-all.yaml rename to referenced/paths/pms/library-content-all.yaml diff --git a/referenced/paths/library-content-common.yaml b/referenced/paths/pms/library-content-common.yaml similarity index 100% rename from referenced/paths/library-content-common.yaml rename to referenced/paths/pms/library-content-common.yaml diff --git a/referenced/paths/library-content-latest.yaml b/referenced/paths/pms/library-content-latest.yaml similarity index 100% rename from referenced/paths/library-content-latest.yaml rename to referenced/paths/pms/library-content-latest.yaml diff --git a/referenced/paths/library-details.yaml b/referenced/paths/pms/library-details.yaml similarity index 100% rename from referenced/paths/library-details.yaml rename to referenced/paths/pms/library-details.yaml diff --git a/referenced/paths/library-hashes.yaml b/referenced/paths/pms/library-hashes.yaml similarity index 97% rename from referenced/paths/library-hashes.yaml rename to referenced/paths/pms/library-hashes.yaml index 1261e78a..cc1b8839 100644 --- a/referenced/paths/library-hashes.yaml +++ b/referenced/paths/pms/library-hashes.yaml @@ -7,7 +7,7 @@ get: parameters: - name: url description: This is the path to the local file, must be prefixed by `file://` - in: path + in: query schema: type: string example: file://C:\Image.png&type=13 diff --git a/referenced/paths/library-ondeck.yaml b/referenced/paths/pms/library-ondeck.yaml similarity index 100% rename from referenced/paths/library-ondeck.yaml rename to referenced/paths/pms/library-ondeck.yaml diff --git a/referenced/paths/library-refresh.yaml b/referenced/paths/pms/library-refresh.yaml similarity index 100% rename from referenced/paths/library-refresh.yaml rename to referenced/paths/pms/library-refresh.yaml diff --git a/referenced/paths/log-networked.yaml b/referenced/paths/pms/log-networked.yaml similarity index 100% rename from referenced/paths/log-networked.yaml rename to referenced/paths/pms/log-networked.yaml diff --git a/referenced/paths/log.yaml b/referenced/paths/pms/log.yaml similarity index 100% rename from referenced/paths/log.yaml rename to referenced/paths/pms/log.yaml diff --git a/referenced/paths/playlist-contents.yaml b/referenced/paths/pms/playlist-contents.yaml similarity index 100% rename from referenced/paths/playlist-contents.yaml rename to referenced/paths/pms/playlist-contents.yaml diff --git a/referenced/paths/playlist-id.yaml b/referenced/paths/pms/playlist-id.yaml similarity index 100% rename from referenced/paths/playlist-id.yaml rename to referenced/paths/pms/playlist-id.yaml diff --git a/referenced/paths/playlist-upload.yaml b/referenced/paths/pms/playlist-upload.yaml similarity index 100% rename from referenced/paths/playlist-upload.yaml rename to referenced/paths/pms/playlist-upload.yaml diff --git a/referenced/paths/playlists.yaml b/referenced/paths/pms/playlists.yaml similarity index 100% rename from referenced/paths/playlists.yaml rename to referenced/paths/pms/playlists.yaml diff --git a/referenced/paths/root.yaml b/referenced/paths/pms/root.yaml similarity index 100% rename from referenced/paths/root.yaml rename to referenced/paths/pms/root.yaml diff --git a/referenced/paths/security-resources.yaml b/referenced/paths/pms/security-resources.yaml similarity index 100% rename from referenced/paths/security-resources.yaml rename to referenced/paths/pms/security-resources.yaml diff --git a/referenced/paths/security-token.yaml b/referenced/paths/pms/security-token.yaml similarity index 100% rename from referenced/paths/security-token.yaml rename to referenced/paths/pms/security-token.yaml diff --git a/referenced/paths/server-preferences.yaml b/referenced/paths/pms/server-preferences.yaml similarity index 100% rename from referenced/paths/server-preferences.yaml rename to referenced/paths/pms/server-preferences.yaml diff --git a/referenced/paths/session-history.yaml b/referenced/paths/pms/session-history.yaml similarity index 100% rename from referenced/paths/session-history.yaml rename to referenced/paths/pms/session-history.yaml diff --git a/referenced/paths/sessions.yaml b/referenced/paths/pms/sessions.yaml similarity index 100% rename from referenced/paths/sessions.yaml rename to referenced/paths/pms/sessions.yaml diff --git a/referenced/paths/updater-apply.yaml b/referenced/paths/pms/updater-apply.yaml similarity index 100% rename from referenced/paths/updater-apply.yaml rename to referenced/paths/pms/updater-apply.yaml diff --git a/referenced/paths/updater-check.yaml b/referenced/paths/pms/updater-check.yaml similarity index 100% rename from referenced/paths/updater-check.yaml rename to referenced/paths/pms/updater-check.yaml diff --git a/referenced/paths/updater-status.yaml b/referenced/paths/pms/updater-status.yaml similarity index 100% rename from referenced/paths/updater-status.yaml rename to referenced/paths/pms/updater-status.yaml diff --git a/referenced/plex-api-spec.yaml b/referenced/plex-api-spec.yaml index 06477dda..c3cf26ce 100644 --- a/referenced/plex-api-spec.yaml +++ b/referenced/plex-api-spec.yaml @@ -9,9 +9,13 @@ info: name: Luke Hagar email: Lukeslakemail@gmail.com url: "https://www.LukeHagar.com" + license: + name: MIT + url: https://opensource.org/licenses/MIT + servers: - - url: "{Protocol}://{Local IP}:{Port}" + - url: '{Protocol}://{Local IP}:{Port}' variables: Protocol: enum: @@ -38,79 +42,79 @@ components: paths: /clients: - $ref: "./paths/clients.yaml" + $ref: "./paths/pms/clients.yaml" /: - $ref: "./paths/root.yaml" + $ref: "./paths/pms/root.yaml" /activities: - $ref: "./paths/activities.yaml" + $ref: "./paths/pms/activities.yaml" /activities/{activityUUID}: - $ref: "./paths/activities-cancel.yaml" + $ref: "./paths/pms/activities-cancel.yaml" /updater/status: - $ref: "./paths/updater-status.yaml" + $ref: "./paths/pms/updater-status.yaml" /updater/check: - $ref: "./paths/updater-check.yaml" + $ref: "./paths/pms/updater-check.yaml" /updater/apply: - $ref: "./paths/updater-apply.yaml" + $ref: "./paths/pms/updater-apply.yaml" /butler: - $ref: "./paths/butler.yaml" + $ref: "./paths/pms/butler.yaml" /butler/{taskName}: - $ref: "./paths/butler-task.yaml" + $ref: "./paths/pms/butler-task.yaml" /log: - $ref: "./paths/log.yaml" + $ref: "./paths/pms/log.yaml" /log/networked: - $ref: "./paths/log-networked.yaml" + $ref: "./paths/pms/log-networked.yaml" /security/token: - $ref: "./paths/security-token.yaml" + $ref: "./paths/pms/security-token.yaml" /security/resources: - $ref: "./paths/security-resources.yaml" + $ref: "./paths/pms/security-resources.yaml" /library/sections/{sectionId}/all: - $ref: "./paths/library-content-all.yaml" + $ref: "./paths/pms/library-content-all.yaml" /library/sections/{sectionId}/refresh: - $ref: "./paths/library-refresh.yaml" + $ref: "./paths/pms/library-refresh.yaml" /library/sections/{sectionId}/latest: - $ref: "./paths/library-content-latest.yaml" + $ref: "./paths/pms/library-content-latest.yaml" /library/sections/{sectionId}/common: - $ref: "./paths/library-content-common.yaml" + $ref: "./paths/pms/library-content-common.yaml" /library/sections/{sectionId}: - $ref: "./paths/library-details.yaml" + $ref: "./paths/pms/library-details.yaml" /library/sections: - $ref: "./paths/all-libraries.yaml" + $ref: "./paths/pms/all-libraries.yaml" /library/hashes: - $ref: "./paths/library-hashes.yaml" + $ref: "./paths/pms/library-hashes.yaml" /library/onDeck: - $ref: "./paths/library-ondeck.yaml" + $ref: "./paths/pms/library-ondeck.yaml" /hubs: - $ref: "./paths/hubs.yaml" + $ref: "./paths/pms/hubs.yaml" /hubs/sections/{sectionId}: - $ref: "./paths/hubs-section.yaml" + $ref: "./paths/pms/hubs-section.yaml" /playlists/all: - $ref: "./paths/all-playlists.yaml" + $ref: "./paths/pms/all-playlists.yaml" /playlists: - $ref: "./paths/playlists.yaml" + $ref: "./paths/pms/playlists.yaml" /playlists/{playlistID}: - $ref: "./paths/playlist-id.yaml" + $ref: "./paths/pms/playlist-id.yaml" /playlists/{playlistID}/items: - $ref: "./paths/playlist-contents.yaml" + $ref: "./paths/pms/playlist-contents.yaml" /playlists/upload: - $ref: "./paths/playlist-upload.yaml" + $ref: "./paths/pms/playlist-upload.yaml" /hubs/search: - $ref: "./paths/hubs-search.yaml" + $ref: "./paths/pms/hubs-search.yaml" /hubs/search/voice: - $ref: "./paths/hubs-search-voice.yaml" + $ref: "./paths/pms/hubs-search-voice.yaml" /user: servers: - url: https://plex.tv/api/v2 - $ref: "./paths/user.yaml" + $ref: "./paths/plex.tv/user.yaml" /resources: servers: - url: https://plex.tv/api/v2 - $ref: "./paths/resources.yaml" + $ref: "./paths/plex.tv/resources.yaml" /status/sessions: - $ref: "./paths/sessions.yaml" + $ref: "./paths/pms/sessions.yaml" /status/sessions/history/all: - $ref: "./paths/session-history.yaml" + $ref: "./paths/pms/session-history.yaml" /:/prefs: - $ref: "./paths/server-preferences.yaml" + $ref: "./paths/pms/server-preferences.yaml" tags: - name: Activities