diff --git a/src/components/ComponentFactory.js b/src/components/ComponentFactory.js index 280e2d079..c7f2533f2 100644 --- a/src/components/ComponentFactory.js +++ b/src/components/ComponentFactory.js @@ -46,7 +46,6 @@ import LiteralInclude from './LiteralInclude'; import Meta from './Meta'; import MongoWebShell from './MongoWebShell'; import OpenAPI from './OpenAPI'; -import Operation from './Operation'; import Paragraph from './Paragraph'; import Procedure from './Procedure'; import QuizChoice from './Widgets/QuizWidget/QuizChoice'; @@ -173,7 +172,6 @@ const componentMap = { 'mongo-web-shell': MongoWebShell, only: Cond, openapi: OpenAPI, - operation: Operation, paragraph: Paragraph, procedure: Procedure, quiz: QuizWidget, diff --git a/src/components/Operation.js b/src/components/Operation.js deleted file mode 100644 index e8b448f11..000000000 --- a/src/components/Operation.js +++ /dev/null @@ -1,200 +0,0 @@ -import React, { useCallback, useEffect, useState } from 'react'; -import PropTypes from 'prop-types'; -import { css } from '@emotion/react'; -import styled from '@emotion/styled'; -import { useLocation } from '@reach/router'; -import Badge from '@leafygreen-ui/badge'; -import Card from '@leafygreen-ui/card'; -import { css as LeafygreenCss, cx } from '@leafygreen-ui/emotion'; -import Icon from '@leafygreen-ui/icon'; -import IconButton from '@leafygreen-ui/icon-button'; -import { palette } from '@leafygreen-ui/palette'; -import ComponentFactory from './ComponentFactory'; -import CopyButton from './CopyButton'; -import { getNestedValue } from '../utils/get-nested-value'; -import { theme } from '../theme/docsTheme'; - -// Bold path parameters (sections that appear between braces) -// Add zero-width spaces after forward slashes so that linebreak occurs after a slash, not within a word -const formatPath = (str) => { - const betweenBraces = new RegExp(/(\{)[^}]+(\})/, 'g'); - return str.replace(/\//g, `/​`).replace(betweenBraces, (match) => `${match}`); -}; - -const methodBadgeMap = { - GET: 'blue', - POST: 'green', - DELETE: 'red', - PUT: 'yellow', - PATCH: 'yellow', -}; - -// Identify the text node to display on the collapsed card -// If present, show the operation summary. If no summary, show description. -// Otherwise, show nothing. -const splitChildren = (children) => { - if (children.length === 0) { - return [null, children]; - } - - // Check for a summary - const firstChild = children[0]; - if (firstChild.type === 'paragraph') { - return [firstChild, children.slice(1)]; - } - - // If no summary exists, check for a description field - if (getNestedValue(['children', 0, 'id'], firstChild) === 'description') { - const description = getNestedValue(['children', 1], firstChild); - return [description, children.slice(1)]; - } - return [null, children]; -}; - -// Move up to improve alignment with text baseline -const iconAdjust = css` - top: -5px; -`; - -const cardStyling = LeafygreenCss` - padding: 0; - margin-bottom: ${theme.size.default}; - overflow: hidden; -`; - -const OperationHeader = styled('div')` - align-items: baseline; - background-color: ${palette.gray.light3}; - display: flex; - flex-direction: row; - justify-content: space-between; - padding: ${theme.size.default} ${theme.size.large}; - - & > *:not(:last-child) { - margin-right: ${theme.size.default}; - } - - @media ${theme.screenSize.upToSmall} { - padding: ${theme.size.default}; - } -`; - -const Path = styled('code')` - color: ${palette.black}; - - @media ${theme.screenSize.upToSmall} { - word-break: break-all; - } -`; - -const bodyMargins = ({ theme }) => css` - margin: ${theme.size.medium} ${theme.size.large}; - - @media ${theme.screenSize.upToSmall} { - margin: ${theme.size.default}; - } -`; - -// Truncate text after two lines when the card is collapsed -const clampText = ({ showDetails }) => css` - ${!showDetails && - ` - & > p { - display: -webkit-box; - -webkit-line-clamp: 2; - -webkit-box-orient: vertical; - overflow: hidden; - } - `} -`; - -const Description = styled('div')` - ${bodyMargins({ theme })}; - ${({ showDetails }) => clampText({ showDetails })}; -`; - -const Details = styled('div')` - ${bodyMargins({ theme })}; - & > section { - margin-bottom: ${theme.size.large}; - } -`; - -const Operation = ({ - nodeData: { - children, - options: { hash, method, path }, - }, - ...rest -}) => { - const [showDetails, setShowDetails] = useState(false); - const [description, details] = splitChildren(children); - method = method.toUpperCase(); - const { hash: windowHash } = useLocation(); - - useEffect(() => { - if (windowHash && hash === decodeURI(windowHash).slice(1)) { - setShowDetails(true); - } - }, [hash, windowHash]); - - const toggleDrawer = useCallback(() => { - window.history.pushState({ href: hash }, '', `#${encodeURI(hash)}`); - setShowDetails(!showDetails); - }, [hash, setShowDetails, showDetails]); - - return ( - - - {method} -
- - - - -
- - - -
- {description && ( - - - - )} - {showDetails && ( -
- {details.map((child, index) => ( - - ))} -
- )} -
- ); -}; - -Operation.propTypes = { - nodeData: PropTypes.shape({ - children: PropTypes.array, - options: PropTypes.shape({ - hash: PropTypes.string.isRequired, - method: PropTypes.string.isRequired, - path: PropTypes.string.isRequired, - }).isRequired, - }).isRequired, -}; - -export default Operation; diff --git a/tests/unit/Operation.test.js b/tests/unit/Operation.test.js deleted file mode 100644 index 57b77c64f..000000000 --- a/tests/unit/Operation.test.js +++ /dev/null @@ -1,93 +0,0 @@ -import React from 'react'; -import { render } from '@testing-library/react'; -import userEvent from '@testing-library/user-event'; -import * as reachRouter from '@reach/router'; -import Operation from '../../src/components/Operation'; - -// data for this component -import { onlyDescription, neitherSummaryNorDescription, bothSummaryAndDescription } from './data/Operation.test.json'; - -const shallowOperation = (data) => - render( - - - - ); - -const mockLocation = (hash) => jest.spyOn(reachRouter, 'useLocation').mockImplementation(() => ({ hash })); - -describe('when rendering all fields', () => { - beforeAll(() => { - mockLocation(null); - }); - - it('renders correctly ', () => { - const wrapper = shallowOperation(bothSummaryAndDescription); - expect(wrapper.asFragment()).toMatchSnapshot(); - }); - - describe('when the component is loaded', () => { - it('does not expand the card on load', () => { - const wrapper = shallowOperation(bothSummaryAndDescription); - expect(wrapper.queryAllByText('Description').length).toBe(0); - }); - - describe('when the expand button is clicked', () => { - beforeAll(() => { - window.history.pushState = jest.fn(); - }); - - it('the card expands', () => { - const wrapper = shallowOperation(bothSummaryAndDescription); - userEvent.click(wrapper.getByLabelText('Show operation details')); - expect(wrapper.queryAllByText('Description')).toBeTruthy(); - }); - - it('appends the hash to the URL', () => { - const wrapper = shallowOperation(bothSummaryAndDescription); - userEvent.click(wrapper.getByLabelText('Show operation details')); - expect(window.history.pushState).toBeCalledWith({ href: 'get-/auth/profile' }, '', '#get-/auth/profile'); - }); - }); - }); -}); - -describe('when no summary is present', () => { - let wrapper; - - beforeAll(() => { - mockLocation(null); - }); - - it('renders correctly ', () => { - wrapper = shallowOperation(onlyDescription); - expect(wrapper.asFragment()).toMatchSnapshot(); - }); - - it('does not show the "Description" section', () => { - wrapper = shallowOperation(onlyDescription); - expect(wrapper.queryAllByText('Description')).toBeTruthy(); - }); -}); - -describe('when no summary or description is present', () => { - beforeAll(() => { - mockLocation(null); - }); - - it('renders correctly ', () => { - let wrapper = shallowOperation(neitherSummaryNorDescription); - expect(wrapper.asFragment()).toMatchSnapshot(); - }); -}); - -describe('when a page is loaded with its hash set', () => { - beforeAll(() => { - mockLocation('#get-/auth/providers'); - }); - - it('automatically expands the card', () => { - let wrapper = shallowOperation(onlyDescription); - expect(wrapper.queryAllByText('Details')).toBeTruthy(); - }); -}); diff --git a/tests/unit/__snapshots__/Operation.test.js.snap b/tests/unit/__snapshots__/Operation.test.js.snap deleted file mode 100644 index fba4b1d61..000000000 --- a/tests/unit/__snapshots__/Operation.test.js.snap +++ /dev/null @@ -1,923 +0,0 @@ -// Jest Snapshot v1, https://goo.gl/fbAQLP - -exports[`when no summary is present renders correctly 1`] = ` - - .emotion-0 { - position: relative; - -webkit-transition: 150ms ease-in-out; - transition: 150ms ease-in-out; - transition-property: border,box-shadow; - border: 1px solid #E8EDEB; - box-shadow: 0 4px 10px -4px rgba(0,30,43,0.3); - background-color: white; - color: #1C2D38; - border-radius: 24px; - font-family: 'Euclid Circular A',Akzidenz,'Helvetica Neue',Helvetica,Arial,sans-serif; - font-size: 13px; - line-height: 20px; - padding: 24px; - min-height: 68px; - padding: 0; - margin-bottom: 16px; - overflow: hidden; -} - -.emotion-1 { - -webkit-align-items: baseline; - -webkit-box-align: baseline; - -ms-flex-align: baseline; - align-items: baseline; - background-color: #F9FBFA; - display: -webkit-box; - display: -webkit-flex; - display: -ms-flexbox; - display: flex; - -webkit-flex-direction: row; - -ms-flex-direction: row; - flex-direction: row; - -webkit-box-pack: justify; - -webkit-justify-content: space-between; - justify-content: space-between; - padding: 16px 32px; -} - -.emotion-1>*:not(:last-child) { - margin-right: 16px; -} - -@media only screen and (max-width: 480px) { - .emotion-1 { - padding: 16px; - } -} - -.emotion-3 { - font-family: Euclid Circular A,‘Helvetica Neue’,Helvetica,Arial,sans-serif; - display: -webkit-inline-box; - display: -webkit-inline-flex; - display: -ms-inline-flexbox; - display: inline-flex; - -webkit-align-items: center; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; - font-weight: 700; - font-size: 12px; - line-height: 16px; - border-radius: 5px; - height: 18px; - padding-left: 6px; - padding-right: 6px; - text-transform: uppercase; - border: 1px solid; - letter-spacing: 1px; - background-color: #E1F7FF; - border-color: #C3E7FE; - color: #1254B7; -} - -.emotion-4 { - color: #001E2B; -} - -@media only screen and (max-width: 480px) { - .emotion-4 { - word-break: break-all; - } -} - -.emotion-6 { - top: -5px; - margin-left: 4px; - position: relative; -} - -.emotion-7 { - -webkit-align-self: center; - -ms-flex-item-align: center; - align-self: center; - color: #889397; -} - -.emotion-8 { - border: none; - -webkit-appearance: unset; - padding: unset; - display: inline-block; - border-radius: 100px; - color: #89979B; - position: relative; - cursor: pointer; - -webkit-flex-shrink: 0; - -ms-flex-negative: 0; - flex-shrink: 0; - -webkit-transition: color 150ms ease-in-out; - transition: color 150ms ease-in-out; - background-color: rgba(255, 255, 255, 0); - height: 28px; - width: 28px; -} - -.emotion-8:before { - content: ''; - -webkit-transition: 150ms all ease-in-out; - transition: 150ms all ease-in-out; - position: absolute; - top: 0; - bottom: 0; - left: 0; - right: 0; - border-radius: 100%; - opacity: 0; - -webkit-transform: scale(0.8); - -moz-transform: scale(0.8); - -ms-transform: scale(0.8); - transform: scale(0.8); -} - -.emotion-8:active:before, -.emotion-8:hover:before, -.emotion-8:focus:before { - opacity: 1; - -webkit-transform: scale(1); - -moz-transform: scale(1); - -ms-transform: scale(1); - transform: scale(1); -} - -.emotion-8:focus { - outline: none; -} - -.emotion-8:active, -.emotion-8:hover { - color: #3D4F58; -} - -.emotion-8:active:before, -.emotion-8:hover:before { - background-color: #E7EEEC; -} - -.emotion-8:focus { - color: #1A567E; -} - -.emotion-8:focus:before { - background-color: #C5E4F2; -} - -.emotion-9 { - position: absolute; - top: 0; - bottom: 0; - left: 0; - right: 0; - display: -webkit-box; - display: -webkit-flex; - display: -ms-flexbox; - display: flex; - -webkit-align-items: center; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; - -webkit-box-pack: center; - -ms-flex-pack: center; - -webkit-justify-content: center; - justify-content: center; -} - -.emotion-10 { - top: -5px; - margin-left: auto; -} - -.emotion-13 { - margin: 24px 32px; -} - -@media only screen and (max-width: 480px) { - .emotion-13 { - margin: 16px; - } -} - -.emotion-13>p { - display: -webkit-box; - -webkit-line-clamp: 2; - -webkit-box-orient: vertical; - overflow: hidden; -} - -.emotion-15 { - margin: unset; - font-family: 'Euclid Circular A',Akzidenz,'Helvetica Neue',Helvetica,Arial,sans-serif; - color: #001E2B; - font-size: 13px; - line-height: 20px; - color: #001E2B; - font-weight: 400; - margin-bottom: 16px; -} - -.emotion-15 strong, -.emotion-15 b { - font-weight: 700; -} - -
-
-
- GET -
-
- - /​auth/​providers - - - - -
- -
-
-

