@axerity/cli 0.1.4 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/axerity.js +70 -218
- package/dist/client/_app/immutable/assets/0.jCJXzoiy.css +1 -0
- package/dist/client/_app/immutable/assets/2.DZRzHaE1.css +1 -0
- package/dist/client/_app/immutable/assets/geist-cyrillic-ext-wght-normal.DjL33-gN.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-cyrillic-wght-normal.BEAKL7Jp.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-latin-ext-wght-normal.DC-KSUi6.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-latin-wght-normal.BgDaEnEv.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-mono-cyrillic-ext-wght-normal.I4S5GZfc.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-mono-cyrillic-wght-normal.BmXc_FBt.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-mono-latin-ext-wght-normal.DrnZ1wKl.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-mono-latin-wght-normal.B_7UjwxQ.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-mono-symbols2-wght-normal.GZpp1pK2.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-mono-vietnamese-wght-normal.D8KDMBhC.woff2 +0 -0
- package/dist/client/_app/immutable/assets/geist-vietnamese-wght-normal.6IgcOCM7.woff2 +0 -0
- package/dist/client/_app/immutable/chunks/0CIKaoUA.js +139 -0
- package/dist/client/_app/immutable/chunks/0tC8Ubqr.js +2 -0
- package/dist/client/_app/immutable/chunks/29nvmPLe2.js +1 -0
- package/dist/client/_app/immutable/chunks/9IV9o0dV2.js +4 -0
- package/dist/client/_app/immutable/chunks/B-elEOLV.js +24 -0
- package/dist/client/_app/immutable/chunks/B1R9-4vu.js +89 -0
- package/dist/client/_app/immutable/chunks/B1eXHGII2.js +10 -0
- package/dist/client/_app/immutable/chunks/B2NKIbe62.js +206 -0
- package/dist/client/_app/immutable/chunks/B5Brrqz92.js +1 -0
- package/dist/client/_app/immutable/chunks/B6nymVS3.js +1 -0
- package/dist/client/_app/immutable/chunks/B8E5l9fg2.js +1 -0
- package/dist/client/_app/immutable/chunks/B8gBHxth2.js +1 -0
- package/dist/client/_app/immutable/chunks/BC8A8xkk.js +2 -0
- package/dist/client/_app/immutable/chunks/BGU5ZGjx.js +1 -0
- package/dist/client/_app/immutable/chunks/BLhBgXDr2.js +1 -0
- package/dist/client/_app/immutable/chunks/BNdlLOgu2.js +2 -0
- package/dist/client/_app/immutable/chunks/BQyPqLag.js +84 -0
- package/dist/client/_app/immutable/chunks/BRQspS80.js +162 -0
- package/dist/client/_app/immutable/chunks/BVz-DmJs2.js +132 -0
- package/dist/client/_app/immutable/chunks/BWPyau1x.js +1 -0
- package/dist/client/_app/immutable/chunks/BXD4L9Ly.js +9 -0
- package/dist/client/_app/immutable/chunks/B_Yg36qy2.js +1 -0
- package/dist/client/_app/immutable/chunks/BcuUc08l.js +292 -0
- package/dist/client/_app/immutable/chunks/BdsP84LY.js +231 -0
- package/dist/client/_app/immutable/chunks/Bie0X5s02.js +62 -0
- package/dist/client/_app/immutable/chunks/BifhSqXX.js +1 -0
- package/dist/client/_app/immutable/chunks/BjVjgMFk2.js +15 -0
- package/dist/client/_app/immutable/chunks/BpwmCo88.js +1 -0
- package/dist/client/_app/immutable/chunks/BxQVBtgJ.js +1 -0
- package/dist/client/_app/immutable/chunks/C2oEw9bf.js +34 -0
- package/dist/client/_app/immutable/chunks/C6Oj8XFW.js +1 -0
- package/dist/client/_app/immutable/chunks/C6v0vZRT2.js +36 -0
- package/dist/client/_app/immutable/chunks/C7H7uo1r.js +70 -0
- package/dist/client/_app/immutable/chunks/C8Fc0cco.js +1 -0
- package/dist/client/_app/immutable/chunks/CDfHwfr9.js +1 -0
- package/dist/client/_app/immutable/chunks/CEW3xh3M.js +124 -0
- package/dist/client/_app/immutable/chunks/CFNmf5NX.js +1 -0
- package/dist/client/_app/immutable/chunks/CGhzzHe4.js +1 -0
- package/dist/client/_app/immutable/chunks/CJMWL00f.js +1 -0
- package/dist/client/_app/immutable/chunks/CLrCY0qQ2.js +1 -0
- package/dist/client/_app/immutable/chunks/COu5VFF2.js +78 -0
- package/dist/client/_app/immutable/chunks/CSKSodPl2.js +1 -0
- package/dist/client/_app/immutable/chunks/CVNFCEpi.js +1 -0
- package/dist/client/_app/immutable/chunks/CWUJwgR2.js +1 -0
- package/dist/client/_app/immutable/chunks/CXC42hVj.js +70 -0
- package/dist/client/_app/immutable/chunks/CZqBFf11.js +30 -0
- package/dist/client/_app/immutable/chunks/CaWcga612.js +1 -0
- package/dist/client/_app/immutable/chunks/CcX7Oofq.js +1 -0
- package/dist/client/_app/immutable/chunks/Chn8RaCU2.js +1 -0
- package/dist/client/_app/immutable/chunks/CtmfIXf-.js +161 -0
- package/dist/client/_app/immutable/chunks/D0Co2O6p.js +7 -0
- package/dist/client/_app/immutable/chunks/D1O9pT8r.js +1 -0
- package/dist/client/_app/immutable/chunks/D1z0eUZA.js +3 -0
- package/dist/client/_app/immutable/chunks/D5KVydqU.js +1 -0
- package/dist/client/_app/immutable/chunks/D6jRqBbL.js +1 -0
- package/dist/client/_app/immutable/chunks/DDXR3Aw12.js +1 -0
- package/dist/client/_app/immutable/chunks/DG5yTEkY.js +1 -0
- package/dist/client/_app/immutable/chunks/DGHybmkM2.js +1 -0
- package/dist/client/_app/immutable/chunks/DITdNjTm.js +7 -0
- package/dist/client/_app/immutable/chunks/D_nZbl6c.js +162 -0
- package/dist/client/_app/immutable/chunks/Dg6QheNk.js +85 -0
- package/dist/client/_app/immutable/chunks/Dn1BfjD4.js +1 -0
- package/dist/client/_app/immutable/chunks/DpEnPnBc.js +1 -0
- package/dist/client/_app/immutable/chunks/Drl36yuV.js +40 -0
- package/dist/client/_app/immutable/chunks/Dt_5ZQE2.js +1 -0
- package/dist/client/_app/immutable/chunks/ED9-GWAc2.js +10 -0
- package/dist/client/_app/immutable/chunks/FqbQrHcz2.js +321 -0
- package/dist/client/_app/immutable/chunks/O1MNaiG9.js +3 -0
- package/dist/client/_app/immutable/chunks/PLsDE8Xa.js +24 -0
- package/dist/client/_app/immutable/chunks/PwGqCEPd.js +106 -0
- package/dist/client/_app/immutable/chunks/QmWylQL4.js +96 -0
- package/dist/client/_app/immutable/chunks/SbORYBuH.js +1 -0
- package/dist/client/_app/immutable/chunks/Vhh-h91d.js +257 -0
- package/dist/client/_app/immutable/chunks/Y3d8lUBM.js +120 -0
- package/dist/client/_app/immutable/chunks/aheLp5ES.js +32 -0
- package/dist/client/_app/immutable/chunks/dcFrWhgf.js +1 -0
- package/dist/client/_app/immutable/chunks/dqbyyLvi2.js +10 -0
- package/dist/client/_app/immutable/chunks/hFfQmBrk2.js +1 -0
- package/dist/client/_app/immutable/chunks/mktnrgVa.js +1 -0
- package/dist/client/_app/immutable/chunks/qD2cSsUD2.js +1 -0
- package/dist/client/_app/immutable/chunks/v-V-aVm52.js +43 -0
- package/dist/client/_app/immutable/chunks/wCc4pE4l.js +3 -0
- package/dist/client/_app/immutable/chunks/xihTtKlq.js +1 -0
- package/dist/client/_app/immutable/entry/app.D6KBNU0y.js +2 -0
- package/dist/client/_app/immutable/entry/start.CQdeQUt-.js +1 -0
- package/dist/client/_app/immutable/nodes/0.DBZ13WOO.js +1 -0
- package/dist/client/_app/immutable/nodes/1.B_AZbN4M.js +1 -0
- package/dist/client/_app/immutable/nodes/2.OqcLisIf.js +28 -0
- package/dist/client/_app/version.json +1 -0
- package/dist/env.js +94 -0
- package/dist/handler.js +1494 -0
- package/dist/index.js +345 -0
- package/dist/server/chunks/0-oTZ8HCk-.js +40 -0
- package/dist/server/chunks/0-oTZ8HCk-.js.map +1 -0
- package/dist/server/chunks/1-nu6YvZRQ.js +9 -0
- package/dist/server/chunks/1-nu6YvZRQ.js.map +1 -0
- package/dist/server/chunks/2-YpqcBGyH.js +54 -0
- package/dist/server/chunks/2-YpqcBGyH.js.map +1 -0
- package/dist/server/chunks/Icon-D37LtZZG.js +186 -0
- package/dist/server/chunks/Icon-D37LtZZG.js.map +1 -0
- package/dist/server/chunks/_error.svelte-NKP81ks-.js +48 -0
- package/dist/server/chunks/_error.svelte-NKP81ks-.js.map +1 -0
- package/dist/server/chunks/_layout.svelte-2Eq-_AqW.js +31 -0
- package/dist/server/chunks/_layout.svelte-2Eq-_AqW.js.map +1 -0
- package/dist/server/chunks/_page.svelte-Chjw6C-d.js +2206 -0
- package/dist/server/chunks/_page.svelte-Chjw6C-d.js.map +1 -0
- package/dist/server/chunks/_server.ts-5K31OG2_.js +31 -0
- package/dist/server/chunks/_server.ts-5K31OG2_.js.map +1 -0
- package/dist/server/chunks/_server.ts-BRaXDyO1.js +29 -0
- package/dist/server/chunks/_server.ts-BRaXDyO1.js.map +1 -0
- package/dist/server/chunks/_server.ts-BuDGLKUC.js +213 -0
- package/dist/server/chunks/_server.ts-BuDGLKUC.js.map +1 -0
- package/dist/server/chunks/_server.ts-Bx1daJ1-.js +53 -0
- package/dist/server/chunks/_server.ts-Bx1daJ1-.js.map +1 -0
- package/dist/server/chunks/_server.ts-By7FRFNB.js +37 -0
- package/dist/server/chunks/_server.ts-By7FRFNB.js.map +1 -0
- package/dist/server/chunks/_server.ts-DIxsjlQ0.js +32 -0
- package/dist/server/chunks/_server.ts-DIxsjlQ0.js.map +1 -0
- package/dist/server/chunks/_server.ts-Dgpc__Yz.js +41 -0
- package/dist/server/chunks/_server.ts-Dgpc__Yz.js.map +1 -0
- package/dist/server/chunks/_server.ts-kWOJv5IZ.js +26 -0
- package/dist/server/chunks/_server.ts-kWOJv5IZ.js.map +1 -0
- package/dist/server/chunks/content-store-DV5Rlfo3.js +5252 -0
- package/dist/server/chunks/content-store-DV5Rlfo3.js.map +1 -0
- package/dist/server/chunks/docpage-BkHysAhp.js +5 -0
- package/dist/server/chunks/docpage-BkHysAhp.js.map +1 -0
- package/dist/server/chunks/exports-C0PApeP1.js +758 -0
- package/dist/server/chunks/exports-C0PApeP1.js.map +1 -0
- package/dist/server/chunks/hooks.server-BnfZljxX.js +42 -0
- package/dist/server/chunks/hooks.server-BnfZljxX.js.map +1 -0
- package/dist/server/chunks/internal-pc3wKdix.js +5374 -0
- package/dist/server/chunks/internal-pc3wKdix.js.map +1 -0
- package/dist/server/chunks/mdfile-DBiwGtNY.js +5 -0
- package/dist/server/chunks/mdfile-DBiwGtNY.js.map +1 -0
- package/dist/server/chunks/site-CmugjRXT.js +57 -0
- package/dist/server/chunks/site-CmugjRXT.js.map +1 -0
- package/dist/server/index.js +4356 -0
- package/dist/server/index.js.map +1 -0
- package/dist/server/manifest.js +103 -0
- package/dist/server/manifest.js.map +1 -0
- package/dist/shims.js +32 -0
- package/package.json +24 -16
- package/runtime/crawl.js +58 -0
- package/runtime/preview.js +42 -0
- package/runtime/serve.js +78 -0
- package/runtime/static.js +76 -0
- package/mdsvex.config.js +0 -261
- package/scripts/prepare-engine.mjs +0 -20
- package/src/app.d.ts +0 -17
- package/src/app.html +0 -39
- package/src/content/demo/api/meta.json +0 -5
- package/src/content/demo/api/pet/add-pet.md +0 -105
- package/src/content/demo/api/pet/delete-pet.md +0 -70
- package/src/content/demo/api/pet/find-by-status.md +0 -72
- package/src/content/demo/api/pet/find-by-tags.md +0 -64
- package/src/content/demo/api/pet/get-pet.md +0 -99
- package/src/content/demo/api/pet/meta.json +0 -15
- package/src/content/demo/api/pet/pet-object.md +0 -112
- package/src/content/demo/api/pet/update-pet-with-form.md +0 -69
- package/src/content/demo/api/pet/update-pet.md +0 -79
- package/src/content/demo/api/pet/upload-image.md +0 -79
- package/src/content/demo/api/store/delete-order.md +0 -62
- package/src/content/demo/api/store/get-order.md +0 -70
- package/src/content/demo/api/store/inventory.md +0 -54
- package/src/content/demo/api/store/meta.json +0 -5
- package/src/content/demo/api/store/order-object.md +0 -77
- package/src/content/demo/api/store/place-order.md +0 -83
- package/src/content/demo/api/user/create-user.md +0 -69
- package/src/content/demo/api/user/create-with-list.md +0 -57
- package/src/content/demo/api/user/delete-user.md +0 -61
- package/src/content/demo/api/user/get-user.md +0 -69
- package/src/content/demo/api/user/login.md +0 -80
- package/src/content/demo/api/user/logout.md +0 -45
- package/src/content/demo/api/user/meta.json +0 -14
- package/src/content/demo/api/user/update-user.md +0 -69
- package/src/content/demo/api/user/user-object.md +0 -85
- package/src/content/demo/changelog.md +0 -44
- package/src/content/demo/components/accordion.md +0 -70
- package/src/content/demo/components/api.md +0 -185
- package/src/content/demo/components/badge.md +0 -34
- package/src/content/demo/components/callout.md +0 -83
- package/src/content/demo/components/cards.md +0 -88
- package/src/content/demo/components/code-group.md +0 -55
- package/src/content/demo/components/columns.md +0 -42
- package/src/content/demo/components/frame.md +0 -51
- package/src/content/demo/components/icon.md +0 -54
- package/src/content/demo/components/kbd.md +0 -28
- package/src/content/demo/components/meta.json +0 -26
- package/src/content/demo/components/roadmap.md +0 -86
- package/src/content/demo/components/steps.md +0 -72
- package/src/content/demo/components/tabs.md +0 -146
- package/src/content/demo/components/tooltip.md +0 -44
- package/src/content/demo/components/tree.md +0 -83
- package/src/content/demo/components/type-table.md +0 -77
- package/src/content/demo/components/update.md +0 -48
- package/src/content/demo/components/video.md +0 -56
- package/src/content/demo/components/webhooks.md +0 -109
- package/src/content/demo/components/websockets.md +0 -101
- package/src/content/demo/configuration/ai.md +0 -40
- package/src/content/demo/configuration/cli.md +0 -48
- package/src/content/demo/configuration/deployment.md +0 -105
- package/src/content/demo/configuration/index.md +0 -92
- package/src/content/demo/configuration/layouts.md +0 -51
- package/src/content/demo/configuration/meta.json +0 -5
- package/src/content/demo/configuration/navigation.md +0 -167
- package/src/content/demo/configuration/openapi.md +0 -103
- package/src/content/demo/configuration/search.md +0 -36
- package/src/content/demo/index.md +0 -59
- package/src/content/demo/installation.md +0 -66
- package/src/content/demo/meta.json +0 -15
- package/src/content/demo/quick-start.md +0 -47
- package/src/content/demo/theming/advanced.md +0 -116
- package/src/content/demo/theming/code.md +0 -66
- package/src/content/demo/theming/colors.md +0 -103
- package/src/content/demo/theming/index.md +0 -88
- package/src/content/demo/theming/layout.md +0 -71
- package/src/content/demo/theming/meta.json +0 -5
- package/src/content/demo/theming/themes.md +0 -99
- package/src/content/demo/theming/typography.md +0 -83
- package/src/content/demo/writing/code-blocks.md +0 -154
- package/src/content/demo/writing/diagrams.md +0 -44
- package/src/content/demo/writing/frontmatter.md +0 -33
- package/src/content/demo/writing/markdown.md +0 -62
- package/src/content/demo/writing/meta.json +0 -5
- package/src/hooks.server.ts +0 -49
- package/src/lib/assets/favicon.svg +0 -1
- package/src/lib/base.ts +0 -12
- package/src/lib/components/DynamicIcon.svelte +0 -41
- package/src/lib/components/docs/Analytics.svelte +0 -38
- package/src/lib/components/docs/Banner.svelte +0 -44
- package/src/lib/components/docs/Breadcrumbs.svelte +0 -38
- package/src/lib/components/docs/CopyPageMenu.svelte +0 -119
- package/src/lib/components/docs/DocsLayout.svelte +0 -192
- package/src/lib/components/docs/Footer.svelte +0 -60
- package/src/lib/components/docs/Mermaid.svelte +0 -39
- package/src/lib/components/docs/Navbar.svelte +0 -144
- package/src/lib/components/docs/PageMeta.svelte +0 -35
- package/src/lib/components/docs/PageNav.svelte +0 -44
- package/src/lib/components/docs/SearchDialog.svelte +0 -182
- package/src/lib/components/docs/Sidebar.svelte +0 -85
- package/src/lib/components/docs/SidebarDropdown.svelte +0 -56
- package/src/lib/components/docs/SidebarFooterLinks.svelte +0 -19
- package/src/lib/components/docs/SidebarGroup.svelte +0 -54
- package/src/lib/components/docs/SidebarLink.svelte +0 -67
- package/src/lib/components/docs/TableOfContents.svelte +0 -77
- package/src/lib/components/docs/ThemeToggle.svelte +0 -19
- package/src/lib/components/docs/VersionSwitcher.svelte +0 -80
- package/src/lib/components/kit/Accordion.svelte +0 -60
- package/src/lib/components/kit/AccordionGroup.svelte +0 -13
- package/src/lib/components/kit/Badge.svelte +0 -32
- package/src/lib/components/kit/Callout.svelte +0 -51
- package/src/lib/components/kit/Card.svelte +0 -72
- package/src/lib/components/kit/CardGroup.svelte +0 -21
- package/src/lib/components/kit/CodeGroup.svelte +0 -65
- package/src/lib/components/kit/Columns.svelte +0 -26
- package/src/lib/components/kit/Event.svelte +0 -23
- package/src/lib/components/kit/EventList.svelte +0 -9
- package/src/lib/components/kit/File.svelte +0 -15
- package/src/lib/components/kit/Folder.svelte +0 -46
- package/src/lib/components/kit/Frame.svelte +0 -81
- package/src/lib/components/kit/Icon.svelte +0 -17
- package/src/lib/components/kit/Kbd.svelte +0 -11
- package/src/lib/components/kit/Roadmap.svelte +0 -15
- package/src/lib/components/kit/RoadmapItem.svelte +0 -109
- package/src/lib/components/kit/Step.svelte +0 -63
- package/src/lib/components/kit/Steps.svelte +0 -16
- package/src/lib/components/kit/Tab.svelte +0 -27
- package/src/lib/components/kit/Tabs.svelte +0 -75
- package/src/lib/components/kit/Tooltip.svelte +0 -33
- package/src/lib/components/kit/Tree.svelte +0 -11
- package/src/lib/components/kit/TypeTable.svelte +0 -187
- package/src/lib/components/kit/Update.svelte +0 -32
- package/src/lib/components/kit/Video.svelte +0 -64
- package/src/lib/components/kit/accordion-context.ts +0 -1
- package/src/lib/components/kit/api/Api.svelte +0 -80
- package/src/lib/components/kit/api/ApiExamplePanel.svelte +0 -100
- package/src/lib/components/kit/api/ApiField.svelte +0 -124
- package/src/lib/components/kit/api/Channel.svelte +0 -121
- package/src/lib/components/kit/api/Endpoint.svelte +0 -116
- package/src/lib/components/kit/api/Enum.svelte +0 -44
- package/src/lib/components/kit/api/EnumValues.svelte +0 -35
- package/src/lib/components/kit/api/Expandable.svelte +0 -70
- package/src/lib/components/kit/api/Message.svelte +0 -67
- package/src/lib/components/kit/api/ObjectExample.svelte +0 -11
- package/src/lib/components/kit/api/RequestExample.svelte +0 -11
- package/src/lib/components/kit/api/ResponseExample.svelte +0 -11
- package/src/lib/components/kit/api/Webhook.svelte +0 -115
- package/src/lib/components/kit/api/api-context.ts +0 -15
- package/src/lib/components/kit/tabs-context.ts +0 -8
- package/src/lib/components/kit/tabs-store.svelte.ts +0 -28
- package/src/lib/config/site.ts +0 -34
- package/src/lib/content/index.ts +0 -50
- package/src/lib/content/raw.ts +0 -21
- package/src/lib/content/tree.ts +0 -169
- package/src/lib/index.ts +0 -79
- package/src/lib/nav-match.ts +0 -23
- package/src/lib/openapi/generate.ts +0 -629
- package/src/lib/server/og.ts +0 -140
- package/src/lib/state/search.svelte.ts +0 -9
- package/src/lib/state/theme.svelte.ts +0 -58
- package/src/lib/types.ts +0 -216
- package/src/params/docpage.ts +0 -3
- package/src/params/mdfile.ts +0 -3
- package/src/routes/+error.svelte +0 -46
- package/src/routes/+layout.svelte +0 -25
- package/src/routes/[...path=mdfile]/+server.ts +0 -21
- package/src/routes/[...slug=docpage]/+page.svelte +0 -63
- package/src/routes/[...slug=docpage]/+page.ts +0 -44
- package/src/routes/layout.css +0 -897
- package/src/routes/llms-full.txt/+server.ts +0 -22
- package/src/routes/llms.txt/+server.ts +0 -20
- package/src/routes/og/[...slug]/+server.ts +0 -77
- package/src/routes/rss.xml/+server.ts +0 -65
- package/src/routes/search.json/+server.ts +0 -54
- package/src/routes/sitemap.xml/+server.ts +0 -21
- package/svelte.config.js +0 -35
- package/tsconfig.json +0 -20
- package/vite.config.ts +0 -67
- /package/{static → dist/client}/favicon-dark.svg +0 -0
- /package/{static → dist/client}/favicon-light.svg +0 -0
- /package/{static → dist/client}/favicon.svg +0 -0
- /package/{static → dist/client}/fonts/geist-400.ttf +0 -0
- /package/{static → dist/client}/fonts/geist-600.ttf +0 -0
- /package/{static → dist/client}/fonts/geist-700.ttf +0 -0
- /package/{static → dist/client}/og-image.png +0 -0
- /package/{static → dist/client}/robots.txt +0 -0
|
@@ -1,77 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: The Order object
|
|
3
|
-
description: The shape of a store Order.
|
|
4
|
-
icon: shopping-cart
|
|
5
|
-
layout: api
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
<script>
|
|
9
|
-
import { Api, ResponseField, ObjectExample, EnumValues, Enum } from '$lib';
|
|
10
|
-
</script>
|
|
11
|
-
|
|
12
|
-
# The Order object
|
|
13
|
-
|
|
14
|
-
An Order is a purchase placed in the store.
|
|
15
|
-
|
|
16
|
-
<Api>
|
|
17
|
-
|
|
18
|
-
## Attributes
|
|
19
|
-
|
|
20
|
-
<ResponseField name="id" type="integer">
|
|
21
|
-
|
|
22
|
-
Unique id for the order.
|
|
23
|
-
|
|
24
|
-
</ResponseField>
|
|
25
|
-
|
|
26
|
-
<ResponseField name="petId" type="integer">
|
|
27
|
-
|
|
28
|
-
The id of the pet being ordered.
|
|
29
|
-
|
|
30
|
-
</ResponseField>
|
|
31
|
-
|
|
32
|
-
<ResponseField name="quantity" type="integer">
|
|
33
|
-
|
|
34
|
-
How many of the pet are ordered.
|
|
35
|
-
|
|
36
|
-
</ResponseField>
|
|
37
|
-
|
|
38
|
-
<ResponseField name="shipDate" type="string">
|
|
39
|
-
|
|
40
|
-
When the order ships, as a date-time.
|
|
41
|
-
|
|
42
|
-
</ResponseField>
|
|
43
|
-
|
|
44
|
-
<ResponseField name="status" type="enum">
|
|
45
|
-
|
|
46
|
-
The order status.
|
|
47
|
-
|
|
48
|
-
<EnumValues>
|
|
49
|
-
<Enum value="placed">The order has been placed.</Enum>
|
|
50
|
-
<Enum value="approved">The order has been approved.</Enum>
|
|
51
|
-
<Enum value="delivered">The order has been delivered.</Enum>
|
|
52
|
-
</EnumValues>
|
|
53
|
-
|
|
54
|
-
</ResponseField>
|
|
55
|
-
|
|
56
|
-
<ResponseField name="complete" type="boolean">
|
|
57
|
-
|
|
58
|
-
Whether the order is complete.
|
|
59
|
-
|
|
60
|
-
</ResponseField>
|
|
61
|
-
|
|
62
|
-
<ObjectExample title="The Order object">
|
|
63
|
-
|
|
64
|
-
```json
|
|
65
|
-
{
|
|
66
|
-
"id": 10,
|
|
67
|
-
"petId": 198772,
|
|
68
|
-
"quantity": 7,
|
|
69
|
-
"shipDate": "2024-01-01T10:00:00Z",
|
|
70
|
-
"status": "approved",
|
|
71
|
-
"complete": true
|
|
72
|
-
}
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
</ObjectExample>
|
|
76
|
-
|
|
77
|
-
</Api>
|
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Place an order
|
|
3
|
-
description: Place an order for a pet.
|
|
4
|
-
icon: shopping-cart
|
|
5
|
-
layout: api
|
|
6
|
-
method: POST
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample, ObjectExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Place an order
|
|
14
|
-
|
|
15
|
-
Place a new order in the store.
|
|
16
|
-
|
|
17
|
-
<Api>
|
|
18
|
-
|
|
19
|
-
<Endpoint method="POST" path="/store/order" baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
20
|
-
|
|
21
|
-
## Body parameters
|
|
22
|
-
|
|
23
|
-
<ParamField name="petId" type="integer">
|
|
24
|
-
|
|
25
|
-
The id of the pet to order.
|
|
26
|
-
|
|
27
|
-
</ParamField>
|
|
28
|
-
|
|
29
|
-
<ParamField name="quantity" type="integer">
|
|
30
|
-
|
|
31
|
-
How many to order.
|
|
32
|
-
|
|
33
|
-
</ParamField>
|
|
34
|
-
|
|
35
|
-
<ParamField name="status" type="enum">
|
|
36
|
-
|
|
37
|
-
The order status. One of `placed`, `approved`, or `delivered`.
|
|
38
|
-
|
|
39
|
-
</ParamField>
|
|
40
|
-
|
|
41
|
-
<ParamField name="complete" type="boolean">
|
|
42
|
-
|
|
43
|
-
Whether the order is complete.
|
|
44
|
-
|
|
45
|
-
</ParamField>
|
|
46
|
-
|
|
47
|
-
## Returns
|
|
48
|
-
|
|
49
|
-
Returns the created [Order](/api/store/order-object).
|
|
50
|
-
|
|
51
|
-
<ResponseField name="id" type="integer">
|
|
52
|
-
|
|
53
|
-
Unique id for the order.
|
|
54
|
-
|
|
55
|
-
</ResponseField>
|
|
56
|
-
|
|
57
|
-
<RequestExample title="cURL">
|
|
58
|
-
|
|
59
|
-
```bash
|
|
60
|
-
curl https://petstore3.swagger.io/api/v3/store/order \
|
|
61
|
-
-H "Content-Type: application/json" \
|
|
62
|
-
-d '{ "petId": 198772, "quantity": 7, "status": "placed" }'
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
</RequestExample>
|
|
66
|
-
|
|
67
|
-
<ResponseExample title="200 OK">
|
|
68
|
-
|
|
69
|
-
```json
|
|
70
|
-
{ "id": 10, "petId": 198772, "quantity": 7, "status": "placed", "complete": false }
|
|
71
|
-
```
|
|
72
|
-
|
|
73
|
-
</ResponseExample>
|
|
74
|
-
|
|
75
|
-
<ResponseExample title="400 Invalid input">
|
|
76
|
-
|
|
77
|
-
```json
|
|
78
|
-
{ "code": 400, "message": "Invalid input" }
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
</ResponseExample>
|
|
82
|
-
|
|
83
|
-
</Api>
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Create a user
|
|
3
|
-
description: Create a new user.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
method: POST
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample, ObjectExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Create a user
|
|
14
|
-
|
|
15
|
-
This can only be done by a logged in user.
|
|
16
|
-
|
|
17
|
-
<Api>
|
|
18
|
-
|
|
19
|
-
<Endpoint method="POST" path="/user" baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
20
|
-
|
|
21
|
-
## Body parameters
|
|
22
|
-
|
|
23
|
-
<ParamField name="username" type="string">
|
|
24
|
-
|
|
25
|
-
The user's login name.
|
|
26
|
-
|
|
27
|
-
</ParamField>
|
|
28
|
-
|
|
29
|
-
<ParamField name="email" type="string">
|
|
30
|
-
|
|
31
|
-
The user's email address.
|
|
32
|
-
|
|
33
|
-
</ParamField>
|
|
34
|
-
|
|
35
|
-
<ParamField name="password" type="string">
|
|
36
|
-
|
|
37
|
-
The user's password.
|
|
38
|
-
|
|
39
|
-
</ParamField>
|
|
40
|
-
|
|
41
|
-
## Returns
|
|
42
|
-
|
|
43
|
-
Returns the created [User](/api/user/user-object).
|
|
44
|
-
|
|
45
|
-
<ResponseField name="id" type="integer">
|
|
46
|
-
|
|
47
|
-
Unique id for the user.
|
|
48
|
-
|
|
49
|
-
</ResponseField>
|
|
50
|
-
|
|
51
|
-
<RequestExample title="cURL">
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
curl https://petstore3.swagger.io/api/v3/user \
|
|
55
|
-
-H "Content-Type: application/json" \
|
|
56
|
-
-d '{ "username": "theUser", "email": "john@email.com", "password": "12345" }'
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
</RequestExample>
|
|
60
|
-
|
|
61
|
-
<ResponseExample title="200 OK">
|
|
62
|
-
|
|
63
|
-
```json
|
|
64
|
-
{ "id": 10, "username": "theUser", "email": "john@email.com" }
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
</ResponseExample>
|
|
68
|
-
|
|
69
|
-
</Api>
|
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Create users with list
|
|
3
|
-
description: Create several users at once.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
method: POST
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Create users with list
|
|
14
|
-
|
|
15
|
-
Creates a list of users from a given input array.
|
|
16
|
-
|
|
17
|
-
<Api>
|
|
18
|
-
|
|
19
|
-
<Endpoint method="POST" path="/user/createWithList" baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
20
|
-
|
|
21
|
-
## Body parameters
|
|
22
|
-
|
|
23
|
-
<ParamField name="users" type="array of User" typeLink="/api/user/user-object">
|
|
24
|
-
|
|
25
|
-
The users to create.
|
|
26
|
-
|
|
27
|
-
</ParamField>
|
|
28
|
-
|
|
29
|
-
## Returns
|
|
30
|
-
|
|
31
|
-
Returns the first created [User](/api/user/user-object).
|
|
32
|
-
|
|
33
|
-
<ResponseField name="id" type="integer">
|
|
34
|
-
|
|
35
|
-
Unique id for the user.
|
|
36
|
-
|
|
37
|
-
</ResponseField>
|
|
38
|
-
|
|
39
|
-
<RequestExample title="cURL">
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
curl https://petstore3.swagger.io/api/v3/user/createWithList \
|
|
43
|
-
-H "Content-Type: application/json" \
|
|
44
|
-
-d '[{ "username": "theUser", "email": "john@email.com" }]'
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
</RequestExample>
|
|
48
|
-
|
|
49
|
-
<ResponseExample title="200 OK">
|
|
50
|
-
|
|
51
|
-
```json
|
|
52
|
-
{ "id": 10, "username": "theUser", "email": "john@email.com" }
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
</ResponseExample>
|
|
56
|
-
|
|
57
|
-
</Api>
|
|
@@ -1,61 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Delete a user
|
|
3
|
-
description: Delete an existing user.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
method: DELETE
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Delete a user
|
|
14
|
-
|
|
15
|
-
This can only be done by a logged in user.
|
|
16
|
-
|
|
17
|
-
<Api>
|
|
18
|
-
|
|
19
|
-
<Endpoint method="DELETE" path={'/user/{username}'} baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
20
|
-
|
|
21
|
-
## Path parameters
|
|
22
|
-
|
|
23
|
-
<ParamField name="username" type="string" required>
|
|
24
|
-
|
|
25
|
-
The name of the user to delete.
|
|
26
|
-
|
|
27
|
-
</ParamField>
|
|
28
|
-
|
|
29
|
-
## Returns
|
|
30
|
-
|
|
31
|
-
<ResponseField name="code" type="integer">
|
|
32
|
-
|
|
33
|
-
The HTTP status code of the result.
|
|
34
|
-
|
|
35
|
-
</ResponseField>
|
|
36
|
-
|
|
37
|
-
<RequestExample title="cURL">
|
|
38
|
-
|
|
39
|
-
```bash
|
|
40
|
-
curl -X DELETE https://petstore3.swagger.io/api/v3/user/theUser
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
</RequestExample>
|
|
44
|
-
|
|
45
|
-
<ResponseExample title="200 OK">
|
|
46
|
-
|
|
47
|
-
```json
|
|
48
|
-
{ "code": 200, "message": "User deleted" }
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
</ResponseExample>
|
|
52
|
-
|
|
53
|
-
<ResponseExample title="404 Not Found">
|
|
54
|
-
|
|
55
|
-
```json
|
|
56
|
-
{ "code": 404, "message": "User not found" }
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
</ResponseExample>
|
|
60
|
-
|
|
61
|
-
</Api>
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Get user by username
|
|
3
|
-
description: Return a single user.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
method: GET
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample, ObjectExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Get user by username
|
|
14
|
-
|
|
15
|
-
Get user details based on the username. Use `user1` for testing.
|
|
16
|
-
|
|
17
|
-
<Api>
|
|
18
|
-
|
|
19
|
-
<Endpoint method="GET" path={'/user/{username}'} baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
20
|
-
|
|
21
|
-
## Path parameters
|
|
22
|
-
|
|
23
|
-
<ParamField name="username" type="string" required>
|
|
24
|
-
|
|
25
|
-
The name of the user to fetch.
|
|
26
|
-
|
|
27
|
-
</ParamField>
|
|
28
|
-
|
|
29
|
-
## Returns
|
|
30
|
-
|
|
31
|
-
Returns the [User](/api/user/user-object).
|
|
32
|
-
|
|
33
|
-
<ResponseField name="id" type="integer">
|
|
34
|
-
|
|
35
|
-
Unique id for the user.
|
|
36
|
-
|
|
37
|
-
</ResponseField>
|
|
38
|
-
|
|
39
|
-
<ResponseField name="username" type="string">
|
|
40
|
-
|
|
41
|
-
The user's login name.
|
|
42
|
-
|
|
43
|
-
</ResponseField>
|
|
44
|
-
|
|
45
|
-
<RequestExample title="cURL">
|
|
46
|
-
|
|
47
|
-
```bash
|
|
48
|
-
curl https://petstore3.swagger.io/api/v3/user/user1
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
</RequestExample>
|
|
52
|
-
|
|
53
|
-
<ResponseExample title="200 OK">
|
|
54
|
-
|
|
55
|
-
```json
|
|
56
|
-
{ "id": 10, "username": "user1", "email": "john@email.com" }
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
</ResponseExample>
|
|
60
|
-
|
|
61
|
-
<ResponseExample title="404 Not Found">
|
|
62
|
-
|
|
63
|
-
```json
|
|
64
|
-
{ "code": 404, "message": "User not found" }
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
</ResponseExample>
|
|
68
|
-
|
|
69
|
-
</Api>
|
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Log in
|
|
3
|
-
description: Log a user into the system.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
method: GET
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Log in
|
|
14
|
-
|
|
15
|
-
Log a user into the system. On success the response headers include rate limit
|
|
16
|
-
and token expiry information.
|
|
17
|
-
|
|
18
|
-
<Api>
|
|
19
|
-
|
|
20
|
-
<Endpoint method="GET" path="/user/login" baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
21
|
-
|
|
22
|
-
## Query parameters
|
|
23
|
-
|
|
24
|
-
<ParamField name="username" type="string">
|
|
25
|
-
|
|
26
|
-
The user name for login.
|
|
27
|
-
|
|
28
|
-
</ParamField>
|
|
29
|
-
|
|
30
|
-
<ParamField name="password" type="string">
|
|
31
|
-
|
|
32
|
-
The password for login in clear text.
|
|
33
|
-
|
|
34
|
-
</ParamField>
|
|
35
|
-
|
|
36
|
-
## Returns
|
|
37
|
-
|
|
38
|
-
<ResponseField name="token" type="string">
|
|
39
|
-
|
|
40
|
-
A session token, returned as the response body.
|
|
41
|
-
|
|
42
|
-
</ResponseField>
|
|
43
|
-
|
|
44
|
-
<ResponseField name="X-Rate-Limit" type="integer">
|
|
45
|
-
|
|
46
|
-
Calls per hour allowed for the user. Returned as a response header.
|
|
47
|
-
|
|
48
|
-
</ResponseField>
|
|
49
|
-
|
|
50
|
-
<ResponseField name="X-Expires-After" type="string">
|
|
51
|
-
|
|
52
|
-
The date in UTC when the token expires. Returned as a response header.
|
|
53
|
-
|
|
54
|
-
</ResponseField>
|
|
55
|
-
|
|
56
|
-
<RequestExample title="cURL">
|
|
57
|
-
|
|
58
|
-
```bash
|
|
59
|
-
curl "https://petstore3.swagger.io/api/v3/user/login?username=theUser&password=12345"
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
</RequestExample>
|
|
63
|
-
|
|
64
|
-
<ResponseExample title="200 OK">
|
|
65
|
-
|
|
66
|
-
```json
|
|
67
|
-
"logged in user session: 1640995200000"
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
</ResponseExample>
|
|
71
|
-
|
|
72
|
-
<ResponseExample title="400 Bad Request">
|
|
73
|
-
|
|
74
|
-
```json
|
|
75
|
-
{ "code": 400, "message": "Invalid username/password supplied" }
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
</ResponseExample>
|
|
79
|
-
|
|
80
|
-
</Api>
|
|
@@ -1,45 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Log out
|
|
3
|
-
description: Log out the current session.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
method: GET
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ResponseField, RequestExample, ResponseExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Log out
|
|
14
|
-
|
|
15
|
-
Log the current user out of the system.
|
|
16
|
-
|
|
17
|
-
<Api>
|
|
18
|
-
|
|
19
|
-
<Endpoint method="GET" path="/user/logout" baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
20
|
-
|
|
21
|
-
## Returns
|
|
22
|
-
|
|
23
|
-
<ResponseField name="code" type="integer">
|
|
24
|
-
|
|
25
|
-
The HTTP status code of the result.
|
|
26
|
-
|
|
27
|
-
</ResponseField>
|
|
28
|
-
|
|
29
|
-
<RequestExample title="cURL">
|
|
30
|
-
|
|
31
|
-
```bash
|
|
32
|
-
curl https://petstore3.swagger.io/api/v3/user/logout
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
</RequestExample>
|
|
36
|
-
|
|
37
|
-
<ResponseExample title="200 OK">
|
|
38
|
-
|
|
39
|
-
```json
|
|
40
|
-
{ "code": 200, "message": "ok" }
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
</ResponseExample>
|
|
44
|
-
|
|
45
|
-
</Api>
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: Update a user
|
|
3
|
-
description: Update an existing user.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
method: PUT
|
|
7
|
-
---
|
|
8
|
-
|
|
9
|
-
<script>
|
|
10
|
-
import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample } from '$lib';
|
|
11
|
-
</script>
|
|
12
|
-
|
|
13
|
-
# Update a user
|
|
14
|
-
|
|
15
|
-
This can only be done by a logged in user.
|
|
16
|
-
|
|
17
|
-
<Api>
|
|
18
|
-
|
|
19
|
-
<Endpoint method="PUT" path={'/user/{username}'} baseUrl="https://petstore3.swagger.io/api/v3" />
|
|
20
|
-
|
|
21
|
-
## Path parameters
|
|
22
|
-
|
|
23
|
-
<ParamField name="username" type="string" required>
|
|
24
|
-
|
|
25
|
-
The name of the user to update.
|
|
26
|
-
|
|
27
|
-
</ParamField>
|
|
28
|
-
|
|
29
|
-
## Body parameters
|
|
30
|
-
|
|
31
|
-
<ParamField name="email" type="string">
|
|
32
|
-
|
|
33
|
-
The user's email address.
|
|
34
|
-
|
|
35
|
-
</ParamField>
|
|
36
|
-
|
|
37
|
-
<ParamField name="password" type="string">
|
|
38
|
-
|
|
39
|
-
The user's password.
|
|
40
|
-
|
|
41
|
-
</ParamField>
|
|
42
|
-
|
|
43
|
-
## Returns
|
|
44
|
-
|
|
45
|
-
<ResponseField name="code" type="integer">
|
|
46
|
-
|
|
47
|
-
The HTTP status code of the result.
|
|
48
|
-
|
|
49
|
-
</ResponseField>
|
|
50
|
-
|
|
51
|
-
<RequestExample title="cURL">
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
curl -X PUT https://petstore3.swagger.io/api/v3/user/theUser \
|
|
55
|
-
-H "Content-Type: application/json" \
|
|
56
|
-
-d '{ "email": "new@email.com" }'
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
</RequestExample>
|
|
60
|
-
|
|
61
|
-
<ResponseExample title="200 OK">
|
|
62
|
-
|
|
63
|
-
```json
|
|
64
|
-
{ "code": 200, "message": "ok" }
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
</ResponseExample>
|
|
68
|
-
|
|
69
|
-
</Api>
|
|
@@ -1,85 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: The User object
|
|
3
|
-
description: The shape of a User resource.
|
|
4
|
-
icon: user
|
|
5
|
-
layout: api
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
<script>
|
|
9
|
-
import { Api, ResponseField, ObjectExample } from '$lib';
|
|
10
|
-
</script>
|
|
11
|
-
|
|
12
|
-
# The User object
|
|
13
|
-
|
|
14
|
-
A User is an account in the store.
|
|
15
|
-
|
|
16
|
-
<Api>
|
|
17
|
-
|
|
18
|
-
## Attributes
|
|
19
|
-
|
|
20
|
-
<ResponseField name="id" type="integer">
|
|
21
|
-
|
|
22
|
-
Unique id for the user.
|
|
23
|
-
|
|
24
|
-
</ResponseField>
|
|
25
|
-
|
|
26
|
-
<ResponseField name="username" type="string">
|
|
27
|
-
|
|
28
|
-
The user's login name.
|
|
29
|
-
|
|
30
|
-
</ResponseField>
|
|
31
|
-
|
|
32
|
-
<ResponseField name="firstName" type="string">
|
|
33
|
-
|
|
34
|
-
The user's first name.
|
|
35
|
-
|
|
36
|
-
</ResponseField>
|
|
37
|
-
|
|
38
|
-
<ResponseField name="lastName" type="string">
|
|
39
|
-
|
|
40
|
-
The user's last name.
|
|
41
|
-
|
|
42
|
-
</ResponseField>
|
|
43
|
-
|
|
44
|
-
<ResponseField name="email" type="string">
|
|
45
|
-
|
|
46
|
-
The user's email address.
|
|
47
|
-
|
|
48
|
-
</ResponseField>
|
|
49
|
-
|
|
50
|
-
<ResponseField name="password" type="string">
|
|
51
|
-
|
|
52
|
-
The user's password.
|
|
53
|
-
|
|
54
|
-
</ResponseField>
|
|
55
|
-
|
|
56
|
-
<ResponseField name="phone" type="string">
|
|
57
|
-
|
|
58
|
-
The user's phone number.
|
|
59
|
-
|
|
60
|
-
</ResponseField>
|
|
61
|
-
|
|
62
|
-
<ResponseField name="userStatus" type="integer">
|
|
63
|
-
|
|
64
|
-
The user status.
|
|
65
|
-
|
|
66
|
-
</ResponseField>
|
|
67
|
-
|
|
68
|
-
<ObjectExample title="The User object">
|
|
69
|
-
|
|
70
|
-
```json
|
|
71
|
-
{
|
|
72
|
-
"id": 10,
|
|
73
|
-
"username": "theUser",
|
|
74
|
-
"firstName": "John",
|
|
75
|
-
"lastName": "James",
|
|
76
|
-
"email": "john@email.com",
|
|
77
|
-
"password": "12345",
|
|
78
|
-
"phone": "12345",
|
|
79
|
-
"userStatus": 1
|
|
80
|
-
}
|
|
81
|
-
```
|
|
82
|
-
|
|
83
|
-
</ObjectExample>
|
|
84
|
-
|
|
85
|
-
</Api>
|