Added Geoip endpoint

paths/companions/companions.yaml

@@ -1,48 +1,48 @@
-    get:
+get:
-      servers:
+  servers:
-      - url: https://plex.tv/api/v2
+    - url: 'https://plex.tv/api/v2'
-      tags:
+  tags:
-      - Plex
+    - Plex
-      summary: Get Companions Data
+  summary: Get Companions Data
-      description: Get Companions Data
+  description: Get Companions Data
-      operationId: getCompanionsData
+  operationId: getCompanionsData
-      responses:
+  responses:
-        '200':
+    '200':
-          description: Companions Data
+      description: Companions Data
-          content:
+      content:
-            application/json:
+        application/json:
-              schema:
+          schema:
-                type: array
+            type: array
-                items:
+            items:
-                  type: object
+              type: object
-                  required:
+              required:
-                    - identifier
+                - identifier
-                    - baseURL
+                - baseURL
-                    - title
+                - title
-                    - linkURL
+                - linkURL
-                    - provides
+                - provides
-                    - token
+                - token
-                  properties:
+              properties:
-                    identifier:
+                identifier:
-                      type: string
+                  type: string
-                      example: tv.plex.sonos
+                  example: tv.plex.sonos
-                    baseURL:
+                baseURL:
-                      type: string
+                  type: string
-                      example: 'https://sonos.plex.tv'
+                  example: 'https://sonos.plex.tv'
-                      format: uri
+                  format: uri
-                    title:
+                title:
-                      type: string
+                  type: string
-                      example: Sonos
+                  example: Sonos
-                    linkURL:
+                linkURL:
-                      type: string
+                  type: string
-                      example: 'https://sonos.plex.tv/link'
+                  example: 'https://sonos.plex.tv/link'
-                    provides:
+                provides:
-                      type: string
+                  type: string
-                      example: 'client,player'
+                  example: 'client,player'
-                    token:
+                token:
-                      type: string
+                  type: string
-                      description: The plex authtoken used to identify with
+                  description: The plex authtoken used to identify with
-        '400':
+    '400':
-          $ref: '../../responses/400.yaml'
+      $ref: ../../responses/400.yaml
-        '401':
+    '401':
-          $ref: '../../responses/401.yaml'
+      $ref: ../../responses/401.yaml

paths/geoip/geoip.yaml

@@ -0,0 +1,20 @@
+get:
+  servers:
+    - url: 'https://plex.tv/api/v2'
+  security: [] # No security required
+  tags:
+    - Plex
+  summary: Get Geo Data
+  description: Returns the geolocation and locale data of the caller
+  operationId: getGeoData
+  responses:
+    '200':
+      description: Gets the geo location data of the user
+      content:
+        application/json:
+          schema:
+            $ref: ./models/GeoData.yaml
+    '400':
+      $ref: ../../responses/400.yaml
+    '401':
+      $ref: ../../responses/401.yaml

pms-spec.yaml

@@ -78,11 +78,16 @@ paths:
   /devices:
     $ref: "./paths/devices.yaml"
 
-  #Companions
+  # Companions
   # Folder pms/paths/companions
   /companions:
     $ref: "paths/companions/companions.yaml"
-    
+
+  # GeoIP
+  # Folder pms/paths/geoip
+  /geoip:
+    $ref: "paths/geoip/geoip.yaml"
+
   # Plex Home
   # Folder: pms/paths/home
   /home: