Skip to content

Commit dc5bab4

Browse files
carowrightcarowright
authored
Merge pull request #50 from advanced-rest-client/fix/W-12276810/missing-lib-documentation
[W-12276810] Missing lib documentation
2 parents d5e263b + 65fca44 commit dc5bab4

18 files changed

+15670
-55
lines changed

‎demo/W-12276810/W-12276810.raml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#%RAML 1.0 Library
2+
usage: This library defines the Canonical Data types used as part of the Awaze integration
3+
4+
uses:
5+
property: canonical/PropertyDataType.raml
6+
individual: canonical/IndividualDataType.raml
7+
company: canonical/CompanyDataType.raml
8+
common: canonical/CommonDataType.raml
9+
header: headers/ApiHeaders.raml

‎demo/W-12276810/canonical/CommonDataType.raml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
#%RAML 1.0 Library
2+
usage:
3+
4+
types:
5+
6+
AmountType:
7+
type: number
8+
multipleOf: 0.01
9+
minimum: -9999999999999.99
10+
maximum: 9999999999999.99
11+
description: "Represents monetary value."
12+
13+
EmailType:
14+
type: string
15+
pattern: ^.+@.+\..+$
16+
17+
LatitudeType:
18+
type: string
19+
pattern: ([-+]?\d{1,2}([.]\d+)?)
20+
description: WGS84 DD (WGS84 established the datum, and DD states decimal degrees)
21+
22+
LongitudeType:
23+
type: string
24+
pattern: ([-+]?\d{1,3}([.]\d+)?)
25+
description: WGS84 DD (WGS84 established the datum, and DD states decimal degrees)
26+
27+
PostcodeType:
28+
type: string
29+
30+
ErrorType:
31+
properties:
32+
success:
33+
type: boolean
34+
default: false
35+
apiName:
36+
type: string
37+
description: Api name of the project
38+
version:
39+
type: string
40+
description: Mule runtime version
41+
correlationId:
42+
type: string
43+
description: Correlation id passed in headers
44+
timestamp:
45+
type: datetime
46+
description: Timestamp for the error
47+
errorDetails:
48+
properties:
49+
code:
50+
type: string
51+
description: status code
52+
message:
53+
type: string
54+
minLength: 1
55+
description: Error message
56+
additionalInfo:
57+
type: string
58+
description: Detail error message
59+
60+
AddressType:
61+
properties:
62+
street:
63+
type: string
64+
required: false
65+
description: Full Street or Address Line 1
66+
city:
67+
type: string
68+
required: false
69+
description: City
70+
state:
71+
type: string
72+
required: false
73+
description: State
74+
country:
75+
type: string
76+
required: false
77+
description: Country
78+
postcode:
79+
type: PostcodeType
80+
required: false
81+
description: Postcode

‎demo/W-12276810/canonical/CompanyDataType.raml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#%RAML 1.0 Library
2+
usage: Property and Asset related Types
3+
uses:
4+
common: CommonDataType.raml
5+
types:
6+
CompanyType:
7+
properties:
8+
masterId:
9+
type: string
10+
required: false
11+
description: Record Master Id
12+
example: 123EE45
13+
name:
14+
required: false
15+
description: First Name
16+
type: string
17+
phone:
18+
required: false
19+
description: Phone
20+
type: string
21+
email:
22+
required: false
23+
description: Email
24+
type: common.EmailType
25+
createdDateTime:
26+
type: datetime
27+
required: false
28+
description: original system created date
29+
modifiedDateTime:
30+
type: datetime
31+
required: false
32+
description: original system modified date

‎demo/W-12276810/canonical/IndividualDataType.raml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
#%RAML 1.0 Library
2+
usage: Property and Asset related Types
3+
uses:
4+
common: CommonDataType.raml
5+
company: CompanyDataType.raml
6+
7+
types:
8+
IndividualType:
9+
properties:
10+
masterId:
11+
type: string
12+
required: false
13+
description: Record Master Id
14+
example: 123EE45
15+
firstName:
16+
required: false
17+
description: First Name
18+
type: string
19+
lastName:
20+
required: false
21+
description: Last Name
22+
type: string
23+
fullName:
24+
required: false
25+
description: Full Name
26+
type: string
27+
phone:
28+
required: false
29+
description: Phone
30+
type: string
31+
email:
32+
required: false
33+
description: Email
34+
type: common.EmailType
35+
ownerCompany:
36+
type: company.CompanyType
37+
required: false
38+
createdDateTime:
39+
type: datetime
40+
required: false
41+
description: original system created date
42+
modifiedDateTime:
43+
type: datetime
44+
required: false
45+
description: original system modified date

