Skip to content

Commit ccd88b5

Browse files
committed
Updated API from documentation release
1 parent 191aae5 commit ccd88b5

File tree

6 files changed

+71
-0
lines changed

6 files changed

+71
-0
lines changed

api-specs/connect/api.raml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,11 @@ resourceTypes: !include types/ResourceTypes.raml
174174
type: deploymentLogs
175175
get:
176176
displayName: Query logs from Deployment by id
177+
description: |
178+
Specific Error Codes:
179+
- [DeploymentApplicationDoesNotExist](ctp:connect:type:DeploymentApplicationDoesNotExistError)
180+
- [DeploymentLogInvalidDate](ctp:connect:type:DeploymentLogInvalidDateError)
181+
- [DeploymentLogInvalidPageToken](ctp:connect:type:DeploymentLogInvalidPageTokenError)
177182
/key={key}:
178183
(annotations.methodName): withKey
179184
type:
@@ -184,6 +189,11 @@ resourceTypes: !include types/ResourceTypes.raml
184189
type: deploymentLogs
185190
get:
186191
displayName: Query logs from Deployment by key
192+
description: |
193+
Specific Error Codes:
194+
- [DeploymentApplicationDoesNotExist](ctp:connect:type:DeploymentApplicationDoesNotExistError)
195+
- [DeploymentLogInvalidDate](ctp:connect:type:DeploymentLogInvalidDateError)
196+
- [DeploymentLogInvalidPageToken](ctp:connect:type:DeploymentLogInvalidPageTokenError)
187197
/connectors:
188198
/{ID}:
189199
(annotations.methodName): withId
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): error
3+
type: ErrorObject
4+
displayName: DeploymentApplicationDoesNotExistError
5+
discriminatorValue: DeploymentApplicationDoesNotExist
6+
description: |
7+
Returned when trying to get a log by application name, and the application does not exist on the Connector.
8+
properties:
9+
code:
10+
type: string
11+
message:
12+
type: string
13+
description: |
14+
`"Deployment does not have an application named $resourceName."`
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): error
3+
type: ErrorObject
4+
displayName: DeploymentLogInvalidDateError
5+
discriminatorValue: DeploymentLogInvalidDate
6+
description: |
7+
Returned when trying to get a log with invalid start date or end date.
8+
properties:
9+
code:
10+
type: string
11+
message:
12+
type: string
13+
description: |
14+
`"Invalid start/end date"`
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): error
3+
type: ErrorObject
4+
displayName: DeploymentLogInvalidPageTokenError
5+
discriminatorValue: DeploymentLogInvalidPageToken
6+
description: |
7+
Returned when trying to get a log with invalid page token.
8+
properties:
9+
code:
10+
type: string
11+
message:
12+
type: string
13+
description: |
14+
`"Invalid page token: $pageToken"`
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#%RAML 1.0 DataType
2+
(annotations.package): error
3+
type: ErrorObject
4+
displayName: DeploymentLogMissingApplicationNameError
5+
discriminatorValue: DeploymentLogMissingApplicationName
6+
description: |
7+
Returned when trying to get a log from an AWS deployment and an application name was not provided.
8+
properties:
9+
code:
10+
type: string
11+
message:
12+
type: string
13+
description: |
14+
`"Missing application name when fetching deployment logs"`

api-specs/connect/types/types.raml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,3 +73,8 @@ DeploymentMissingGlobalConfigurationKeyError: !include error/DeploymentMissingGl
7373
DeploymentEmptyRequiredGlobalConfigurationKeyError: !include error/DeploymentEmptyRequiredGlobalConfigurationKeyError.raml
7474
DeploymentInvalidTypeError: !include error/DeploymentInvalidTypeError.raml
7575
DeploymentProductionDeactivatedError: !include error/DeploymentProductionDeactivatedError.raml
76+
# Deployments Log Errors
77+
DeploymentApplicationDoesNotExistError: !include error/DeploymentApplicationDoesNotExistError.raml
78+
DeploymentLogInvalidDateError: !include error/DeploymentLogInvalidDateError.raml
79+
DeploymentLogInvalidPageTokenError: !include error/DeploymentLogInvalidPageTokenError.raml
80+
DeploymentLogMissingApplicationNameError: !include error/DeploymentLogMissingApplicationNameError.raml

0 commit comments

Comments
 (0)