Skip to content

Commit

Permalink
Add markdown files for the updated schema
Browse files Browse the repository at this point in the history
  • Loading branch information
palisadoes authored and github-actions[bot] committed Oct 19, 2023
1 parent 152a204 commit 3d221ad
Show file tree
Hide file tree
Showing 8 changed files with 249 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/schema/generated.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 9/20/2023, 2:51:48 PM.</i></small>
<small><i>Generated on 10/19/2023, 3:15:16 PM.</i></small>
75 changes: 75 additions & 0 deletions docs/schema/mutations/create-advertisement.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
id: create-advertisement
title: createAdvertisement
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 className={'badge badge--' + 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>
);
};

No description

```graphql
createAdvertisement(
orgId: ID!
name: String!
link: String!
type: String!
startDate: Date!
endDate: Date!
): Advertisement!
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>createAdvertisement.<b>orgId</b></code>](#)<Bullet />[`ID!`](../../../docs/schema/scalars/id) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>
#### [<code style={{ fontWeight: 'normal' }}>createAdvertisement.<b>name</b></code>](#)<Bullet />[`String!`](../../../docs/schema/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>
#### [<code style={{ fontWeight: 'normal' }}>createAdvertisement.<b>link</b></code>](#)<Bullet />[`String!`](../../../docs/schema/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>
#### [<code style={{ fontWeight: 'normal' }}>createAdvertisement.<b>type</b></code>](#)<Bullet />[`String!`](../../../docs/schema/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>
#### [<code style={{ fontWeight: 'normal' }}>createAdvertisement.<b>startDate</b></code>](#)<Bullet />[`Date!`](../../../docs/schema/scalars/date) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>
#### [<code style={{ fontWeight: 'normal' }}>createAdvertisement.<b>endDate</b></code>](#)<Bullet />[`Date!`](../../../docs/schema/scalars/date) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>
### Type

#### [`Advertisement`](../../../docs/schema/objects/advertisement) <Badge class="secondary" text="object"/>

>
50 changes: 50 additions & 0 deletions docs/schema/mutations/remove-advertisement.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
id: remove-advertisement
title: removeAdvertisement
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 className={'badge badge--' + 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>
);
};

No description

```graphql
removeAdvertisement(
id: ID!
): Advertisement
```

### Arguments

#### [<code style={{ fontWeight: 'normal' }}>removeAdvertisement.<b>id</b></code>](#)<Bullet />[`ID!`](../../../docs/schema/scalars/id) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>
### Type

#### [`Advertisement`](../../../docs/schema/objects/advertisement) <Badge class="secondary" text="object"/>

>
78 changes: 78 additions & 0 deletions docs/schema/objects/advertisement.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
id: advertisement
title: Advertisement
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 className={'badge badge--' + 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>
);
};

No description

```graphql
type Advertisement {
_id: ID
name: String!
orgId: ID
link: String!
type: String!
startDate: Date!
endDate: Date!
}
```

### Fields

#### [<code style={{ fontWeight: 'normal' }}>Advertisement.<b>\_id</b></code>](#)<Bullet />[`ID`](../../../docs/schema/scalars/id) <Badge class="secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>Advertisement.<b>name</b></code>](#)<Bullet />[`String!`](../../../docs/schema/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>Advertisement.<b>orgId</b></code>](#)<Bullet />[`ID`](../../../docs/schema/scalars/id) <Badge class="secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>Advertisement.<b>link</b></code>](#)<Bullet />[`String!`](../../../docs/schema/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>Advertisement.<b>type</b></code>](#)<Bullet />[`String!`](../../../docs/schema/scalars/string) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>Advertisement.<b>startDate</b></code>](#)<Bullet />[`Date!`](../../../docs/schema/scalars/date) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>

#### [<code style={{ fontWeight: 'normal' }}>Advertisement.<b>endDate</b></code>](#)<Bullet />[`Date!`](../../../docs/schema/scalars/date) <Badge class="secondary" text="non-null"/> <Badge class="secondary" text="scalar"/>

>

### Returned by

[`createAdvertisement`](../../../docs/schema/mutations/create-advertisement) <Badge class="secondary" text="mutation"/><Bullet />[`getAdvertisements`](../../../docs/schema/queries/get-advertisements) <Badge class="secondary" text="query"/><Bullet />[`removeAdvertisement`](../../../docs/schema/mutations/remove-advertisement) <Badge class="secondary" text="mutation"/>
42 changes: 42 additions & 0 deletions docs/schema/queries/get-advertisements.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
id: get-advertisements
title: getAdvertisements
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 className={'badge badge--' + 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>
);
};

No description

```graphql
getAdvertisements: [Advertisement]
```

### Type

#### [`Advertisement`](../../../docs/schema/objects/advertisement) <Badge class="secondary" text="object"/>

>
2 changes: 1 addition & 1 deletion docs/schema/scalars/date.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,4 @@ scalar Date

### Member of

[`Event`](../../../docs/schema/objects/event) <Badge class="secondary" text="object"/><Bullet />[`EventInput`](../../../docs/schema/inputs/event-input) <Badge class="secondary" text="input"/><Bullet />[`UpdateEventInput`](../../../docs/schema/inputs/update-event-input) <Badge class="secondary" text="input"/>
[`Advertisement`](../../../docs/schema/objects/advertisement) <Badge class="secondary" text="object"/><Bullet />[`createAdvertisement`](../../../docs/schema/mutations/create-advertisement) <Badge class="secondary" text="mutation"/><Bullet />[`Event`](../../../docs/schema/objects/event) <Badge class="secondary" text="object"/><Bullet />[`EventInput`](../../../docs/schema/inputs/event-input) <Badge class="secondary" text="input"/><Bullet />[`UpdateEventInput`](../../../docs/schema/inputs/update-event-input) <Badge class="secondary" text="input"/>
Loading

0 comments on commit 3d221ad

Please sign in to comment.