Skip to content

Commit

Permalink
feat(docs): update the API
Browse files Browse the repository at this point in the history
#### docs:v1

The following keys were added:
- schemas.ParagraphElement.properties.richLink.$ref
- schemas.ParagraphElement.properties.richLink.description
- schemas.RichLink.description
- schemas.RichLink.id
- schemas.RichLink.properties.richLinkId.description
- schemas.RichLink.properties.richLinkId.readOnly
- schemas.RichLink.properties.richLinkId.type
- schemas.RichLink.properties.richLinkProperties.$ref
- schemas.RichLink.properties.richLinkProperties.description
- schemas.RichLink.properties.richLinkProperties.readOnly
- schemas.RichLink.properties.suggestedDeletionIds.description
- schemas.RichLink.properties.suggestedDeletionIds.items.type
- schemas.RichLink.properties.suggestedDeletionIds.type
- schemas.RichLink.properties.suggestedInsertionIds.description
- schemas.RichLink.properties.suggestedInsertionIds.items.type
- schemas.RichLink.properties.suggestedInsertionIds.type
- schemas.RichLink.properties.suggestedTextStyleChanges.additionalProperties.$ref
- schemas.RichLink.properties.suggestedTextStyleChanges.description
- schemas.RichLink.properties.suggestedTextStyleChanges.type
- schemas.RichLink.properties.textStyle.$ref
- schemas.RichLink.properties.textStyle.description
- schemas.RichLink.type
- schemas.RichLinkProperties.description
- schemas.RichLinkProperties.id
- schemas.RichLinkProperties.properties.mimeType.description
- schemas.RichLinkProperties.properties.mimeType.readOnly
- schemas.RichLinkProperties.properties.mimeType.type
- schemas.RichLinkProperties.properties.title.description
- schemas.RichLinkProperties.properties.title.readOnly
- schemas.RichLinkProperties.properties.title.type
- schemas.RichLinkProperties.properties.uri.description
- schemas.RichLinkProperties.properties.uri.readOnly
- schemas.RichLinkProperties.properties.uri.type
- schemas.RichLinkProperties.type

The following keys were changed:
- auth.oauth2.scopes.https://www.googleapis.com/auth/documents.description
- auth.oauth2.scopes.https://www.googleapis.com/auth/documents.readonly.description
  • Loading branch information
yoshi-automation authored and JustinBeckwith committed Jul 8, 2021
1 parent cad65ce commit 4d84c10
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 3 deletions.
74 changes: 71 additions & 3 deletions discovery/docs-v1.json
Expand Up @@ -3,10 +3,10 @@
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/documents": {
"description": "See, create, and edit all Google Docs documents you have access to"
"description": "See, edit, create, and delete all your Google Docs documents"
},
"https://www.googleapis.com/auth/documents.readonly": {
"description": "View your Google Docs documents"
"description": "See all your Google Docs documents"
},
"https://www.googleapis.com/auth/drive": {
"description": "See, edit, create, and delete all of your Google Drive files"
Expand Down Expand Up @@ -216,7 +216,7 @@
}
}
},
"revision": "20210615",
"revision": "20210707",
"rootUrl": "https://docs.googleapis.com/",
"schemas": {
"AutoText": {
Expand Down Expand Up @@ -2277,6 +2277,10 @@
"$ref": "Person",
"description": "A paragraph element that links to a person or email address."
},
"richLink": {
"$ref": "RichLink",
"description": "A paragraph element that links to a Google resource (such as a file in Drive, a Youtube video, a Calendar event, etc.)"
},
"startIndex": {
"description": "The zero-based start index of this paragraph element, in UTF-16 code units.",
"format": "int32",
Expand Down Expand Up @@ -2993,6 +2997,70 @@
},
"type": "object"
},
"RichLink": {
"description": "A link to a Google resource (e.g., a file in Drive, a YouTube video, a Calendar event, etc.).",
"id": "RichLink",
"properties": {
"richLinkId": {
"description": "Output only. The ID of this link.",
"readOnly": true,
"type": "string"
},
"richLinkProperties": {
"$ref": "RichLinkProperties",
"description": "Output only. The properties of this RichLink. This field is always present.",
"readOnly": true
},
"suggestedDeletionIds": {
"description": "IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest to delete it. If empty, then this person link isn't suggested for deletion.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestedInsertionIds": {
"description": "IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it is a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.",
"items": {
"type": "string"
},
"type": "array"
},
"suggestedTextStyleChanges": {
"additionalProperties": {
"$ref": "SuggestedTextStyle"
},
"description": "The suggested text style changes to this RichLink, keyed by suggestion ID.",
"type": "object"
},
"textStyle": {
"$ref": "TextStyle",
"description": "The text style of this RichLink."
}
},
"type": "object"
},
"RichLinkProperties": {
"description": "Properties specific to a RichLink.",
"id": "RichLinkProperties",
"properties": {
"mimeType": {
"description": "Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there is one (i.e., when it is a file in Drive).",
"readOnly": true,
"type": "string"
},
"title": {
"description": "Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.",
"readOnly": true,
"type": "string"
},
"uri": {
"description": "Output only. The URI to the RichLink. This is always present.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"SectionBreak": {
"description": "A StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.",
"id": "SectionBreak",
Expand Down
52 changes: 52 additions & 0 deletions src/apis/docs/v1.ts
Expand Up @@ -1669,6 +1669,10 @@ export namespace docs_v1 {
* A paragraph element that links to a person or email address.
*/
person?: Schema$Person;
/**
* A paragraph element that links to a Google resource (such as a file in Drive, a Youtube video, a Calendar event, etc.)
*/
richLink?: Schema$RichLink;
/**
* The zero-based start index of this paragraph element, in UTF-16 code units.
*/
Expand Down Expand Up @@ -2239,6 +2243,54 @@ export namespace docs_v1 {
*/
red?: number | null;
}
/**
* A link to a Google resource (e.g., a file in Drive, a YouTube video, a Calendar event, etc.).
*/
export interface Schema$RichLink {
/**
* Output only. The ID of this link.
*/
richLinkId?: string | null;
/**
* Output only. The properties of this RichLink. This field is always present.
*/
richLinkProperties?: Schema$RichLinkProperties;
/**
* IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest to delete it. If empty, then this person link isn't suggested for deletion.
*/
suggestedDeletionIds?: string[] | null;
/**
* IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it is a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
*/
suggestedInsertionIds?: string[] | null;
/**
* The suggested text style changes to this RichLink, keyed by suggestion ID.
*/
suggestedTextStyleChanges?: {
[key: string]: Schema$SuggestedTextStyle;
} | null;
/**
* The text style of this RichLink.
*/
textStyle?: Schema$TextStyle;
}
/**
* Properties specific to a RichLink.
*/
export interface Schema$RichLinkProperties {
/**
* Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there is one (i.e., when it is a file in Drive).
*/
mimeType?: string | null;
/**
* Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
*/
title?: string | null;
/**
* Output only. The URI to the RichLink. This is always present.
*/
uri?: string | null;
}
/**
* A StructuralElement representing a section break. A section is a range of content which has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break.
*/
Expand Down

0 comments on commit 4d84c10

Please sign in to comment.