Skip to content

DocWorks for wix-bookings-backend - 14 changes detected, but 3 issue … #3450

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

DocWorks for wix-bookings-backend - 14 changes detected, but 3 issue … #3450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cb6bee9
DocWorks for wix-bookings-backend - 14 changes detected, but 3 issue …
MorTsarfati Sep 16, 2025
ffe3c59
DocWorks for wix-crm-backend - 9 changes detected, but 3 issue detected
MorTsarfati Sep 16, 2025
102fa75
DocWorks for wix-dashboard - 8 changes detected
MorTsarfati Sep 16, 2025
7473416
DocWorks for wix-data - 10 changes detected, but 11 issue detected
MorTsarfati Sep 16, 2025
daedde7
DocWorks for wix-events-backend - 6 changes detected, but 2 issue det…
MorTsarfati Sep 16, 2025
9d0ca4a
DocWorks for wix-members-backend - 1 change detected, but 1 issue det…
MorTsarfati Sep 16, 2025
a8c7d48
DocWorks for wix-groups-backend - 77 changes detected, but 10 issue d…
MorTsarfati Sep 16, 2025
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
8 changes: 5 additions & 3 deletions wix-bookings-backend/wix-bookings-backend/Bookings/BookingsQueryBuilder.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "BookingsQueryBuilder",
"memberOf": "wix-bookings-backend.Bookings",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "WixBookingsQueryBuilder.js" },
Expand Down Expand Up @@ -872,7 +873,7 @@
"description":
[ "The `options` parameter is an optional parameter that can be used when",
" calling the query [`find()`](#find) functions. To use `options`, pass it a `QueryOptions`",
" object with the following key:value pair:",
" object with the following `key:value` pair:",
"",
" + `\"suppressAuth\"`: `true`/`false`" ],
"links": [],
Expand All @@ -886,6 +887,7 @@
"optional": true } ],
"extra":
{ },
"labels": [] } ],
"labels":
[ "changed" ] } ],
"extra":
{ } }
19 changes: 11 additions & 8 deletions wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryBuilder.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "ResourceCatalogQueryBuilder",
"memberOf": "wix-bookings-backend.Resources",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "ResourceCatalogQueryBuilder.js" },
Expand All @@ -13,7 +14,7 @@
"",
" Typically, you build a query using the resource catalog query function,",
" refine the query by chaining `ResourceCatalogQueryBuilder` functions, and then execute the",
" query by chaining the [`find()`](wix-bookings-backend.Resources/resourcescatalogquerybuilder/find) function.",
" query by chaining the [`find()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/find) function.",
"",
"For example, the following code queries extended resource information where the slug name is \"john-doe\", and logs the first 5 results to the console:",
"",
Expand Down Expand Up @@ -262,12 +263,13 @@
"extra":
{ } },
{ "name": "limit",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params":
[ { "name": "limit",
"type": "number",
"doc": "The number of items to return, which is also the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) of the results object." } ],
"doc": "The number of items to return, which is also the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) of the results object." } ],
"ret":
{ "type": "wix-bookings-backend.Resources.ResourceCatalogQueryBuilder",
"doc": "A `ResourceCatalogQueryBuilder` object representing the refined query." },
Expand All @@ -278,8 +280,8 @@
{ "summary": "Limits the number of items the query returns.",
"description":
[ "The `limit()` function defines the number of results a query returns in each",
" page. Only one page of results is retrieved at a time. The [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next)",
" and [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) functions are used to",
" page. Only one page of results is retrieved at a time. The [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next)",
" and [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) functions are used to",
" navigate the pages of a query result.",
"",
" By default, `limit` is set to `50`.",
Expand Down Expand Up @@ -402,7 +404,7 @@
"description":
[ "The `options` parameter is an optional parameter that can be used when",
" calling the query [`find()`](wix-bookings-backend.Resources/resourcescatalogquerybuilder/find) functions. To use `options`, pass it a `QueryOptions`",
" object with the following key:value pair:",
" object with the following `key:value` pair:",
"",
" + `\"includeDeleted\"`: `true`/`false`" ],
"links": [],
Expand All @@ -416,6 +418,7 @@
"optional": true } ],
"extra":
{ },
"labels": [] } ],
"labels":
[ "changed" ] } ],
"extra":
{ } }
78 changes: 43 additions & 35 deletions wix-bookings-backend/wix-bookings-backend/Resources/ResourceCatalogQueryResult.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
{ "name": "ResourceCatalogQueryResult",
"memberOf": "wix-bookings-backend.Resources",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 2,
"filename": "ResourceCatalogQueryResult.js" },
"docs":
{ "summary": "The results of a resource catalog query, containing the retrieved items.",
"description":
[ "When you execute a query with the [`find()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/find)",
[ "When you execute a query with the [`find()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/find)",
" function, it returns a Promise that resolves to a `ResourceCatalogQueryResult` object.",
" This object contains the items that match the query, information about the",
" query itself, and functions for paging through the query results." ],
Expand All @@ -18,7 +19,8 @@
{ } },
"properties":
[ { "name": "currentPage",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "number",
Expand All @@ -30,10 +32,10 @@
"description":
[ "The `currentPage` is a zero-based index of the current page of results.",
"",
" The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)",
" function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and",
" navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and",
" [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.",
" The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)",
" function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and",
" navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and",
" [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.",
"",
" The `currentPage` property returns `undefined` if the query returned no results." ],
"links": [],
Expand Down Expand Up @@ -64,7 +66,8 @@
"extra":
{ } },
{ "name": "items",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type":
Expand All @@ -79,10 +82,10 @@
"description":
[ "The current page of resources, slugs, and schedules retrieved by the query.",
"",
" The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)",
" function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and",
" navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and",
" [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.",
" The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)",
" function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and",
" navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and",
" [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.",
"",
" When no items match the query, the array is empty." ],
"links": [],
Expand Down Expand Up @@ -256,7 +259,8 @@
"extra":
{ } },
{ "name": "length",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "number",
Expand All @@ -266,10 +270,10 @@
"docs":
{ "summary": "Returns the number of items in the current results page.",
"description":
[ "The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)",
" function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and",
" navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and",
" [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions." ],
[ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)",
" function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and",
" navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and",
" [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions." ],
"links": [],
"examples":
[ { "title": "Get the length of a query result",
Expand Down Expand Up @@ -298,7 +302,8 @@
"extra":
{ } },
{ "name": "pageSize",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "number",
Expand All @@ -308,9 +313,9 @@
"docs":
{ "summary": "Returns the query page size.",
"description":
[ "The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit) function, can be retrieved using ",
[ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit) function, can be retrieved using ",
"the `pageSize` property, and navigating through pages is done with ",
"the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions." ],
"the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions." ],
"links": [],
"examples":
[ { "title": "Get the page size of a query result",
Expand Down Expand Up @@ -424,7 +429,8 @@
"extra":
{ } },
{ "name": "totalPages",
"labels": [],
"labels":
[ "changed" ],
"get": true,
"set": false,
"type": "number",
Expand All @@ -434,10 +440,10 @@
"docs":
{ "summary": "Returns the total number of pages the query produced.",
"description":
[ "The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)",
" function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and",
" navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and",
" [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions." ],
[ "The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)",
" function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and",
" navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and",
" [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions." ],
"links": [],
"examples":
[ { "title": "Get the total number of pages in a query result",
Expand Down Expand Up @@ -534,7 +540,8 @@
"extra":
{ } },
{ "name": "next",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params": [],
"ret":
Expand All @@ -551,10 +558,10 @@
"description":
[ "The `next()` function retrieves the next page of query results.",
"",
" The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)",
" function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and",
" navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and",
" [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.",
" The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)",
" function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and",
" navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and",
" [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.",
"",
" If items are added or removed between calls to `next()` the values returned",
" by `ResourceCatalogQueryResult` may change." ],
Expand Down Expand Up @@ -607,7 +614,8 @@
"extra":
{ } },
{ "name": "prev",
"labels": [],
"labels":
[ "changed" ],
"nameParams": [],
"params": [],
"ret":
Expand All @@ -624,10 +632,10 @@
"description":
[ "The `prev()` function retrieves the previous page of query results.",
"",
" The page size is defined by the [`limit()`](wix-bookings-backend.resources/resourcecatalogquerybuilder/limit)",
" function, can be retrieved using the [`pageSize`](wix-bookings-backend.resources/resourcecatalogqueryresult/pageSize) property, and",
" navigating through pages is done with the [`prev()`](wix-bookings-backend.resources/resourcecatalogqueryresult/prev) and",
" [`next()`](wix-bookings-backend.resources/resourcecatalogqueryresult/next) functions.",
" The page size is defined by the [`limit()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-builder/limit)",
" function, can be retrieved using the [`pageSize`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/page-size) property, and",
" navigating through pages is done with the [`prev()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/prev) and",
" [`next()`](https://dev.wix.com/docs/velo/apis/wix-bookings-backend/resources/resource-catalog-query-result/next) functions.",
"",
" If items are added or removed between calls to `prev()` the values returned",
" may change." ],
Expand Down
8 changes: 5 additions & 3 deletions wix-bookings-backend/wix-bookings-backend/Sessions/SessionQueryBuilder.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
{ "name": "SessionQueryBuilder",
"memberOf": "wix-bookings-backend.Sessions",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "SessionQueryBuilder.js" },
Expand Down Expand Up @@ -613,7 +614,7 @@
"description":
[ "The `options` parameter is an optional parameter that can be used when",
" calling the query [`find()`](wix-bookings-backend/sessions/session-query-builder/find) functions. To use `options`, pass it a `QueryOptions`",
" object with the following key:value pair:",
" object with the following `key:value` pair:",
"",
" + `\"suppressAuth\"`: `true`/`false`" ],
"links": [],
Expand All @@ -627,6 +628,7 @@
"optional": true } ],
"extra":
{ },
"labels": [] } ],
"labels":
[ "changed" ] } ],
"extra":
{ } }
8 changes: 5 additions & 3 deletions wix-crm-backend/wix-crm-backend.service.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{ "name": "wix-crm-backend",
"mixes": [],
"labels": [],
"labels":
[ "changed" ],
"location":
{ "lineno": 1,
"filename": "contacts.js" },
Expand Down Expand Up @@ -634,11 +635,12 @@
[ "string",
"number",
"Date" ],
"doc": "Any\n number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n are used to store additional information about your site's contacts. When\n setting a custom field, use key:value pairs, where the key matches the display names\n in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n You can only set values for custom fields that already exist in the Contacts\n application.",
"doc": "Any\n number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)\n are used to store additional information about your site's contacts. When\n setting a custom field, use `key:value` pairs, where the key matches the display names\n in your site's [Contacts List](https://support.wix.com/en/article/accessing-your-contact-list).\n You can only set values for custom fields that already exist in the Contacts\n application.",
"optional": true } ],
"extra":
{ },
"labels": [] },
"labels":
[ "changed" ] },
{ "name": "DeleteOptions",
"locations":
[ { "lineno": 213,
Expand Down
Loading