Skip to content

Commit 7232a11

Browse files
kschelonkaVinnl
andauthored
Apply suggestions from code review
Update breachID type, fix examples, update description wording Co-authored-by: Vincent <Vinnl@users.noreply.github.com>
1 parent 32f215d commit 7232a11

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

openapi.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ components:
3535
properties:
3636
id:
3737
description: A unique identifier for the breach
38-
type: integer
38+
type: string
3939
domain:
4040
description: The domain of the primary website the breach occurred on. This may be used for identifying other assets external systems may have for the site.
4141
type: string
@@ -123,7 +123,7 @@ paths:
123123
in: query
124124
required: false
125125
description: >
126-
Filter breaches to those whose breach.dataClasses includes any of the specified values.
126+
Filter breaches to those whose breach.dataClasses includes any (but not necessarily all) of the specified values.
127127
Matching is performed at the breach level (not per monitored email).
128128
schema:
129129
type: array
@@ -360,7 +360,7 @@ paths:
360360
type: string
361361
resolved:
362362
type: boolean
363-
description: True to mark resolved; false to mark unresolved (undo).
363+
description: True to mark resolved; false to mark unresolved.
364364
examples:
365365
resolveMultipleBreaches:
366366
summary: Resolve multiple breaches
@@ -380,7 +380,7 @@ paths:
380380
breachId: 123
381381
resolved: true
382382
undoPasswordsAllEmailsInBreach:
383-
summary: Undo Passwords resolution for all affected emails in multiple breaches
383+
summary: Unresolve Passwords resolution for all affected emails in multiple breaches
384384
value:
385385
- dataClasses: ["passwords"]
386386
resolved: false

0 commit comments

Comments
 (0)