Merge pull request #560 from mozilla/pull-api-definitions

New API definitions
mozilla · Jul 19, 2024 · acd44c7 · acd44c7
2 parents 6fa87f3 + bb962c3
commit acd44c7
Show file tree

Hide file tree

Showing 135 changed files with 9,737 additions and 3 deletions.
diff --git a/api-customs.json b/api-customs.json
diff --git a/api-swagger.json b/api-swagger.json
diff --git a/docs/gql-api/api/_category_.yml b/docs/gql-api/api/_category_.yml
@@ -0,0 +1,6 @@
+label: Api
+position: 1
+className: graphql-markdown-api-section
+link: null
+collapsible: false
+collapsed: false
diff --git a/docs/gql-api/api/directives/_category_.yml b/docs/gql-api/api/directives/_category_.yml
@@ -0,0 +1,5 @@
+label: Directives
+position: 1
+link: null
+collapsible: true
+collapsed: true
diff --git a/docs/gql-api/api/directives/include.mdx b/docs/gql-api/api/directives/include.mdx
@@ -0,0 +1,68 @@
+---
+id: include
+title: include
+---
+
+
+
+
+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 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!`](/gql-api/types/scalars/boolean) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/> 
+> 
+> 
+> Included when true.
+> 
+
+
+
+
+
diff --git a/docs/gql-api/api/directives/skip.mdx b/docs/gql-api/api/directives/skip.mdx
@@ -0,0 +1,68 @@
+---
+id: skip
+title: skip
+---
+
+
+
+
+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 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!`](/gql-api/types/scalars/boolean) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="scalar"/> 
+> 
+> 
+> Skipped when true.
+> 
+
+
+
+
+
diff --git a/docs/gql-api/api/mutations/_category_.yml b/docs/gql-api/api/mutations/_category_.yml
@@ -0,0 +1,5 @@
+label: Mutations
+position: 1
+link: null
+collapsible: true
+collapsed: true
diff --git a/docs/gql-api/api/mutations/account-reset.mdx b/docs/gql-api/api/mutations/account-reset.mdx
@@ -0,0 +1,73 @@
+---
+id: account-reset
+title: accountReset
+---
+
+
+
+
+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 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>
+  );
+};
+
+
+
+
+
+
+
+
+Resets an account
+
+
+```graphql
+accountReset(
+  input: AccountResetInput!
+): AccountResetPayload!
+```
+
+
+
+
+### Arguments
+
+#### [<code style={{ fontWeight: 'normal' }}>accountReset.<b>input</b></code>](#)<Bullet />[`AccountResetInput!`](/gql-api/types/inputs/account-reset-input) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="input"/> 
+> 
+> 
+> 
+> 
+
+### Type
+
+#### [`AccountResetPayload`](/gql-api/types/objects/account-reset-payload) <Badge class="badge badge--secondary" text="object"/> 
+> 
+> 
+> 
+> 
+
+
+
+
+
diff --git a/docs/gql-api/api/mutations/attached-client-disconnect.mdx b/docs/gql-api/api/mutations/attached-client-disconnect.mdx
@@ -0,0 +1,73 @@
+---
+id: attached-client-disconnect
+title: attachedClientDisconnect
+---
+
+
+
+
+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 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>
+  );
+};
+
+
+
+
+
+
+
+
+Destroy all tokens held by a connected client, disconnecting it from the user's account.
+
+
+```graphql
+attachedClientDisconnect(
+  input: AttachedClientDisconnectInput!
+): BasicPayload!
+```
+
+
+
+
+### Arguments
+
+#### [<code style={{ fontWeight: 'normal' }}>attachedClientDisconnect.<b>input</b></code>](#)<Bullet />[`AttachedClientDisconnectInput!`](/gql-api/types/inputs/attached-client-disconnect-input) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="input"/> 
+> 
+> 
+> 
+> 
+
+### Type
+
+#### [`BasicPayload`](/gql-api/types/objects/basic-payload) <Badge class="badge badge--secondary" text="object"/> 
+> 
+> 
+> 
+> 
+
+
+
+
+
diff --git a/docs/gql-api/api/mutations/change-recovery-codes.mdx b/docs/gql-api/api/mutations/change-recovery-codes.mdx
@@ -0,0 +1,73 @@
+---
+id: change-recovery-codes
+title: changeRecoveryCodes
+---
+
+
+
+
+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 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>
+  );
+};
+
+
+
+
+
+
+
+
+Return new backup authentication codes while removing old ones.
+
+
+```graphql
+changeRecoveryCodes(
+  input: ChangeRecoveryCodesInput!
+): ChangeRecoveryCodesPayload!
+```
+
+
+
+
+### Arguments
+
+#### [<code style={{ fontWeight: 'normal' }}>changeRecoveryCodes.<b>input</b></code>](#)<Bullet />[`ChangeRecoveryCodesInput!`](/gql-api/types/inputs/change-recovery-codes-input) <Badge class="badge badge--secondary" text="non-null"/> <Badge class="badge badge--secondary" text="input"/> 
+> 
+> 
+> 
+> 
+
+### Type
+
+#### [`ChangeRecoveryCodesPayload`](/gql-api/types/objects/change-recovery-codes-payload) <Badge class="badge badge--secondary" text="object"/> 
+> 
+> 
+> 
+> 
+
+
+
+
+