Update graphql documentation

archethic-foundation · Jun 20, 2024 · 619cd14 · 619cd14
1 parent a759c80
commit 619cd14
Show file tree

Hide file tree

Showing 75 changed files with 3,221 additions and 500 deletions.
diff --git a/docs/build/api/schema/directives/include.mdx b/docs/build/api/schema/directives/include.mdx
@@ -5,30 +5,61 @@ hide_table_of_contents: false
 ---
 
 
-
 export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
 
 export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
 
-export const Badge = (props) => <><span class={'badge badge--' + props.class}>{props.text}</span></>
+export const Badge = (props) => <><span className={props.class}>{props.text}</span></>
+
+import { useState } from 'react';
+
+export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => {
+  const [open, setOpen] = useState(startOpen);
+  return (
+    <details {...(open ? { open: true } : {})} className="details" style={{ border:'none', boxShadow:'none', background:'var(--ifm-background-color)' }}>
+      <summary
+        onClick={(e) => {
+          e.preventDefault();
+          setOpen((open) => !open);
+        }}
+        style={{ listStyle:'none' }}
+      >
+      {open ? dataOpen : dataClose}
+      </summary>
+      {open && children}
+    </details>
+  );
+};
+
+
+
+
+
+
 
 
 Directs the executor to include this field or fragment only when the `if` argument is true.
 
+
 ```graphql
 directive @include(
   if: Boolean!
-)
+) on 
+  | FIELD
+  | FRAGMENT_SPREAD
+  | INLINE_FRAGMENT
 ```
 
 
+
+
 ### Arguments
 
-#### [<code style={{ fontWeight: 'normal' }}>include.<b>if</b></code>](#)<Bullet />[`Boolean!`](/build/api/schema/scalars/boolean) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+#### [<code style={{ fontWeight: 'normal' }}>include.<b>if</b></code>](#)<Bullet />[`Boolean!`](/build/api/schema/scalars/boolean) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/> 
+> 
+> 
 > Included when true.
 > 
 
 
 
-
-
diff --git a/docs/build/api/schema/directives/skip.mdx b/docs/build/api/schema/directives/skip.mdx
@@ -5,30 +5,61 @@ hide_table_of_contents: false
 ---
 
 
-
 export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
 
 export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
 
-export const Badge = (props) => <><span class={'badge badge--' + props.class}>{props.text}</span></>
+export const Badge = (props) => <><span className={props.class}>{props.text}</span></>
+
+import { useState } from 'react';
+
+export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => {
+  const [open, setOpen] = useState(startOpen);
+  return (
+    <details {...(open ? { open: true } : {})} className="details" style={{ border:'none', boxShadow:'none', background:'var(--ifm-background-color)' }}>
+      <summary
+        onClick={(e) => {
+          e.preventDefault();
+          setOpen((open) => !open);
+        }}
+        style={{ listStyle:'none' }}
+      >
+      {open ? dataOpen : dataClose}
+      </summary>
+      {open && children}
+    </details>
+  );
+};
+
+
+
+
+
+
 
 
 Directs the executor to skip this field or fragment when the `if` argument is true.
 
+
 ```graphql
 directive @skip(
   if: Boolean!
-)
+) on 
+  | FIELD
+  | FRAGMENT_SPREAD
+  | INLINE_FRAGMENT
 ```
 
 
+
+
 ### Arguments
 
-#### [<code style={{ fontWeight: 'normal' }}>skip.<b>if</b></code>](#)<Bullet />[`Boolean!`](/build/api/schema/scalars/boolean) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>
+#### [<code style={{ fontWeight: 'normal' }}>skip.<b>if</b></code>](#)<Bullet />[`Boolean!`](/build/api/schema/scalars/boolean) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/> 
+> 
+> 
 > Skipped when true.
 > 
 
 
 