- This is a description. Lorem ipsum dolor sit amet, consectetur adipiscing -elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. -Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi -ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit -in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur -sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt -mollit anim id est laborum. -

-
-
-
-`; - -exports[`when no summary or description is present renders correctly 1`] = ` - - .emotion-0 { - position: relative; - -webkit-transition: 150ms ease-in-out; - transition: 150ms ease-in-out; - transition-property: border,box-shadow; - border: 1px solid #E8EDEB; - box-shadow: 0 4px 10px -4px rgba(0,30,43,0.3); - background-color: white; - color: #1C2D38; - border-radius: 24px; - font-family: 'Euclid Circular A',Akzidenz,'Helvetica Neue',Helvetica,Arial,sans-serif; - font-size: 13px; - line-height: 20px; - padding: 24px; - min-height: 68px; - padding: 0; - margin-bottom: 16px; - overflow: hidden; -} - -.emotion-1 { - -webkit-align-items: baseline; - -webkit-box-align: baseline; - -ms-flex-align: baseline; - align-items: baseline; - background-color: #F9FBFA; - display: -webkit-box; - display: -webkit-flex; - display: -ms-flexbox; - display: flex; - -webkit-flex-direction: row; - -ms-flex-direction: row; - flex-direction: row; - -webkit-box-pack: justify; - -webkit-justify-content: space-between; - justify-content: space-between; - padding: 16px 32px; -} - -.emotion-1>*:not(:last-child) { - margin-right: 16px; -} - -@media only screen and (max-width: 480px) { - .emotion-1 { - padding: 16px; - } -} - -.emotion-3 { - font-family: Euclid Circular A,‘Helvetica Neue’,Helvetica,Arial,sans-serif; - display: -webkit-inline-box; - display: -webkit-inline-flex; - display: -ms-inline-flexbox; - display: inline-flex; - -webkit-align-items: center; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; - font-weight: 700; - font-size: 12px; - line-height: 16px; - border-radius: 5px; - height: 18px; - padding-left: 6px; - padding-right: 6px; - text-transform: uppercase; - border: 1px solid; - letter-spacing: 1px; - background-color: #E3FCF7; - border-color: #C0FAE6; - color: #00684A; -} - -.emotion-4 { - color: #001E2B; -} - -@media only screen and (max-width: 480px) { - .emotion-4 { - word-break: break-all; - } -} - -.emotion-6 { - top: -5px; - margin-left: 4px; - position: relative; -} - -.emotion-7 { - -webkit-align-self: center; - -ms-flex-item-align: center; - align-self: center; - color: #889397; -} - -.emotion-8 { - border: none; - -webkit-appearance: unset; - padding: unset; - display: inline-block; - border-radius: 100px; - color: #89979B; - position: relative; - cursor: pointer; - -webkit-flex-shrink: 0; - -ms-flex-negative: 0; - flex-shrink: 0; - -webkit-transition: color 150ms ease-in-out; - transition: color 150ms ease-in-out; - background-color: rgba(255, 255, 255, 0); - height: 28px; - width: 28px; -} - -.emotion-8:before { - content: ''; - -webkit-transition: 150ms all ease-in-out; - transition: 150ms all ease-in-out; - position: absolute; - top: 0; - bottom: 0; - left: 0; - right: 0; - border-radius: 100%; - opacity: 0; - -webkit-transform: scale(0.8); - -moz-transform: scale(0.8); - -ms-transform: scale(0.8); - transform: scale(0.8); -} - -.emotion-8:active:before, -.emotion-8:hover:before, -.emotion-8:focus:before { - opacity: 1; - -webkit-transform: scale(1); - -moz-transform: scale(1); - -ms-transform: scale(1); - transform: scale(1); -} - -.emotion-8:focus { - outline: none; -} - -.emotion-8:active, -.emotion-8:hover { - color: #3D4F58; -} - -.emotion-8:active:before, -.emotion-8:hover:before { - background-color: #E7EEEC; -} - -.emotion-8:focus { - color: #1A567E; -} - -.emotion-8:focus:before { - background-color: #C5E4F2; -} - -.emotion-9 { - position: absolute; - top: 0; - bottom: 0; - left: 0; - right: 0; - display: -webkit-box; - display: -webkit-flex; - display: -ms-flexbox; - display: flex; - -webkit-align-items: center; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; - -webkit-box-pack: center; - -ms-flex-pack: center; - -webkit-justify-content: center; - justify-content: center; -} - -.emotion-10 { - top: -5px; - margin-left: auto; -} - -
-
-
- POST -
-
- - /​auth/​providers/​ - - {provider} - - /​login - - - - -
- -
-
-
-`; - -exports[`when rendering all fields renders correctly 1`] = ` - - .emotion-0 { - position: relative; - -webkit-transition: 150ms ease-in-out; - transition: 150ms ease-in-out; - transition-property: border,box-shadow; - border: 1px solid #E8EDEB; - box-shadow: 0 4px 10px -4px rgba(0,30,43,0.3); - background-color: white; - color: #1C2D38; - border-radius: 24px; - font-family: 'Euclid Circular A',Akzidenz,'Helvetica Neue',Helvetica,Arial,sans-serif; - font-size: 13px; - line-height: 20px; - padding: 24px; - min-height: 68px; - padding: 0; - margin-bottom: 16px; - overflow: hidden; -} - -.emotion-1 { - -webkit-align-items: baseline; - -webkit-box-align: baseline; - -ms-flex-align: baseline; - align-items: baseline; - background-color: #F9FBFA; - display: -webkit-box; - display: -webkit-flex; - display: -ms-flexbox; - display: flex; - -webkit-flex-direction: row; - -ms-flex-direction: row; - flex-direction: row; - -webkit-box-pack: justify; - -webkit-justify-content: space-between; - justify-content: space-between; - padding: 16px 32px; -} - -.emotion-1>*:not(:last-child) { - margin-right: 16px; -} - -@media only screen and (max-width: 480px) { - .emotion-1 { - padding: 16px; - } -} - -.emotion-3 { - font-family: Euclid Circular A,‘Helvetica Neue’,Helvetica,Arial,sans-serif; - display: -webkit-inline-box; - display: -webkit-inline-flex; - display: -ms-inline-flexbox; - display: inline-flex; - -webkit-align-items: center; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; - font-weight: 700; - font-size: 12px; - line-height: 16px; - border-radius: 5px; - height: 18px; - padding-left: 6px; - padding-right: 6px; - text-transform: uppercase; - border: 1px solid; - letter-spacing: 1px; - background-color: #E1F7FF; - border-color: #C3E7FE; - color: #1254B7; -} - -.emotion-4 { - color: #001E2B; -} - -@media only screen and (max-width: 480px) { - .emotion-4 { - word-break: break-all; - } -} - -.emotion-6 { - top: -5px; - margin-left: 4px; - position: relative; -} - -.emotion-7 { - -webkit-align-self: center; - -ms-flex-item-align: center; - align-self: center; - color: #889397; -} - -.emotion-8 { - border: none; - -webkit-appearance: unset; - padding: unset; - display: inline-block; - border-radius: 100px; - color: #89979B; - position: relative; - cursor: pointer; - -webkit-flex-shrink: 0; - -ms-flex-negative: 0; - flex-shrink: 0; - -webkit-transition: color 150ms ease-in-out; - transition: color 150ms ease-in-out; - background-color: rgba(255, 255, 255, 0); - height: 28px; - width: 28px; -} - -.emotion-8:before { - content: ''; - -webkit-transition: 150ms all ease-in-out; - transition: 150ms all ease-in-out; - position: absolute; - top: 0; - bottom: 0; - left: 0; - right: 0; - border-radius: 100%; - opacity: 0; - -webkit-transform: scale(0.8); - -moz-transform: scale(0.8); - -ms-transform: scale(0.8); - transform: scale(0.8); -} - -.emotion-8:active:before, -.emotion-8:hover:before, -.emotion-8:focus:before { - opacity: 1; - -webkit-transform: scale(1); - -moz-transform: scale(1); - -ms-transform: scale(1); - transform: scale(1); -} - -.emotion-8:focus { - outline: none; -} - -.emotion-8:active, -.emotion-8:hover { - color: #3D4F58; -} - -.emotion-8:active:before, -.emotion-8:hover:before { - background-color: #E7EEEC; -} - -.emotion-8:focus { - color: #1A567E; -} - -.emotion-8:focus:before { - background-color: #C5E4F2; -} - -.emotion-9 { - position: absolute; - top: 0; - bottom: 0; - left: 0; - right: 0; - display: -webkit-box; - display: -webkit-flex; - display: -ms-flexbox; - display: flex; - -webkit-align-items: center; - -webkit-box-align: center; - -ms-flex-align: center; - align-items: center; - -webkit-box-pack: center; - -ms-flex-pack: center; - -webkit-justify-content: center; - justify-content: center; -} - -.emotion-10 { - top: -5px; - margin-left: auto; -} - -.emotion-13 { - margin: 24px 32px; -} - -@media only screen and (max-width: 480px) { - .emotion-13 { - margin: 16px; - } -} - -.emotion-13>p { - display: -webkit-box; - -webkit-line-clamp: 2; - -webkit-box-orient: vertical; - overflow: hidden; -} - -.emotion-15 { - margin: unset; - font-family: 'Euclid Circular A',Akzidenz,'Helvetica Neue',Helvetica,Arial,sans-serif; - color: #001E2B; - font-size: 13px; - line-height: 20px; - color: #001E2B; - font-weight: 400; - margin-bottom: 16px; -} - -.emotion-15 strong, -.emotion-15 b { - font-weight: 700; -} - -
-
-
- GET -
-
- - /​auth/​profile - - - - -
- -
-
-

- Get information about the currently logged in user. -

-
-
-
-`; diff --git a/tests/unit/data/Operation.test.json b/tests/unit/data/Operation.test.json deleted file mode 100644 index ad3441dec..000000000 --- a/tests/unit/data/Operation.test.json +++ /dev/null @@ -1,5686 +0,0 @@ -{ - "onlyDescription": { - "type": "directive", - "position": { - "start": { - "line": 13 - } - }, - "children": [ - { - "type": "section", - "position": { - "start": { - "line": 21 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 21 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 21 - } - }, - "value": "Description" - } - ], - "id": "description" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 23 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 23 - } - }, - "value": "This is a description. Lorem ipsum dolor sit amet, consectetur adipiscing\nelit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.\nUt enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi\nut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit\nin voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur\nsint occaecat cupidatat non proident, sunt in culpa qui officia deserunt\nmollit anim id est laborum." - } - ] - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 42 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 42 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 42 - } - }, - "value": "Responses" - } - ], - "id": "responses" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 44 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 44 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 44 - } - }, - "value": "200" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 44 - } - }, - "value": ": Successfully enumerated available authentication providers." - } - ] - }, - { - "type": "code", - "position": { - "start": { - "line": 46 - } - }, - "lang": "json", - "copyable": true, - "emphasize_lines": [], - "value": "[\n {\n \"_id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"disabled\": \"boolean\"\n }\n]", - "linenos": false - }, - { - "type": "directive", - "position": { - "start": { - "line": 57 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 61 - } - }, - "value": "Field" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 62 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 62 - } - }, - "value": "Type" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 63 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 63 - } - }, - "value": "Description" - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 66 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 66 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 66 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 66 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 66 - } - }, - "value": "[]" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 66 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 67 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 67 - } - }, - "value": "array of objects" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 66 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 68 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 68 - } - }, - "value": "An array of authentication providers." - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 69 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 69 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 69 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 69 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 69 - } - }, - "value": "[]._id" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 69 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 70 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 70 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 69 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 72 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 72 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 72 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 72 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 72 - } - }, - "value": "[].name" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 72 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 73 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 73 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 72 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 75 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 75 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 75 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 75 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 75 - } - }, - "value": "[].type" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 75 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 76 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 76 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 75 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 79 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 79 - } - }, - "value": "Possible Values:" - } - ] - }, - { - "type": "list", - "position": { - "start": { - "line": 81 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 81 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 81 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 81 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 81 - } - }, - "value": "mongodb-cloud" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 81 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 83 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 83 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 83 - } - }, - "value": "local" - } - ] - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 61 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 86 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 86 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 86 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 86 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 86 - } - }, - "value": "[].disabled" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 86 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 87 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 87 - } - }, - "value": "boolean" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 86 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ], - "domain": "", - "name": "list-table", - "argument": [], - "options": { - "header-rows": 1, - "widths": "35 15 50" - } - } - ] - } - ], - "domain": "", - "name": "operation", - "argument": [], - "options": { - "hash": "get-/auth/providers", - "method": "get", - "path": "/auth/providers" - } - }, - "neitherSummaryNorDescription": { - "type": "directive", - "position": { - "start": { - "line": 91 - } - }, - "children": [ - { - "type": "section", - "position": { - "start": { - "line": 101 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 101 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 101 - } - }, - "value": "Path Parameters" - } - ], - "id": "path-parameters" - }, - { - "type": "directive", - "position": { - "start": { - "line": 103 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 107 - } - }, - "value": "Name" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 108 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 108 - } - }, - "value": "Type" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 109 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 109 - } - }, - "value": "Necessity" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 110 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 110 - } - }, - "value": "Description" - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 107 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 113 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 113 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 113 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 113 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 113 - } - }, - "value": "provider" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 113 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 114 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 114 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 113 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 115 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 115 - } - }, - "value": "required" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 113 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 116 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 116 - } - }, - "value": "The authentication provider to use." - } - ] - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 118 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 118 - } - }, - "value": "Possible Values:" - } - ] - }, - { - "type": "list", - "position": { - "start": { - "line": 120 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 120 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 120 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 120 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 120 - } - }, - "value": "mongodb-cloud" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 120 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 122 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 122 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 122 - } - }, - "value": "local" - } - ] - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ], - "domain": "", - "name": "list-table", - "argument": [], - "options": { - "header-rows": 1, - "widths": "20 15 15 50" - } - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 135 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 135 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 135 - } - }, - "value": "Request Body " - }, - { - "type": "role", - "position": { - "start": { - "line": 135 - } - }, - "children": [], - "domain": "", - "name": "required", - "target": "True", - "flag": "" - } - ], - "id": "request-body" - }, - { - "type": "code", - "position": { - "start": { - "line": 139 - } - }, - "lang": "json", - "copyable": true, - "emphasize_lines": [], - "value": "{\n \"username\": \"string\",\n \"apiKey\": \"string\"\n}", - "linenos": false - }, - { - "type": "directive", - "position": { - "start": { - "line": 146 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 150 - } - }, - "value": "Field" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 151 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 151 - } - }, - "value": "Type" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 152 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 152 - } - }, - "value": "Necessity" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 153 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 153 - } - }, - "value": "Description" - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 156 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 156 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 156 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 156 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 156 - } - }, - "value": "username" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 156 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 157 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 157 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 156 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 158 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 158 - } - }, - "value": "required" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 156 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 150 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 161 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 161 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 161 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 161 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 161 - } - }, - "value": "apiKey" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 161 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 162 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 162 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 161 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 163 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 163 - } - }, - "value": "required" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 161 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ], - "domain": "", - "name": "list-table", - "argument": [], - "options": { - "header-rows": 1, - "widths": "20 15 15 50" - } - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 168 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 168 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 168 - } - }, - "value": "Responses" - } - ], - "id": "id1" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 170 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 170 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 170 - } - }, - "value": "200" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 170 - } - }, - "value": ": Authentication was successful." - } - ] - }, - { - "type": "code", - "position": { - "start": { - "line": 172 - } - }, - "lang": "json", - "copyable": true, - "emphasize_lines": [], - "value": "{\n \"access_token\": \"string\",\n \"refresh_token\": \"string\",\n \"user_id\": \"string\",\n \"device_id\": \"string\"\n}", - "linenos": false - }, - { - "type": "directive", - "position": { - "start": { - "line": 181 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 185 - } - }, - "value": "Field" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 186 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 186 - } - }, - "value": "Type" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 187 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 187 - } - }, - "value": "Description" - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 190 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 190 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 190 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 190 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 190 - } - }, - "value": "access_token" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 190 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 191 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 191 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 190 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 192 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 192 - } - }, - "value": "An access token you may provide in the" - } - ] - } - ] - } - ], - "enumtype": "unordered" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 193 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 193 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 193 - } - }, - "value": "Authorization" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 193 - } - }, - "value": " header of API requests.\n" - }, - { - "type": "ref_role", - "position": { - "start": { - "line": 193 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 193 - } - }, - "value": "API Authentication" - } - ], - "domain": "std", - "name": "label", - "target": "realm-api-authentication", - "flag": "", - "fileid": "admin/api/v3" - }, - { - "type": "text", - "position": { - "start": { - "line": 193 - } - }, - "value": " demonstrates how to\nuse this token." - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 197 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 197 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 197 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 197 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 197 - } - }, - "value": "refresh_token" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 197 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 198 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 198 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 197 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 199 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 199 - } - }, - "value": "A refresh token you may provide in the " - }, - { - "type": "literal", - "position": { - "start": { - "line": 199 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 199 - } - }, - "value": "Authorization" - } - ] - } - ] - } - ] - } - ], - "enumtype": "unordered" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 200 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 200 - } - }, - "value": "header of " - }, - { - "type": "ref_role", - "position": { - "start": { - "line": 200 - } - }, - "children": [], - "domain": "std", - "name": "label", - "target": "post-/auth/session", - "flag": "" - }, - { - "type": "text", - "position": { - "start": { - "line": 200 - } - }, - "value": " to obtain a new\n" - }, - { - "type": "literal", - "position": { - "start": { - "line": 200 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 200 - } - }, - "value": "access_token" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 200 - } - }, - "value": " for the current user session." - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 203 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 203 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 203 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 203 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 203 - } - }, - "value": "user_id" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 203 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 204 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 204 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 203 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 205 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 205 - } - }, - "value": "The unique _id value of the MongoDB Cloud user." - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 185 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 206 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 206 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 206 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 206 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 206 - } - }, - "value": "device_id" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 206 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 207 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 207 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 206 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ], - "domain": "", - "name": "list-table", - "argument": [], - "options": { - "header-rows": 1, - "widths": "35 15 50" - } - } - ] - } - ], - "domain": "", - "name": "operation", - "argument": [], - "options": { - "hash": "post-/auth/providers/{provider}/login", - "method": "post", - "path": "/auth/providers/{provider}/login" - } - }, - "bothSummaryAndDescription": { - "type": "directive", - "position": { - "start": { - "line": 211 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 216 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 216 - } - }, - "value": "Get information about the currently logged in user." - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 219 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 219 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 219 - } - }, - "value": "Description" - } - ], - "id": "id2" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 221 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 221 - } - }, - "value": "This is a description that accompanies the summary." - } - ] - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 230 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 230 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 230 - } - }, - "value": "Header Parameters" - } - ], - "id": "header-parameters" - }, - { - "type": "directive", - "position": { - "start": { - "line": 232 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 236 - } - }, - "value": "Name" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 237 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 237 - } - }, - "value": "Type" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 238 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 238 - } - }, - "value": "Necessity" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 239 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 239 - } - }, - "value": "Description" - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 236 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 242 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 242 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 242 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 242 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 242 - } - }, - "value": "Authorization" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 242 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 243 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 243 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 242 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 244 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 244 - } - }, - "value": "required" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 242 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 245 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 245 - } - }, - "value": "The authorization token provided in the " - }, - { - "type": "literal", - "position": { - "start": { - "line": 245 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 245 - } - }, - "value": "access_token" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 245 - } - }, - "value": " field of" - } - ] - } - ] - } - ], - "enumtype": "unordered" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 246 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 246 - } - }, - "value": "the " - }, - { - "type": "ref_role", - "position": { - "start": { - "line": 246 - } - }, - "children": [], - "domain": "std", - "name": "label", - "target": "post-/auth/providers/{provider}/login", - "flag": "" - }, - { - "type": "text", - "position": { - "start": { - "line": 246 - } - }, - "value": " and\n" - }, - { - "type": "ref_role", - "position": { - "start": { - "line": 246 - } - }, - "children": [], - "domain": "std", - "name": "label", - "target": "post-/auth/session", - "flag": "" - }, - { - "type": "text", - "position": { - "start": { - "line": 246 - } - }, - "value": " API endpoints." - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ], - "domain": "", - "name": "list-table", - "argument": [], - "options": { - "header-rows": 1, - "widths": "20 15 15 50" - } - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 255 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 255 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 255 - } - }, - "value": "Responses" - } - ], - "id": "id3" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 257 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 257 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 257 - } - }, - "value": "200" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 257 - } - }, - "value": ": The profile was successfully retrieved." - } - ] - }, - { - "type": "code", - "position": { - "start": { - "line": 259 - } - }, - "lang": "json", - "copyable": true, - "emphasize_lines": [], - "value": "{\n \"user_id\": \"string\",\n \"domain_id\": \"string\",\n \"identities\": [\n {\n \"_id\": \"string\",\n \"name\": \"string\",\n \"type\": \"string\",\n \"disabled\": \"boolean\"\n }\n ],\n \"data\": {\n \"email\": \"string\",\n \"name\": \"string\"\n },\n \"type\": \"string\",\n \"roles\": [\n {\n \"role_name\": \"string\",\n \"group_id\": \"Any\"\n }\n ]\n}", - "linenos": false - }, - { - "type": "directive", - "position": { - "start": { - "line": 285 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 289 - } - }, - "value": "Field" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 290 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 290 - } - }, - "value": "Type" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 291 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 291 - } - }, - "value": "Description" - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 294 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 294 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 294 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 294 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 294 - } - }, - "value": "user_id" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 294 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 295 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 295 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 294 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 297 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 297 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 297 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 297 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 297 - } - }, - "value": "domain_id" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 297 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 298 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 298 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 297 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 300 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 300 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 300 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 300 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 300 - } - }, - "value": "identities" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 300 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 301 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 301 - } - }, - "value": "array" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 300 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 303 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 303 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 303 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 303 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 303 - } - }, - "value": "identities.[]._id" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 303 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 304 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 304 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 303 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 306 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 306 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 306 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 306 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 306 - } - }, - "value": "identities.[].name" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 306 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 307 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 307 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 306 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 309 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 309 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 309 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 309 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 309 - } - }, - "value": "identities.[].type" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 309 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 310 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 310 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 309 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 313 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 313 - } - }, - "value": "Possible Values:" - } - ] - }, - { - "type": "list", - "position": { - "start": { - "line": 315 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 315 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 315 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 315 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 315 - } - }, - "value": "mongodb-cloud" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 315 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 317 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 317 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 317 - } - }, - "value": "local" - } - ] - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 320 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 320 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 320 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 320 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 320 - } - }, - "value": "identities.[].disabled" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 320 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 321 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 321 - } - }, - "value": "boolean" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 320 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 323 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 323 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 323 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 323 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 323 - } - }, - "value": "data" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 323 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 324 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 324 - } - }, - "value": "object" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 323 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 326 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 326 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 326 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 326 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 326 - } - }, - "value": "data.email" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 326 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 327 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 327 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 326 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 329 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 329 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 329 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 329 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 329 - } - }, - "value": "data.name" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 329 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 330 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 330 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 329 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 332 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 332 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 332 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 332 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 332 - } - }, - "value": "type" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 332 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 333 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 333 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 332 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 336 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 336 - } - }, - "value": "Possible Values:" - } - ] - }, - { - "type": "list", - "position": { - "start": { - "line": 338 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 338 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 338 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 338 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 338 - } - }, - "value": "normal" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 338 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 340 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 340 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 340 - } - }, - "value": "server" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 338 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 342 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 342 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 342 - } - }, - "value": "system" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 338 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 344 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 344 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 344 - } - }, - "value": "unknown" - } - ] - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 347 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 347 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 347 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 347 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 347 - } - }, - "value": "roles" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 347 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 348 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 348 - } - }, - "value": "array" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 347 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 350 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 350 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 350 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 350 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 350 - } - }, - "value": "roles.[].role_name" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 350 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 351 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 351 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 350 - } - }, - "children": [] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 289 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 353 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 353 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 353 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 353 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 353 - } - }, - "value": "roles.[].group_id" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 353 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 354 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 354 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 353 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 355 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 355 - } - }, - "value": "An " - }, - { - "type": "substitution_reference", - "position": { - "start": { - "line": 355 - } - }, - "children": [], - "name": "atlas" - }, - { - "type": "text", - "position": { - "start": { - "line": 355 - } - }, - "value": " " - }, - { - "type": "reference", - "position": { - "start": { - "line": 355 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 355 - } - }, - "value": "Project/Group ID" - } - ], - "refuri": "https://docs.atlas.mongodb.com/tutorial/manage-projects/" - }, - { - "type": "text", - "position": { - "start": { - "line": 355 - } - }, - "value": "." - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - } - ], - "enumtype": "unordered" - } - ], - "domain": "", - "name": "list-table", - "argument": [], - "options": { - "header-rows": 1, - "widths": "35 15 50" - } - } - ] - } - ], - "domain": "", - "name": "operation", - "argument": [], - "options": { - "hash": "get-/auth/profile", - "method": "get", - "path": "/auth/profile" - } - }, - "onlySummary": { - "type": "directive", - "position": { - "start": { - "line": 358 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 363 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 363 - } - }, - "value": "Delete a Realm access token." - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 372 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 372 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 372 - } - }, - "value": "Header Parameters" - } - ], - "id": "id4" - }, - { - "type": "directive", - "position": { - "start": { - "line": 374 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 378 - } - }, - "value": "Name" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 379 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 379 - } - }, - "value": "Type" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 380 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 380 - } - }, - "value": "Necessity" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 381 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 381 - } - }, - "value": "Description" - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 378 - } - }, - "children": [ - { - "type": "list", - "position": { - "start": { - "line": 384 - } - }, - "children": [ - { - "type": "listItem", - "position": { - "start": { - "line": 384 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 384 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 384 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 384 - } - }, - "value": "Authorization" - } - ] - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 384 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 385 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 385 - } - }, - "value": "string" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 384 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 386 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 386 - } - }, - "value": "required" - } - ] - } - ] - }, - { - "type": "listItem", - "position": { - "start": { - "line": 384 - } - }, - "children": [ - { - "type": "paragraph", - "position": { - "start": { - "line": 387 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 387 - } - }, - "value": "The authorization token provided in the " - }, - { - "type": "literal", - "position": { - "start": { - "line": 387 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 387 - } - }, - "value": "access_token" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 387 - } - }, - "value": " field of" - } - ] - } - ] - } - ], - "enumtype": "unordered" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 388 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 388 - } - }, - "value": "the " - }, - { - "type": "ref_role", - "position": { - "start": { - "line": 388 - } - }, - "children": [], - "domain": "std", - "name": "label", - "target": "post-/auth/providers/{provider}/login", - "flag": "" - }, - { - "type": "text", - "position": { - "start": { - "line": 388 - } - }, - "value": " and\n" - }, - { - "type": "ref_role", - "position": { - "start": { - "line": 388 - } - }, - "children": [], - "domain": "std", - "name": "label", - "target": "post-/auth/session", - "flag": "" - }, - { - "type": "text", - "position": { - "start": { - "line": 388 - } - }, - "value": " API endpoints." - } - ] - } - ] - } - ], - "enumtype": "unordered" - } - ], - "domain": "", - "name": "list-table", - "argument": [], - "options": { - "header-rows": 1, - "widths": "20 15 15 50" - } - } - ] - }, - { - "type": "section", - "position": { - "start": { - "line": 397 - } - }, - "children": [ - { - "type": "heading", - "position": { - "start": { - "line": 397 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 397 - } - }, - "value": "Responses" - } - ], - "id": "id5" - }, - { - "type": "paragraph", - "position": { - "start": { - "line": 399 - } - }, - "children": [ - { - "type": "literal", - "position": { - "start": { - "line": 399 - } - }, - "children": [ - { - "type": "text", - "position": { - "start": { - "line": 399 - } - }, - "value": "204" - } - ] - }, - { - "type": "text", - "position": { - "start": { - "line": 399 - } - }, - "value": ": Successfully deleted." - } - ] - } - ] - } - ], - "domain": "", - "name": "operation", - "argument": [], - "options": { - "hash": "delete-/auth/session", - "method": "delete", - "path": "/auth/session" - } - } -}