-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added more details about the update to v1.1.0
- Loading branch information
1 parent
792dc7c
commit 99e0cf0
Showing
1 changed file
with
8 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,11 @@ info: | |
An API service for scanning malicious emails and providing reports on malicious actors, their targets, and link domains that are used. | ||
Notes: It is common for users to have email aliases, e.g. [email protected] could have an alias of [email protected]. For the purposes of this assignment we will treat these as separate email addresses and not the same. | ||
Updates in v1.1.0: | ||
- GET /customer/{customer_id}/emails description updated. | ||
- GET /customer/{customer_id}/emails limit and offset parameters defaults described. | ||
contact: | ||
name: CSSE6400 | ||
url: https://csse6400.uqcloud.net | ||
|
@@ -50,7 +55,7 @@ paths: | |
All other parameters are used to filter the results and should be applied before the limit and offset parameters. e.g. if 300 emails exists and 200 are labelled as malicious then a request of limit=100 and only_malicious=true should return 100 emails. If limit=100, only_malicious=true, and offset=200 then the response should be 0 emails (an empty array). | ||
The filters are additive and as such if the filter is not in the request then it should not be applied. e.g. if only_malicious=true is not in the request then all emails should be returned regardless of their malicious status. The exception to this is the limit and offset parameters which have defaults which are applied if they are not in the request. | ||
<span style="color:red">**The filters are additive and as such if the filter is not in the request then it should not be applied. e.g. if only_malicious=true is not in the request then all emails should be returned regardless of their malicious status. The exception to this is the limit and offset parameters which have defaults which are applied if they are not in the request.**</span> | ||
parameters: | ||
- name: customer_id | ||
in: path | ||
|
@@ -60,7 +65,7 @@ paths: | |
type: string | ||
- name: limit | ||
in: query | ||
description: Returns only this many results, 0 < limit <= 1000. Default is 100. | ||
description: Returns only this many results, 0 < limit <= 1000. <span style="color:red">**Default is 100**</span>. | ||
schema: | ||
type: integer | ||
minimum: 1 | ||
|
@@ -69,7 +74,7 @@ paths: | |
example: 20 | ||
- name: offset | ||
in: query | ||
description: Skip this many results before returning, 0 <= offset. Default is 0. | ||
description: Skip this many results before returning, 0 <= offset. <span style="color:red">**Default is 0**</span>. | ||
schema: | ||
type: integer | ||
minimum: 0 | ||
|