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

docs: update docusaurus to v3 (#5625)

Browse Source 
* update dependencies

* update onboarding mdx

* fixes for mdx issues

* fixes for mdx compatibility

* resolve mdx errors

* fixes in reference

* fix check errors

* revert change in vale action

* fix node version in action

* fix summary in markdown
This commit is contained in:
Shahed Nasser
2023-11-13 20:11:50 +02:00
committed by GitHub
parent cedab58339
commit c6dff873de
2265 changed files with 46163 additions and 47195 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx
View File

@@ -42,7 +42,7 @@ medusa.admin.notes
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[`AdminPostNotesReq`](../internal/classes/internal.AdminPostNotesReq.mdx)",
"type": "[AdminPostNotesReq](../internal/classes/internal.AdminPostNotesReq.mdx)",
"description": "The note to be created.",
"optional": false,
"defaultValue": "",
@@ -79,7 +79,7 @@ medusa.admin.notes
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -93,7 +93,7 @@ medusa.admin.notes
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminNotesRes`](../internal/types/internal.AdminNotesRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesRes](../internal/types/internal.AdminNotesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the note's details.",
@@ -109,7 +109,7 @@ medusa.admin.notes
"children": [
{
"name": "note",
"type": "[`Note`](../internal/classes/internal.Note.mdx)",
"type": "[Note](../internal/classes/internal.Note.mdx)",
"description": "Note details.",
"optional": false,
"defaultValue": "",
@@ -117,7 +117,7 @@ medusa.admin.notes
"children": [
{
"name": "author",
"type": "[`User`](../internal/classes/internal.User.mdx)",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
@@ -162,7 +162,7 @@ medusa.admin.notes
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -244,7 +244,7 @@ medusa.admin.notes.delete(noteId).then(({ id, object, deleted }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -258,7 +258,7 @@ medusa.admin.notes.delete(noteId).then(({ id, object, deleted }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`DeleteResponse`](../internal/interfaces/internal.DeleteResponse.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[DeleteResponse](../internal/interfaces/internal.DeleteResponse.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the deletion operation's details.",
@@ -335,7 +335,7 @@ medusa.admin.notes
<ParameterTypes parameters={[
{
"name": "query",
"type": "[`AdminGetNotesParams`](../internal/classes/internal.AdminGetNotesParams.mdx)",
"type": "[AdminGetNotesParams](../internal/classes/internal.AdminGetNotesParams.mdx)",
"description": "Filters and pagination configurations applied on retrieved notes.",
"optional": true,
"defaultValue": "",
@@ -372,7 +372,7 @@ medusa.admin.notes
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -386,7 +386,7 @@ medusa.admin.notes
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminNotesListRes`](../internal/types/internal.AdminNotesListRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesListRes](../internal/types/internal.AdminNotesListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of notes with pagination fields.",
@@ -394,7 +394,7 @@ medusa.admin.notes
"children": [
{
"name": "AdminNotesListRes",
"type": "[`PaginatedResponse`](../internal/interfaces/internal.PaginatedResponse.mdx) & { `notes`: [`Note`](../internal/classes/internal.Note.mdx)[] }",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & `&#123; notes: [Note](../internal/classes/internal.Note.mdx)[] &#125;`",
"description": "The list of notes with pagination fields.",
"optional": false,
"defaultValue": "",
@@ -429,7 +429,7 @@ medusa.admin.notes
},
{
"name": "notes",
"type": "[`Note`](../internal/classes/internal.Note.mdx)[]",
"type": "[Note](../internal/classes/internal.Note.mdx)[]",
"description": "An array of notes",
"optional": false,
"defaultValue": "",
@@ -437,7 +437,7 @@ medusa.admin.notes
"children": [
{
"name": "author",
"type": "[`User`](../internal/classes/internal.User.mdx)",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
@@ -482,7 +482,7 @@ medusa.admin.notes
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -564,7 +564,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -578,7 +578,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminNotesRes`](../internal/types/internal.AdminNotesRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesRes](../internal/types/internal.AdminNotesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the note's details.",
@@ -594,7 +594,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
"children": [
{
"name": "note",
"type": "[`Note`](../internal/classes/internal.Note.mdx)",
"type": "[Note](../internal/classes/internal.Note.mdx)",
"description": "Note details.",
"optional": false,
"defaultValue": "",
@@ -602,7 +602,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
"children": [
{
"name": "author",
"type": "[`User`](../internal/classes/internal.User.mdx)",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
@@ -647,7 +647,7 @@ medusa.admin.notes.retrieve(noteId).then(({ note }) => {
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
@@ -733,7 +733,7 @@ medusa.admin.notes
},
{
"name": "payload",
"type": "[`AdminPostNotesNoteReq`](../internal/classes/internal.AdminPostNotesNoteReq.mdx)",
"type": "[AdminPostNotesNoteReq](../internal/classes/internal.AdminPostNotesNoteReq.mdx)",
"description": "The attributes to update in the note.",
"optional": false,
"defaultValue": "",
@@ -752,7 +752,7 @@ medusa.admin.notes
},
{
"name": "customHeaders",
"type": "Record<`string`, `any`\\>",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
@@ -766,7 +766,7 @@ medusa.admin.notes
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[`ResponsePromise`](../internal/types/internal.ResponsePromise.mdx)<[`AdminNotesRes`](../internal/types/internal.AdminNotesRes.mdx)\\>",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesRes](../internal/types/internal.AdminNotesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the note's details.",
@@ -782,7 +782,7 @@ medusa.admin.notes
"children": [
{
"name": "note",
"type": "[`Note`](../internal/classes/internal.Note.mdx)",
"type": "[Note](../internal/classes/internal.Note.mdx)",
"description": "Note details.",
"optional": false,
"defaultValue": "",
@@ -790,7 +790,7 @@ medusa.admin.notes
"children": [
{
"name": "author",
"type": "[`User`](../internal/classes/internal.User.mdx)",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
@@ -835,7 +835,7 @@ medusa.admin.notes
},
{
"name": "metadata",
"type": "Record<`string`, `unknown`\\>",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",