Skip to content

Commit 4fb4630

Browse files
fix(forms): update the API
#### forms:v1 The following keys were changed: - resources.forms.methods.setPublishSettings.parameters.formId.description - schemas.Form.properties.publishSettings.description - schemas.Form.properties.responderUri.description - schemas.Form.properties.revisionId.description - schemas.Form.properties.settings.description - schemas.Info.properties.documentTitle.description - schemas.SetPublishSettingsResponse.description - schemas.SetPublishSettingsResponse.properties.formId.description
1 parent f71c04a commit 4fb4630

File tree

2 files changed

+17
-17
lines changed

2 files changed

+17
-17
lines changed

‎discovery/forms-v1.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@
215215
],
216216
"parameters": {
217217
"formId": {
218-
"description": "Required. The ID of the form. You can get the id from `Form.form_id` field.",
218+
"description": "Required. The ID of the form. You can get the id from Form.form_id field.",
219219
"location": "path",
220220
"required": true,
221221
"type": "string"
@@ -458,7 +458,7 @@
458458
}
459459
}
460460
},
461-
"revision": "20250304",
461+
"revision": "20250422",
462462
"rootUrl": "https://forms.googleapis.com/",
463463
"schemas": {
464464
"Answer": {
@@ -831,22 +831,22 @@
831831
},
832832
"publishSettings": {
833833
"$ref": "PublishSettings",
834-
"description": "Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.",
834+
"description": "Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the publish_settings field. All newly created forms support publish settings. Forms with publish_settings value set can call SetPublishSettings API to publish or unpublish the form.",
835835
"readOnly": true
836836
},
837837
"responderUri": {
838-
"description": "Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.",
838+
"description": "Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. For forms that have publish_settings value set, this is the published form URI.",
839839
"readOnly": true,
840840
"type": "string"
841841
},
842842
"revisionId": {
843-
"description": "Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes.",
843+
"description": "Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published)",
844844
"readOnly": true,
845845
"type": "string"
846846
},
847847
"settings": {
848848
"$ref": "FormSettings",
849-
"description": "The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest."
849+
"description": "The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during CreateForm and UpdateFormInfoRequest."
850850
}
851851
},
852852
"type": "object"
@@ -1036,7 +1036,7 @@
10361036
"type": "string"
10371037
},
10381038
"documentTitle": {
1039-
"description": "Output only. The title of the document which is visible in Drive. If `Info.title` is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.",
1039+
"description": "Output only. The title of the document which is visible in Drive. If Info.title is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.",
10401040
"readOnly": true,
10411041
"type": "string"
10421042
},
@@ -1476,11 +1476,11 @@
14761476
"type": "object"
14771477
},
14781478
"SetPublishSettingsResponse": {
1479-
"description": "The response of a `SetPublishSettings` request.",
1479+
"description": "The response of a SetPublishSettings request.",
14801480
"id": "SetPublishSettingsResponse",
14811481
"properties": {
14821482
"formId": {
1483-
"description": "Required. The ID of the Form. This is same as the `Form.form_id` field.",
1483+
"description": "Required. The ID of the Form. This is same as the Form.form_id field.",
14841484
"type": "string"
14851485
},
14861486
"publishSettings": {

‎src/apis/forms/v1.ts

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -382,19 +382,19 @@ export namespace forms_v1 {
382382
*/
383383
linkedSheetId?: string | null;
384384
/**
385-
* Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the `publish_settings` field. All newly created forms support publish settings. Forms with `publish_settings` value set can call UpdatePublishSettings API to publish or unpublish the form.
385+
* Output only. The publishing settings for a form. This field isn't set for legacy forms because they don't have the publish_settings field. All newly created forms support publish settings. Forms with publish_settings value set can call SetPublishSettings API to publish or unpublish the form.
386386
*/
387387
publishSettings?: Schema$PublishSettings;
388388
/**
389-
* Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions.
389+
* Output only. The form URI to share with responders. This opens a page that allows the user to submit responses but not edit the questions. For forms that have publish_settings value set, this is the published form URI.
390390
*/
391391
responderUri?: string | null;
392392
/**
393-
* Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form has not changed. Conversely, a changed ID (for the same form and user) usually means the form has been updated; however, a changed ID can also be due to internal factors such as ID format changes.
393+
* Output only. The revision ID of the form. Used in the WriteControl in update requests to identify the revision on which the changes are based. The format of the revision ID may change over time, so it should be treated opaquely. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the form *content* has not changed. Conversely, a changed ID (for the same form and user) usually means the form *content* has been updated; however, a changed ID can also be due to internal factors such as ID format changes. Form content excludes form metadata, including: * sharing settings (who has access to the form) * publish_settings (if the form supports publishing and if it is published)
394394
*/
395395
revisionId?: string | null;
396396
/**
397-
* The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during `forms.create` and UpdateFormInfoRequest.
397+
* The form's settings. This must be updated with UpdateSettingsRequest; it is ignored during CreateForm and UpdateFormInfoRequest.
398398
*/
399399
settings?: Schema$FormSettings;
400400
}
@@ -538,7 +538,7 @@ export namespace forms_v1 {
538538
*/
539539
description?: string | null;
540540
/**
541-
* Output only. The title of the document which is visible in Drive. If `Info.title` is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.
541+
* Output only. The title of the document which is visible in Drive. If Info.title is empty, `document_title` may appear in its place in the Google Forms UI and be visible to responders. `document_title` can be set on create, but cannot be modified by a batchUpdate request. Please use the [Google Drive API](https://developers.google.com/drive/api/v3/reference/files/update) if you need to programmatically update `document_title`.
542542
*/
543543
documentTitle?: string | null;
544544
/**
@@ -882,11 +882,11 @@ export namespace forms_v1 {
882882
updateMask?: string | null;
883883
}
884884
/**
885-
* The response of a `SetPublishSettings` request.
885+
* The response of a SetPublishSettings request.
886886
*/
887887
export interface Schema$SetPublishSettingsResponse {
888888
/**
889-
* Required. The ID of the Form. This is same as the `Form.form_id` field.
889+
* Required. The ID of the Form. This is same as the Form.form_id field.
890890
*/
891891
formId?: string | null;
892892
/**
@@ -1486,7 +1486,7 @@ export namespace forms_v1 {
14861486
export interface Params$Resource$Forms$Setpublishsettings
14871487
extends StandardParameters {
14881488
/**
1489-
* Required. The ID of the form. You can get the id from `Form.form_id` field.
1489+
* Required. The ID of the form. You can get the id from Form.form_id field.
14901490
*/
14911491
formId?: string;
14921492

0 commit comments

Comments
 (0)