Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add property descriptions to OAI #30

Merged
merged 2 commits into from
Mar 12, 2021
Merged

feat: add property descriptions to OAI #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3679823
feat: add property descriptions to OAI
JenniferMah Mar 10, 2021
3e65e03
Merge branch 'main' into DI-1214
JenniferMah Mar 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
146 changes: 96 additions & 50 deletions spec/json/twilio_accounts_v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,35 @@
"accounts.v1.auth_token_promotion": {
"properties": {
"account_sid": {
"$ref": "#/components/schemas/sid_AC"
"description": "The SID of the Account that the secondary Auth Token was created for",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"auth_token": {
"$ref": "#/components/schemas/string"
"description": "The promoted Auth Token",
"nullable": true,
"type": "string"
},
"date_created": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The ISO 8601 formatted date and time in UTC when the resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The ISO 8601 formatted date and time in UTC when the resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"url": {
"$ref": "#/components/schemas/url"
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
Expand All @@ -28,96 +44,126 @@
"accounts.v1.credential.credential_aws": {
"properties": {
"account_sid": {
"$ref": "#/components/schemas/sid_AC"
"description": "The SID of the Account that created the resource",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The RFC 2822 date and time in GMT when the resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The RFC 2822 date and time in GMT when the resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"$ref": "#/components/schemas/string"
"description": "The string that you assigned to describe the resource",
"nullable": true,
"type": "string"
},
"sid": {
"$ref": "#/components/schemas/sid_CR"
"description": "The unique string that identifies the resource",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^CR[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"$ref": "#/components/schemas/url"
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"accounts.v1.credential.credential_public_key": {
"properties": {
"account_sid": {
"$ref": "#/components/schemas/sid_AC"
"description": "The SID of the Account that created the Credential that the PublicKey resource belongs to",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The RFC 2822 date and time in GMT when the resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The RFC 2822 date and time in GMT when the resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"friendly_name": {
"$ref": "#/components/schemas/string"
"description": "The string that you assigned to describe the resource",
"nullable": true,
"type": "string"
},
"sid": {
"$ref": "#/components/schemas/sid_CR"
"description": "The unique string that identifies the resource",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^CR[0-9a-fA-F]{32}$",
"type": "string"
},
"url": {
"$ref": "#/components/schemas/url"
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"accounts.v1.secondary_auth_token": {
"properties": {
"account_sid": {
"$ref": "#/components/schemas/sid_AC"
"description": "The SID of the Account that the secondary Auth Token was created for",
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"date_created": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The ISO 8601 formatted date and time in UTC when the resource was created",
"format": "date-time",
"nullable": true,
"type": "string"
},
"date_updated": {
"$ref": "#/components/schemas/date_time_iso8601"
"description": "The ISO 8601 formatted date and time in UTC when the resource was last updated",
"format": "date-time",
"nullable": true,
"type": "string"
},
"secondary_auth_token": {
"$ref": "#/components/schemas/string"
"description": "The generated secondary Auth Token",
"nullable": true,
"type": "string"
},
"url": {
"$ref": "#/components/schemas/url"
"description": "The URI for this resource, relative to `https://accounts.twilio.com`",
"format": "uri",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"date_time_iso8601": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"sid_AC": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^AC[0-9a-fA-F]{32}$",
"type": "string"
},
"sid_CR": {
"maxLength": 34,
"minLength": 34,
"nullable": true,
"pattern": "^CR[0-9a-fA-F]{32}$",
"type": "string"
},
"string": {
"nullable": true,
"type": "string"
},
"url": {
"format": "uri",
"nullable": true,
"type": "string"
}
},
"securitySchemes": {
Expand Down
Loading