Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
37 changes: 30 additions & 7 deletions .mock/definition/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -611,6 +611,27 @@ types:
payload: optional<Workspace invitation>
source:
openapi: ../../../openapi/referenced-specs/v2.yml
WorkspaceAuditLogItemPayloadSettingChangeMethod:
enum:
- dashboard
- admin
inline: true
source:
openapi: ../../../openapi/referenced-specs/v2.yml
Setting change:
properties:
setting: optional<literal<"ai_toggle">>
previousValue: optional<string>
value: optional<string>
method: optional<WorkspaceAuditLogItemPayloadSettingChangeMethod>
source:
openapi: ../../../openapi/referenced-specs/v2.yml
SettingChangeAuditLogItem:
properties:
eventSubType: optional<literal<"setting_updated">>
payload: optional<Setting change>
source:
openapi: ../../../openapi/referenced-specs/v2.yml
WorkspaceAuditLogItemActor:
properties:
id: optional<string>
Expand Down Expand Up @@ -642,6 +663,8 @@ types:
type: SiteMembershipAuditLogItem
workspace_invitation:
type: WorkspaceInvitationAuditLogItem
workspace_setting:
type: SettingChangeAuditLogItem
source:
openapi: ../../../openapi/referenced-specs/v2.yml
Pagination:
Expand Down Expand Up @@ -1195,7 +1218,7 @@ types:
timestamp <br/>

- **Status flags** - Controls for managing content state: `isDraft`,
`isArchived `<br/>
`isArchived `<br/>

- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
`slug`, and may include additional fields matching your collection's
Expand Down Expand Up @@ -1280,7 +1303,7 @@ types:
timestamp <br/>

- **Status flags** - Controls for managing content state: `isDraft`,
`isArchived `<br/>
`isArchived `<br/>

- **Content fields** - Stored in `fieldData`. Each item needs a `name` and
`slug`, and may include additional fields matching your collection's
Expand Down Expand Up @@ -2067,13 +2090,13 @@ types:
type: string
docs: >
The new string or HTML value used to override the component instance
property value.
property value.

The provided value must be compatible with the type of the component
instance property.
instance property.

For example, attempting to override a single-line plain-text property
with a multi-line
with a multi-line

value will result in an error.
source:
Expand Down Expand Up @@ -2189,7 +2212,7 @@ types:
The Component DOM schema represents the content structure of a component.
Similar to Page DOM, it captures various content nodes and their
associated attributes, but specifically for a component's structure. Each
node has a unique identifier and can contain text, images, select or text
node has a unique identifier and can contain text, images, select or text
inputs, submit buttons, or nested component instances.
properties:
componentId:
Expand Down Expand Up @@ -2875,7 +2898,7 @@ types:
ProductFieldData:
docs: >-
Contains content-specific details for a product, covering both standard
(e.g., title, description) and custom fields tailored to the product
(e.g., title, description) and custom fields tailored to the product
setup.
properties:
name:
Expand Down
4 changes: 2 additions & 2 deletions .mock/definition/assets.yml
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ service:
- OAuth2:
- assets:write
docs: >
The first step in uploading an asset to a site.
The first step in uploading an asset to a site.



Expand All @@ -123,7 +123,7 @@ service:

To learn more about how to upload assets to Webflow, see our [assets
guide](/data/docs/working-with-assets).

Required scope | `assets:write`
source:
openapi: ../../../openapi/referenced-specs/v2.yml
Expand Down
10 changes: 5 additions & 5 deletions .mock/definition/collections/items.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ types:
slug:
type: string
docs: >-
URL slug for the item in your site.
URL slug for the item in your site.

Note: Updating the item slug will break all links referencing the old
slug.
Expand All @@ -111,7 +111,7 @@ types:
slug:
type: string
docs: >-
URL slug for the item in your site.
URL slug for the item in your site.

Note: Updating the item slug will break all links referencing the old
slug.
Expand Down Expand Up @@ -972,7 +972,7 @@ service:
- cms:write
docs: >
Unpublish up to 100 items from the live site and set the `isDraft`
property to `true`.
property to `true`.


<Tip title="Localization Tip">Items will only be unpublished in the
Expand Down Expand Up @@ -1627,7 +1627,7 @@ service:
- OAuth2:
- cms:write
docs: |
Delete an item from a collection.
Delete an item from a collection.

Required scope | `CMS:write`
source:
Expand Down Expand Up @@ -1888,7 +1888,7 @@ service:
- cms:write
docs: >
Unpublish a live item from the site and set the `isDraft` property to
`true`.
`true`.