-
-
diff --git a/docs/build/api/schema/enums/error-context.mdx b/docs/build/api/schema/enums/error-context.mdx
@@ -5,16 +5,42 @@ hide_table_of_contents: false
 ---
 
 
-
 export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
 
 export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
 
-export const Badge = (props) => <><span class={'badge badge--' + props.class}>{props.text}</span></>
+export const Badge = (props) => <><span className={props.class}>{props.text}</span></>
+
+import { useState } from 'react';
+
+export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => {
+  const [open, setOpen] = useState(startOpen);
+  return (
+    <details {...(open ? { open: true } : {})} className="details" style={{ border:'none', boxShadow:'none', background:'var(--ifm-background-color)' }}>
+      <summary
+        onClick={(e) => {
+          e.preventDefault();
+          setOpen((open) => !open);
+        }}
+        style={{ listStyle:'none' }}
+      >
+      {open ? dataOpen : dataClose}
+      </summary>
+      {open && children}
+    </details>
+  );
+};
+
+
+
+
+
+
 
 
 Transaction error context
 
+
 ```graphql
 enum ErrorContext {
   INVALID_TRANSACTION
@@ -23,21 +49,25 @@ enum ErrorContext {
 ```
 
 
+
+
 ### Values
 
-#### [<code style={{ fontWeight: 'normal' }}>ErrorContext.<b>INVALID_TRANSACTION</b></code>](#) 
+#### [<code style={{ fontWeight: 'normal' }}>ErrorContext.<b>INVALID_TRANSACTION</b></code>](#)  
+> 
+> 
 > Transaction is invalid
 > 
 
-#### [<code style={{ fontWeight: 'normal' }}>ErrorContext.<b>NETWORK_ISSUE</b></code>](#) 
+#### [<code style={{ fontWeight: 'normal' }}>ErrorContext.<b>NETWORK_ISSUE</b></code>](#)  
+> 
+> 
 > Network problem
 > 
 
 
 
 ### Member of
 
-[`TransactionError`](/build/api/schema/objects/transaction-error)  <Badge class="secondary" text="object"/>
-
-
+[`TransactionError`](/build/api/schema/objects/transaction-error)  <Badge class="badge badge--secondary" text="object"/>
 
diff --git a/docs/build/api/schema/enums/sort-order.mdx b/docs/build/api/schema/enums/sort-order.mdx
@@ -5,17 +5,43 @@ hide_table_of_contents: false
 ---
 
 
-
 export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
 
 export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
 
-export const Badge = (props) => <><span class={'badge badge--' + props.class}>{props.text}</span></>
+export const Badge = (props) => <><span className={props.class}>{props.text}</span></>
+
+import { useState } from 'react';
+
+export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => {
+  const [open, setOpen] = useState(startOpen);
+  return (
+    <details {...(open ? { open: true } : {})} className="details" style={{ border:'none', boxShadow:'none', background:'var(--ifm-background-color)' }}>
+      <summary
+        onClick={(e) => {
+          e.preventDefault();
+          setOpen((open) => !open);
+        }}
+        style={{ listStyle:'none' }}
+      >
+      {open ? dataOpen : dataClose}
+      </summary>
+      {open && children}
+    </details>
+  );
+};
+
+
+
+
+
+
 
 
 SortOrder represents the order of the result
 possible values are ASC or DESC
 
+
 ```graphql
 enum SortOrder {
   ASC
@@ -24,21 +50,25 @@ enum SortOrder {
 ```
 
 
+
+
 ### Values
 
-#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>ASC</b></code>](#) 
+#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>ASC</b></code>](#)  
+> 
+> 
 > Ascending order
 > 
 
-#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>DESC</b></code>](#) 
+#### [<code style={{ fontWeight: 'normal' }}>SortOrder.<b>DESC</b></code>](#)  
+> 
+> 
 > Descending order
 > 
 
 
 
 ### Member of
 
