fix schemas for external identities

CenterForOpenScience · Aug 16, 2018 · e9e464a · e9e464a
1 parent cbe7eb6
commit e9e464a
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 18 deletions.
diff --git a/swagger-spec/external_identities/external_identities_detail.yaml b/swagger-spec/external_identities/external_identities_detail.yaml
@@ -0,0 +1,31 @@
+type: object
+title: External Identity Detail
+properties:
+  id:
+    type: string
+    readOnly: true
+    description: 'The identifier of the external identity provider e.g. ORCID.'
+  type:
+    type: string
+    readOnly: true
+    description: 'The type identifier of the external identity entity (`external-identities`).'
+  attributes:
+    type: object
+    title: Attributes
+    readOnly: true
+    description: 'The properties of the  external identity entity.'
+    properties:
+      status:
+        type: string
+        readOnly: true
+        description: 'The status of the external identity e.g LINK or VERIFIED.'
+      external_id:
+        type: string
+        readOnly: true
+        description: 'The identifier for the user associated with that external identity.'
+  links:
+    type: object
+    title: Links
+    readOnly: true
+    description: 'URLs to alternative representations of the citation style entity.'
+
diff --git a/swagger-spec/users/external_identities_detail.yaml b/swagger-spec/users/external_identities_detail.yaml
@@ -37,7 +37,7 @@ get:
     '200':
       description: 'OK'
       schema:
-        $ref: definition.yaml
+        $ref: '../external_identities/external_identities_detail.yaml'
       examples:
         application/json:
           data:
@@ -86,19 +86,5 @@ delete:
     - Users
   operationId: external_identities_detail
   responses:
-    '200':
-      description: 'OK'
-      schema:
-        $ref: definition.yaml
-      examples:
-        application/json:
-          data:
-            links:
-              self: https://api.osf.io/v2/users/q7fts/settings/identities/ORCID/
-            attributes:
-              status: VERFIED
-              external_id: '0000-0001-9143-4652'
-              id: ORCID
-            type: users
-            id: q7fts
-
+    '204':
+      description: 'NO CONTENT'
diff --git a/swagger-spec/users/external_identities_list.yaml b/swagger-spec/users/external_identities_list.yaml
@@ -32,7 +32,9 @@ get:
     '200':
       description: 'OK'
       schema:
-        $ref: definition.yaml
+        type: array
+        items:
+          $ref: '../external_identities/external_identities_detail.yaml'
       examples:
         application/json:
           data: