Skip to content

Commit 7fc8977

Browse files
committed
Updated API from documentation release
1 parent 356beed commit 7fc8977

File tree

5 files changed

+86
-2
lines changed

5 files changed

+86
-2
lines changed

api-specs/test/api.raml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ uses:
3636
any-properties-type: types/any-properties-type.raml
3737
any-test-type: types/any-test-type.raml
3838
arrays: types/arrays.raml
39+
child-objects: types/child-objects.raml
3940
constants: types/constants.raml
4041
date-test-type: types/date-test-type.raml
4142
descriptions-with-urn-links: types/descriptions-with-urn-links.raml

api-specs/test/types/arrays.raml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ usage: Array test types.
33

44
uses:
55
scalars: scalars.raml
6+
objects: objects.raml
7+
childObjects: child-objects.raml
68

79
types:
810
ArrayTestType:
@@ -93,3 +95,28 @@ types:
9395
type: string
9496
description: |
9597
Key type description.
98+
ObjectHierarchyExampleTestType:
99+
description: A test type with a reference to an object type that has a hierarchy.
100+
type: object
101+
properties:
102+
reference:
103+
type: ArrayTestType | WideLayoutArrayTestType
104+
description: |
105+
Reference description.
106+
key?:
107+
type: string
108+
description: |
109+
Key type description.
110+
arrayOfObjectType:
111+
description: An array of IntegerTestType. JSON primitive is `array`, display type is "Array of IntegerTestType"
112+
type: scalars.IntegerTestType[]
113+
uniqueItems: false
114+
/^[a-z]{2}(-[A-Z]{2})?$/:
115+
description: Regular expression property with an array type. To be displayed as "Array of ObjectTestType". The Slashes should appear in blue.
116+
type: array
117+
items: objects.ObjectTestType
118+
objectHierarchyLevel1:
119+
type: childObjects.ObjectHierarchyLevel1
120+
required: false
121+
description: |
122+
Object hierarchy level 1 description.
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
#%RAML 1.0 Library
2+
usage: Object test types for the Object Hierarchy feature.
3+
4+
uses:
5+
arrays: arrays.raml
6+
7+
types:
8+
ObjectHierarchyLevel1:
9+
description: A typical Object type with a non-scalar property.
10+
properties:
11+
version:
12+
type: integer
13+
objectTypeProperty:
14+
type: ObjectHierarchyLevel2
15+
description: Description of the property. This is a longer description to test the layout of the property description.
16+
objectTypeProperty2:
17+
type: ObjectHierarchyLevel3
18+
description: Description of the property. This is a longer description to test the layout of the property description.
19+
ObjectHierarchyLevel2:
20+
description: A typical Object type with a non-scalar property.
21+
properties:
22+
version:
23+
type: integer
24+
objectTypeProperty:
25+
type: ObjectHierarchyLevel3
26+
description: Description of the property. This is a longer description to test the layout of the property description.
27+
ObjectHierarchyLevel3:
28+
description: A typical Object type with a non-scalar property.
29+
properties:
30+
version:
31+
type: integer
32+
objectTypeProperty:
33+
type: ObjectHierarchyLevel4
34+
description: Description of the property. This is a longer description to test the layout of the property description.
35+
ObjectHierarchyLevel4:
36+
description: A typical Object type with a non-scalar property.
37+
properties:
38+
version:
39+
type: integer
40+
objectTypeProperty:
41+
type: ObjectHierarchyLevel5
42+
description: Description of the property. This is a longer description to test the layout of the property description.
43+
ObjectHierarchyLevel5:
44+
description: A typical Object type with a non-scalar property.
45+
properties:
46+
version:
47+
type: integer
48+
objectTypeProperty:
49+
type: ObjectHierarchyLevel6
50+
description: Description of the property. This is a longer description to test the layout of the property description.
51+
ObjectHierarchyLevel6:
52+
description: A type to create an ObjectTestType. Used for testing the endpoint layout.
53+
properties:
54+
objectTypeProperty:
55+
type: arrays.ArrayTestType
56+
description: Description of the property. This is a longer description to test the layout of the property description.

api-specs/test/types/constants.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ types:
1212
description: Has properties that are constant-like, that is, enums with only one value.
1313
properties:
1414
stringConstantLike:
15-
description: a string contant-like property
15+
description: a `string` contant-like property
1616
type: string
1717
enum:
1818
- constantStringValue

api-specs/test/types/enums.raml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ types:
8181
enumValue7: description 7
8282
enumValue8: description 8
8383
enumValue9: description 9
84-
enumValue10: description 10
84+
enumValue10: description 10 `markdown`
8585
enumWithMarkdownDescription: |
8686
`inline-code` should be formatted as an inline code. [ObjectTestType](/types/general#objecttesttype) should link to the header of the definition of `ObjectTestType` on this website - `api-docs-smoke-test`. [Links](/../docs-smoke-test/views/markdown#links) should link to the header for the definition of `Links` on `docs-smoke-test` microsite.
8787
enum:

0 commit comments

Comments
 (0)