Address code review feedback

Author: toddkazakov

reference/auth.v1.yaml

@@ -692,7 +692,7 @@ paths:
               schema:
                 $ref: ./auth/models/consent/consents.v1.yaml
       operationId: ListConsents
-      description: Retrieves the list of all different consent types and their content. By default returns only the latest version for each consent type. This can be override by setting the `version` query parameter to `all`
+      description: Retrieves the list of all different consent types and their content. By default returns only the latest version for each consent type. This can be overriden by setting the `version` query parameter to `all`
       requestBody:
         content: {}
       parameters:
@@ -706,13 +706,9 @@ paths:
           name: version
           description: Whether to return all versions or only the most recent one.
     parameters: []
-  '/v1/consents/{type}':
+  '/v1/consents/{consentType}':
     parameters:
-      - schema:
-          type: string
-        name: type
-        in: path
-        required: true
+      - $ref: '#/components/parameters/consentType'
     get:
       summary: Get Latest Consent By Type
       tags: []
@@ -725,13 +721,9 @@ paths:
                 $ref: ./auth/models/consent/consent.v1.yaml
       operationId: GetLatestConsentByType
       description: Returns the latest consent version for the given type
-  '/v1/consent/{type}/versions':
+  '/v1/consent/{consentType}/versions':
     parameters:
-      - schema:
-          type: string
-        name: type
-        in: path
-        required: true
+      - $ref: '#/components/parameters/consentType'
     get:
       summary: Get Consent Versions
       tags: []
@@ -742,15 +734,11 @@ paths:
             application/json:
               schema:
                 $ref: ./auth/models/consent/consents.v1.yaml
-      operationId: GetConentVersions
+      operationId: GetConsentVersions
       description: Returns a list of all consent versions for a given type
   '/v1/users/{userId}/consents':
     parameters:
-      - schema:
-          type: string
-        name: userId
-        in: path
-        required: true
+      - $ref: '#/components/parameters/userId'
     get:
       summary: Get User Consent Records
       tags: []
@@ -795,11 +783,7 @@ paths:
               $ref: ./auth/models/consent/recordcreate.v1.yaml
   '/v1/users/{userId}/consents/{recordId}':
     parameters:
-      - schema:
-          type: string
-        name: userId
-        in: path
-        required: true
+      - $ref: '#/components/parameters/userId'
       - schema:
           type: string
         name: recordId
@@ -818,7 +802,7 @@ paths:
       operationId: GetUserConsentRecord
       description: Retrieves a consent record by ID for a given user.
     patch:
-      summary: ''
+      summary: Update User Consent Record
       operationId: UpdateUserConsentRecord
       responses:
         '200':
@@ -833,6 +817,13 @@ paths:
           application/json:
             schema:
               $ref: ./auth/models/consent/recordupdate.v1.yaml
+    delete:
+      summary: ''
+      operationId: RevokeConsent
+      responses:
+        '200':
+          description: OK
+      description: Revokes a consent record
 components:
   securitySchemes:
     basicAuth:
@@ -1094,3 +1085,16 @@ components:
                 required:
                   - code
                   - reason
+  parameters:
+    consentType:
+      name: consentType
+      in: path
+      required: true
+      schema:
+        $ref: ./auth/models/consent/type.v1.yaml
+    userId:
+      name: userId
+      in: path
+      required: true
+      schema:
+        $ref: ./common/models/tidepooluserid.yaml

reference/auth/models/consent/consent.v1.yaml

@@ -3,8 +3,7 @@ description: Consent
 type: object
 properties:
   type:
-    description: Test
-    type: string
+    $ref: ./type.v1.yaml
   version:
     type: integer
     example: 1

reference/auth/models/consent/consentrecord.v1.yaml

@@ -7,6 +7,7 @@ properties:
     x-stoplight:
       id: iepviv3jm8m9m
     type: array
+    uniqueItems: true
     items:
       $ref: ./consent.v1.yaml
       x-stoplight:

reference/auth/models/consent/consents.v1.yaml

