Skip to content

Commit 57268a9

Browse files
JenniferMahJenniferMah
authored
feat: add property descriptions to OAI (twilio#117)
1 parent 453b697 commit 57268a9

33 files changed

+19393
-11278
lines changed

‎src/services/twilio-api/twilio_accounts_v1.json

Lines changed: 96 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,35 @@
44
"accounts.v1.auth_token_promotion": {
55
"properties": {
66
"account_sid": {
7-
"$ref": "#/components/schemas/sid_AC"
7+
"description": "The SID of the Account that the secondary Auth Token was created for",
8+
"maxLength": 34,
9+
"minLength": 34,
10+
"nullable": true,
11+
"pattern": "^AC[0-9a-fA-F]{32}$",
12+
"type": "string"
813
},
914
"auth_token": {
10-
"$ref": "#/components/schemas/string"
15+
"description": "The promoted Auth Token",
16+
"nullable": true,
17+
"type": "string"
1118
},
1219
"date_created": {
13-
"$ref": "#/components/schemas/date_time_iso8601"
20+
"description": "The ISO 8601 formatted date and time in UTC when the resource was created",
21+
"format": "date-time",
22+
"nullable": true,
23+
"type": "string"
1424
},
1525
"date_updated": {
16-
"$ref": "#/components/schemas/date_time_iso8601"
26+
"description": "The ISO 8601 formatted date and time in UTC when the resource was last updated",
27+
"format": "date-time",
28+
"nullable": true,
29+
"type": "string"
1730
},
1831
"url": {
19-
"$ref": "#/components/schemas/url"
32+
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
33+
"format": "uri",
34+
"nullable": true,
35+
"type": "string"
2036
}
2137
},
2238
"type": "object"
@@ -28,96 +44,126 @@
2844
"accounts.v1.credential.credential_aws": {
2945
"properties": {
3046
"account_sid": {
31-
"$ref": "#/components/schemas/sid_AC"
47+
"description": "The SID of the Account that created the resource",
48+
"maxLength": 34,
49+
"minLength": 34,
50+
"nullable": true,
51+
"pattern": "^AC[0-9a-fA-F]{32}$",
52+
"type": "string"
3253
},
3354
"date_created": {
34-
"$ref": "#/components/schemas/date_time_iso8601"
55+
"description": "The RFC 2822 date and time in GMT when the resource was created",
56+
"format": "date-time",
57+
"nullable": true,
58+
"type": "string"
3559
},
3660
"date_updated": {
37-
"$ref": "#/components/schemas/date_time_iso8601"
61+
"description": "The RFC 2822 date and time in GMT when the resource was last updated",
62+
"format": "date-time",
63+
"nullable": true,
64+
"type": "string"
3865
},
3966
"friendly_name": {
40-
"$ref": "#/components/schemas/string"
67+
"description": "The string that you assigned to describe the resource",
68+
"nullable": true,
69+
"type": "string"
4170
},
4271
"sid": {
43-
"$ref": "#/components/schemas/sid_CR"
72+
"description": "The unique string that identifies the resource",
73+
"maxLength": 34,
74+
"minLength": 34,
75+
"nullable": true,
76+
"pattern": "^CR[0-9a-fA-F]{32}$",
77+
"type": "string"
4478
},
4579
"url": {
46-
"$ref": "#/components/schemas/url"
80+
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
81+
"format": "uri",
82+
"nullable": true,
83+
"type": "string"
4784
}
4885
},
4986
"type": "object"
5087
},
5188
"accounts.v1.credential.credential_public_key": {
5289
"properties": {
5390
"account_sid": {
54-
"$ref": "#/components/schemas/sid_AC"
91+
"description": "The SID of the Account that created the Credential that the PublicKey resource belongs to",
92+
"maxLength": 34,
93+
"minLength": 34,
94+
"nullable": true,
95+
"pattern": "^AC[0-9a-fA-F]{32}$",
96+
"type": "string"
5597
},
5698
"date_created": {
57-
"$ref": "#/components/schemas/date_time_iso8601"
99+
"description": "The RFC 2822 date and time in GMT when the resource was created",
100+
"format": "date-time",
101+
"nullable": true,
102+
"type": "string"
58103
},
59104
"date_updated": {
60-
"$ref": "#/components/schemas/date_time_iso8601"
105+
"description": "The RFC 2822 date and time in GMT when the resource was last updated",
106+
"format": "date-time",
107+
"nullable": true,
108+
"type": "string"
61109
},
62110
"friendly_name": {
63-
"$ref": "#/components/schemas/string"
111+
"description": "The string that you assigned to describe the resource",
112+
"nullable": true,
113+
"type": "string"
64114
},
65115
"sid": {
66-
"$ref": "#/components/schemas/sid_CR"
116+
"description": "The unique string that identifies the resource",
117+
"maxLength": 34,
118+
"minLength": 34,
119+
"nullable": true,
120+
"pattern": "^CR[0-9a-fA-F]{32}$",
121+
"type": "string"
67122
},
68123
"url": {
69-
"$ref": "#/components/schemas/url"
124+
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
125+
"format": "uri",
126+
"nullable": true,
127+
"type": "string"
70128
}
71129
},
72130
"type": "object"
73131
},
74132
"accounts.v1.secondary_auth_token": {
75133
"properties": {
76134
"account_sid": {
77-
"$ref": "#/components/schemas/sid_AC"
135+
"description": "The SID of the Account that the secondary Auth Token was created for",
136+
"maxLength": 34,
137+
"minLength": 34,
138+
"nullable": true,
139+
"pattern": "^AC[0-9a-fA-F]{32}$",
140+
"type": "string"
78141
},
79142
"date_created": {
80-
"$ref": "#/components/schemas/date_time_iso8601"
143+
"description": "The ISO 8601 formatted date and time in UTC when the resource was created",
144+
"format": "date-time",
145+
"nullable": true,
146+
"type": "string"
81147
},
82148
"date_updated": {
83-
"$ref": "#/components/schemas/date_time_iso8601"
149+
"description": "The ISO 8601 formatted date and time in UTC when the resource was last updated",
150+
"format": "date-time",
151+
"nullable": true,
152+
"type": "string"
84153
},
85154
"secondary_auth_token": {
86-
"$ref": "#/components/schemas/string"
155+
"description": "The generated secondary Auth Token",
156+
"nullable": true,
157+
"type": "string"
87158
},
88159
"url": {
89-
"$ref": "#/components/schemas/url"
160+
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
161+
"format": "uri",
162+
"nullable": true,
163+
"type": "string"
90164
}
91165
},
92166
"type": "object"
93-
},
94-
"date_time_iso8601": {
95-
"format": "date-time",
96-
"nullable": true,
97-
"type": "string"
98-
},
99-
"sid_AC": {
100-
"maxLength": 34,
101-
"minLength": 34,
102-
"nullable": true,
103-
"pattern": "^AC[0-9a-fA-F]{32}$",
104-
"type": "string"
105-
},
106-
"sid_CR": {
107-
"maxLength": 34,
108-
"minLength": 34,
109-
"nullable": true,
110-
"pattern": "^CR[0-9a-fA-F]{32}$",
111-
"type": "string"
112-
},
113-
"string": {
114-
"nullable": true,
115-
"type": "string"
116-
},
117-
"url": {
118-
"format": "uri",
119-
"nullable": true,
120-
"type": "string"
121167
}
122168
},
123169
"securitySchemes": {

0 commit comments

Comments
 (0)