-[`transactionChain`](/build/api/schema/queries/transaction-chain)  <Badge class="secondary" text="query"/>
-
-
+[`transactionChain`](/build/api/schema/queries/transaction-chain)  <Badge class="badge badge--secondary" text="query"/>
 
diff --git a/docs/build/api/schema/generated.md b/docs/build/api/schema/generated.md
@@ -16,4 +16,4 @@ Use the docs in the sidebar to find out how to use the schema:
 - **Allowed operations**: queries and mutations.
 - **Schema-defined types**: scalars, objects, enums, interfaces, unions, and input objects.
 
-<small><i>Generated on 09/06/2023 13:56:15.</i></small>
+<small><i>Generated on 6/20/2024, 4:15:30 PM.</i></small>
diff --git a/docs/build/api/schema/objects/authorized-key.mdx b/docs/build/api/schema/objects/authorized-key.mdx
@@ -5,17 +5,43 @@ hide_table_of_contents: false
 ---
 
 
-
 export const Bullet = () => <><span style={{ fontWeight: 'normal', fontSize: '.5em', color: 'var(--ifm-color-secondary-darkest)' }}>&nbsp;●&nbsp;</span></>
 
 export const SpecifiedBy = (props) => <>Specification<a className="link" style={{ fontSize:'1.5em', paddingLeft:'4px' }} target="_blank" href={props.url} title={'Specified by ' + props.url}>⎘</a></>
 
-export const Badge = (props) => <><span class={'badge badge--' + props.class}>{props.text}</span></>
+export const Badge = (props) => <><span className={props.class}>{props.text}</span></>
+
+import { useState } from 'react';
+
+export const Details = ({ dataOpen, dataClose, children, startOpen = false }) => {
+  const [open, setOpen] = useState(startOpen);
+  return (
+    <details {...(open ? { open: true } : {})} className="details" style={{ border:'none', boxShadow:'none', background:'var(--ifm-background-color)' }}>
+      <summary
+        onClick={(e) => {
+          e.preventDefault();
+          setOpen((open) => !open);
+        }}
+        style={{ listStyle:'none' }}
+      >
+      {open ? dataOpen : dataClose}
+      </summary>
+      {open && children}
+    </details>
+  );
+};
+
+
+
+
+
+
 
 
 [AuthorizedKey] represents a authorized public key with the encrypted secret key for this given key.
 By decrypting this secret key, the authorized public key will be able to decrypt its related secret
 
+
 ```graphql
 type AuthorizedKey {
   encryptedSecretKey: Hex
@@ -24,21 +50,25 @@ type AuthorizedKey {
 ```
 
 
+
+
 ### Fields
 
-#### [<code style={{ fontWeight: 'normal' }}>AuthorizedKey.<b>encryptedSecretKey</b></code>](#)<Bullet />[`Hex`](/build/api/schema/scalars/hex) <Badge class="secondary" text="scalar"/>
+#### [<code style={{ fontWeight: 'normal' }}>AuthorizedKey.<b>encryptedSecretKey</b></code>](#)<Bullet />[`Hex`](/build/api/schema/scalars/hex) <Badge class="badge badge--secondary" text="scalar"/> 
+> 
+> 
 > 
 > 
 
-#### [<code style={{ fontWeight: 'normal' }}>AuthorizedKey.<b>publicKey</b></code>](#)<Bullet />[`PublicKey`](/build/api/schema/scalars/public-key) <Badge class="secondary" text="scalar"/>
+#### [<code style={{ fontWeight: 'normal' }}>AuthorizedKey.<b>publicKey</b></code>](#)<Bullet />[`PublicKey`](/build/api/schema/scalars/public-key) <Badge class="badge badge--secondary" text="scalar"/> 
+> 
+> 
 > 
 > 
 
 
 
 ### Member of
 
-[`Ownership`](/build/api/schema/objects/ownership)  <Badge class="secondary" text="object"/>
-
-
+[`Ownership`](/build/api/schema/objects/ownership)  <Badge class="badge badge--secondary" text="object"/>