asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: improve JS Client TSDoc comments (#5582)

Browse Source 
* add oas schema to tsdoc parser

* add tsdoc (part 1)

* Finished tsdoc in js client

* general fixes

* added tsdoc in core medusa package

* parse schema tags in model files

* added maxlevel option

* added more tsdoc

* added tsdoc in core

* added TSDoc in core package

* generated client types

* support featureFlag and expandable tags

* added support for resource feature flag note

* fix api ignore plugin

* added eslint plugin

* support feature flag and expandable badges

* adjusted overview page + generated reference

* revert generated files

* added changeset

* add details about new typedoc options

* fix broken link
This commit is contained in:
Shahed Nasser
2023-11-09 12:51:17 +02:00
committed by GitHub
parent c68da6d685
commit 91615f9c45
748 changed files with 12354 additions and 1684 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
www/apps/api-reference/app/_mdx/admin.mdx
View File

@@ -1096,17 +1096,12 @@ export default Products`,
In the response of listing API Routes, aside from the entities retrieved,
there are three pagination-related fields returned: `count`, `limit`, and
`offset`.
there are three pagination-related fields returned:
Similar to the query parameters, `limit` is the maximum number of items that
can be returned in the response, and `field` is the number of items that
were skipped before the entities in the result.
`count` is the total number of available items of this entity. It can be
used to determine how many pages are there.
- `limit`: the maximum number of items that can be returned in the response.
- `offset`: the number of items that were skipped before the entities in the result.
- `count`: the total number of available items of this entity. It can be used to determine how many pages are there.
For example, if the `count` is 100 and the `limit` is 50, you can divide the

15
www/apps/api-reference/app/_mdx/store.mdx
View File

@@ -155,7 +155,7 @@ You can learn more about publishable API keys and how to use them in [this docum
### How to Create a Publishable API Key
You can create a publishable API key either using the [admin REST APIs](https://docs.medusajs.com/development/publishable-api-keys/admin/manage-publishable-api-keys),
or using the [Medusa admin](https://docs.medusajs.com/user-guide/settings/publishable-api-keys).
or using the [Medusa admin dashboard](https://docs.medusajs.com/user-guide/settings/publishable-api-keys).
### How to Use a Publishable API Key
@@ -1038,17 +1038,12 @@ export default Products`,
In the response of listing API Routes, aside from the entities retrieved,
there are three pagination-related fields returned: `count`, `limit`, and
`offset`.
there are three pagination-related fields returned:
Similar to the query parameters, `limit` is the maximum number of items that
can be returned in the response, and `field` is the number of items that
were skipped before the entities in the result.
`count` is the total number of available items of this entity. It can be
used to determine how many pages are there.
- `limit`: the maximum number of items that can be returned in the response.
- `offset`: the number of items that were skipped before the entities in the result.
- `count`: the total number of available items of this entity. It can be used to determine how many pages are there.
For example, if the `count` is 100 and the `limit` is 50, you can divide the