-
Notifications
You must be signed in to change notification settings - Fork 164
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add markdown files for the updated schema
- Loading branch information
1 parent
152a204
commit 3d221ad
Showing
8 changed files
with
249 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)' }}> ● </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"/> | ||
|
||
> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)' }}> ● </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"/> | ||
|
||
> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)' }}> ● </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"/> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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)' }}> ● </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"/> | ||
|
||
> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.