‎demo/W-12276810/canonical/PropertyDataType.raml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
#%RAML 1.0 Library
2+
usage: Property and Asset related Types
3+
uses:
4+
common: CommonDataType.raml
5+
individual: IndividualDataType.raml
6+
company: CompanyDataType.raml
7+
types:
8+
PropertyType:
9+
properties:
10+
masterId:
11+
type: string
12+
required: false
13+
description: Record Master Id
14+
example: C1000
15+
name:
16+
type: string
17+
required: false
18+
description: record name
19+
example: C1000
20+
office:
21+
type: string
22+
required: false
23+
description: office relevant for the Property record
24+
example: "132"
25+
serviceType:
26+
type: string
27+
required: false
28+
description: service Type relevant for the Property record
29+
example: "200"
30+
sizeUnit:
31+
type: string
32+
required: false
33+
description: Eg, SQUARE-METERS
34+
enum: [SQUARE-METERS]
35+
default: SQUARE-METERS
36+
size:
37+
type: number
38+
required: false
39+
description: Size of the Property in the relevant Unit
40+
example: 103
41+
latitude:
42+
type: common.LatitudeType
43+
required: false
44+
description: Property Latitude WGS84 DD (WGS84 established the datum, and DD states decimal degrees)
45+
example: "51.509865"
46+
longitude:
47+
type: common.LongitudeType
48+
required: false
49+
description: Property Longitude WGS84 DD (WGS84 established the datum, and DD states decimal degrees)
50+
example: "-0.118092"
51+
address:
52+
type: common.AddressType
53+
required: false
54+
ownerIndividual:
55+
type: individual.IndividualType
56+
required: false
57+
ownerCompany:
58+
type: company.CompanyType
59+
required: false
60+
createdDateTime:
61+
type: datetime
62+
required: false
63+
description: original system created date
64+
modifiedDateTime:
65+
type: datetime
66+
required: false
67+
description: original system modified date
68+
endToEndModifiedDateTime:
69+
type: datetime
70+
required: false
71+
description: integrated modified date

‎demo/W-12276810/canonical/examples/errors/error400.raml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#%RAML 1.0 NamedExample
2+
value:
3+
success: false
4+
apiName: <env>-awaze-mule-x-som
5+
version: 4.4.0
6+
correlationId: b2b19890-c73c-11ea-a44d-0a29e1a180a8
7+
timestamp: 2020-07-16T08:16:49.842Z
8+
errorDetails:
9+
code: "400"
10+
message: Bad Request
11+
additionalInfo: Required fields are missing

‎demo/W-12276810/canonical/examples/errors/error404.raml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#%RAML 1.0 NamedExample
2+
value:
3+
success: false
4+
apiName: <env>-awaze-mule-x-som
5+
version: 4.4.0
6+
correlationId: b2b19890-c73c-11ea-a44d-0a29e1a180a8
7+
timestamp: 2022-07-16T08:16:49.842Z
8+
errorDetails:
9+
code: "404"
10+
message: Not Found
11+
additionalInfo: Requested resource not found

‎demo/W-12276810/canonical/examples/errors/error500.raml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#%RAML 1.0 NamedExample
2+
value:
3+
success: false
4+
apiName: <env>-awaze-mule-x-som
5+
version: 4.4.0
6+
correlationId: b2b19890-c73c-11ea-a44d-0a29e1a180a8
7+
timestamp: 2020-07-16T08:16:49.842Z
8+
errorDetails:
9+
code: "500"
10+
message: Internal Server Error
11+
additionalInfo: Server encountered an unexpected error

‎demo/W-12276810/canonical/examples/errors/error504.raml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#%RAML 1.0 NamedExample
2+
value:
3+
success: false
4+
apiName: <env>-awaze-mule-x-som
5+
version: 4.4.0
6+
correlationId: b2b19890-c73c-11ea-a44d-0a29e1a180a8
7+
timestamp: 2020-07-16T08:16:49.842Z
8+
errorDetails:
9+
code: "504"
10+
message: Server timeout
11+
additionalInfo: Server timeout

‎demo/W-12276810/canonical/examples/propertyPost.raml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
#%RAML 1.0 NamedExample
2+
3+
value:
4+
masterId: "C1000"
5+
name: "C1000"
6+
office: "132"
7+
serviceType: "200"
8+
sizeUnit: SQUARE-METERS
9+
size: 103
10+
latitude: "51.509865"
11+
longitude: "-0.118092"
12+
address:
13+
street: Offord Rd
14+
city: copenhagen
15+
country: Denmark
16+
postcode: "1050"
17+
ownerIndividual:
18+
masterId: "123EE45"
19+
firstName: "Tom"
20+
lastName: "Cruise"
21+
phone: "07433545667"
22+
email: "myemail@email.com"
23+
createdDateTime: 2022-05-16T12:40:51Z
24+
modifiedDateTime: 2022-05-16T12:40:51Z

0 commit comments

Comments
 (0)