For bulk unpublishing, please use [this
Expand Down
2 changes: 1 addition & 1 deletion .mock/definition/components.yml
Original file line number Diff line number Diff line change
Expand Up @@ -533,7 +533,7 @@ types:


For example, attempting to update a single-line plain-text property
with a multi-line
with a multi-line

value will result in an error.
source:
Expand Down
2 changes: 1 addition & 1 deletion .mock/definition/forms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,7 @@ service:

<Note title="Forms in components">
When a form is used in a component definition, each instance of the form is considered a unique form.

To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint.
</Note>

Expand Down
7 changes: 3 additions & 4 deletions .mock/definition/inventory.yml
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,12 @@ service:
- OAuth2:
- ecommerce:write
docs: >
Updates the current inventory levels for a particular SKU item.
Updates the current inventory levels for a particular SKU item.


Updates may be given in one or two methods, absolutely or
incrementally.
Updates may be given in one or two methods, absolutely or incrementally.

- Absolute updates are done by setting `quantity` directly.
- Absolute updates are done by setting `quantity` directly.

- Incremental updates are by specifying the inventory delta in
`updateQuantity` which is then added to the `quantity` stored on the
Expand Down
4 changes: 2 additions & 2 deletions .mock/definition/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ service:
slug:
type: optional<string>
docs: >
Slug for the page.
Slug for the page.



Expand Down Expand Up @@ -310,7 +310,7 @@ service:
docs: |
Get text and component instance content from a static page.

<Badge intent="info">Localization</Badge>
<Badge intent="info">Localization</Badge>

Required scope | `pages:read`
source:
Expand Down
2 changes: 1 addition & 1 deletion .mock/definition/pages/scripts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ service:
- OAuth2:
- custom_code:read
docs: |
Get all scripts applied to a page.
Get all scripts applied to a page.

Required scope | `custom_code:read`
source:
Expand Down
2 changes: 1 addition & 1 deletion .mock/definition/products.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ service:
- OAuth2:
- ecommerce:read
docs: >
Retrieve all products for a site.
Retrieve all products for a site.


Use `limit` and `offset` to page through all products with subsequent
Expand Down
8 changes: 4 additions & 4 deletions .mock/definition/sites.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ service:
- OAuth2:
- sites:write
docs: >
Create a site.
Create a site.


<Warning title="Enterprise Only">This endpoint requires an Enterprise
Expand Down Expand Up @@ -306,7 +306,7 @@ service:
- OAuth2:
- sites:write
docs: >
Delete a site.
Delete a site.


<Warning title="Enterprise Only">This endpoint requires an Enterprise
Expand Down Expand Up @@ -338,7 +338,7 @@ service:
- OAuth2:
- sites:write
docs: >
Update a site.
Update a site.


<Warning title="Enterprise Only">This endpoint requires an Enterprise
Expand Down Expand Up @@ -465,7 +465,7 @@ service:
- OAuth2:
- sites:write
docs: >
Publishes a site to one or more more domains.
Publishes a site to one or more more domains.


To publish to a specific custom domain, use the domain IDs from the [Get
Expand Down
2 changes: 1 addition & 1 deletion .mock/definition/sites/activityLogs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ service:
- OAuth2:
- site_activity:read
docs: >
Retrieve Activity Logs for a specific Site.
Retrieve Activity Logs for a specific Site.


<Warning title="Enterprise Only">This endpoint requires an Enterprise
Expand Down
4 changes: 2 additions & 2 deletions .mock/definition/sites/forms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ service:
Add `elementId` when you want to filter form submissions to a specific
form in a site. You can get the `elementId` from the [List forms
endpoint](/data/reference/forms/forms/list) (displayed as
`formElementId` in the response).
`formElementId` in the response).


<Note title="Forms in components">
Expand Down Expand Up @@ -106,7 +106,7 @@ service:
- OAuth2:
- forms:read
docs: >
List form submissions for a given form ID within a specific site.
List form submissions for a given form ID within a specific site.


Use the [List Form Submissions by Site
Expand Down
4 changes: 2 additions & 2 deletions .mock/definition/sites/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ service:
docs: Unique identifier for a Site
redirect_id:
type: string
docs: Unique identifier site rediect
docs: Unique identifier site redirect
display-name: Delete 301 redirects
response:
docs: Request was successful
Expand Down Expand Up @@ -189,7 +189,7 @@ service:
docs: Unique identifier for a Site
redirect_id:
type: string
docs: Unique identifier site rediect
docs: Unique identifier site redirect
display-name: Update 301 redirect
request:
body: root.Redirect
Expand Down
10 changes: 5 additions & 5 deletions .mock/definition/sites/scripts.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ service:
- OAuth2:
- custom_code:read
docs: |
Get all scripts applied to a site by the App.
Get all scripts applied to a site by the App.

<Note title="Script Registration">
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>
</Note>

Required scope | `custom_code:read`
source:
Expand Down Expand Up @@ -167,12 +167,12 @@ service:
- custom_code:read
docs: >
Get a list of scripts that have been applied to a site and/or individual
pages.
pages.


<Note title="Script Registration">
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.
To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints.

See the documentation on [working with Custom Code](/data/docs/custom-code) for more information.
</Note>

Expand Down
4 changes: 2 additions & 2 deletions .mock/definition/sites/wellKnown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ service:
The current restrictions on well-known files are as follows:
- Each file must be smaller than 100kb
- Less than 30 total files
- Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`
- Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext`
<Note title=".noext">
`.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files.
</Note>
Expand Down
1 change: 1 addition & 0 deletions .mock/definition/workspaces/auditLogs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ types:
- workspace_membership
- site_membership
- workspace_invitation
- workspace_setting
source:
openapi: ../../../openapi/referenced-specs/v2.yml
imports:
Expand Down
Loading