@@ -0,0 +1,24 @@
+title: metadata.tbddp.v1
+x-stoplight:
+  id: 95q0hhj045suc
+type: object
+properties:
+  supportedOrganizations:
+    type: array
+    uniqueItems: true
+    description: >-
+      The list of supported organizations when the consent grant is for the
+      Tidepool Big Data Donation Project
+    items:
+      x-stoplight:
+        id: whfmccxwfj7zx
+      type: string
+      enum:
+        - ADCES Foundation
+        - Beyond Type 1
+        - Children With Diabetes
+        - The Diabetes Link
+        - Diabetes Youth Families (DYF)
+        - DiabetesSisters
+        - The diaTribe Foundation
+        - Breakthrough T1D

reference/auth/models/consent/metadata.tbddp.v1.yaml

@@ -1,22 +1,5 @@
 title: metadata.v1
 x-stoplight:
   id: 8ctwq6xjg496g
-type: object
-properties:
-  supportedOrganizations:
-    type: array
-    uniqueItems: true
-    description: The list of supported organizations when the consent grant is for the Tidepool Big Data Donation Project
-    items:
-      x-stoplight:
-        id: iew30v83r2ce5
-      type: string
-      enum:
-        - ADCES Foundation
-        - Beyond Type 1
-        - Children With Diabetes
-        - The Diabetes Link
-        - Diabetes Youth Families (DYF)
-        - DiabetesSisters
-        - The diaTribe Foundation
-        - Breakthrough T1D
+oneOf:
+  - $ref: ./metadata.tbddp.v1.yaml

reference/auth/models/consent/metadata.v1.yaml

@@ -15,12 +15,39 @@ properties:
       - active
       - revoked
     readOnly: true
-  type:
+  ageGroup:
+    type: string
+    x-stoplight:
+      id: u5whtndrytunl
+    enum:
+      - <12
+      - 13-17
+      - 18+
+  ownerName:
+    type: string
+    x-stoplight:
+      id: 2cw4335ateapa
+    description: The name of the account owner
+  parentGuardianName:
+    type: string
+    x-stoplight:
+      id: 94pqubqvzwigs
+    description: The name of the parent or legal guardian granting the consent. Required if ageGroup is '<12' or '13-17'.
+  grantorType:
     type: string
+    x-stoplight:
+      id: zc8e4q8t37yig
+    enum:
+      - owner
+      - parent/guardian
+  type:
+    $ref: ./type.v1.yaml
     x-stoplight:
       id: jub0w6n4sx03g
-    minLength: 1
-    maxLength: 100
+  metadata:
+    $ref: ./metadata.v1.yaml
+    x-stoplight:
+      id: u4fzjwa9iivzp
   version:
     type: integer
     x-stoplight:
@@ -50,13 +77,12 @@ properties:
       id: ohlc8mndn74ov
     format: date-time
     readOnly: true
-  metadata:
-    $ref: ./metadata.v1.yaml
-    x-stoplight:
-      id: u4fzjwa9iivzp
 required:
   - id
   - status
+  - ageGroup
+  - ownerName
+  - grantorType
   - type
   - version
   - grantTime

reference/auth/models/consent/record.v1.yaml

@@ -7,6 +7,7 @@ properties:
     type: array
     x-stoplight:
       id: whbezmg3q7pxh
+    uniqueItems: true
     items:
       $ref: ./record.v1.yaml
       x-stoplight:

reference/auth/models/consent/records.v1.yaml

@@ -3,11 +3,9 @@ x-stoplight:
   id: c8oq1dn4m4uak
 type: object
 properties:
-  status:
-    type: string
+  metadata:
+    $ref: ./metadata.v1.yaml
     x-stoplight:
       id: 2hnhmpwbyck12
-    enum:
-      - revoked
 required:
-  - status
+  - metadata

reference/auth/models/consent/recordupdate.v1.yaml

@@ -0,0 +1,6 @@
+title: Consent Type
+x-stoplight:
+  id: r396s741z1sca
+type: string
+pattern: '^[a-z0-9_-]{3,64}$'
+example: big_data_donation_project