npm - @axerity/cli - Versions diffs - 0.1.0 - Mend

@axerity/cli 0.1.0

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.

Files changed (186) hide show

package/LICENSE +21 -0
package/README.md +1 -0
package/axerity.default.json +135 -0
package/axerity.schema.json +268 -0
package/bin/axerity.js +305 -0
package/mdsvex.config.js +261 -0
package/package.json +103 -0
package/scripts/prepare-engine.mjs +20 -0
package/src/app.d.ts +17 -0
package/src/app.html +39 -0
package/src/content/demo/api/meta.json +5 -0
package/src/content/demo/api/pet/add-pet.md +105 -0
package/src/content/demo/api/pet/delete-pet.md +70 -0
package/src/content/demo/api/pet/find-by-status.md +72 -0
package/src/content/demo/api/pet/find-by-tags.md +64 -0
package/src/content/demo/api/pet/get-pet.md +99 -0
package/src/content/demo/api/pet/meta.json +15 -0
package/src/content/demo/api/pet/pet-object.md +112 -0
package/src/content/demo/api/pet/update-pet-with-form.md +69 -0
package/src/content/demo/api/pet/update-pet.md +79 -0
package/src/content/demo/api/pet/upload-image.md +79 -0
package/src/content/demo/api/store/delete-order.md +62 -0
package/src/content/demo/api/store/get-order.md +70 -0
package/src/content/demo/api/store/inventory.md +54 -0
package/src/content/demo/api/store/meta.json +5 -0
package/src/content/demo/api/store/order-object.md +77 -0
package/src/content/demo/api/store/place-order.md +83 -0
package/src/content/demo/api/user/create-user.md +69 -0
package/src/content/demo/api/user/create-with-list.md +57 -0
package/src/content/demo/api/user/delete-user.md +61 -0
package/src/content/demo/api/user/get-user.md +69 -0
package/src/content/demo/api/user/login.md +80 -0
package/src/content/demo/api/user/logout.md +45 -0
package/src/content/demo/api/user/meta.json +14 -0
package/src/content/demo/api/user/update-user.md +69 -0
package/src/content/demo/api/user/user-object.md +85 -0
package/src/content/demo/changelog.md +44 -0
package/src/content/demo/components/accordion.md +70 -0
package/src/content/demo/components/api.md +185 -0
package/src/content/demo/components/badge.md +34 -0
package/src/content/demo/components/callout.md +83 -0
package/src/content/demo/components/cards.md +88 -0
package/src/content/demo/components/code-group.md +55 -0
package/src/content/demo/components/columns.md +42 -0
package/src/content/demo/components/frame.md +51 -0
package/src/content/demo/components/icon.md +54 -0
package/src/content/demo/components/kbd.md +28 -0
package/src/content/demo/components/meta.json +26 -0
package/src/content/demo/components/roadmap.md +86 -0
package/src/content/demo/components/steps.md +72 -0
package/src/content/demo/components/tabs.md +146 -0
package/src/content/demo/components/tooltip.md +44 -0
package/src/content/demo/components/tree.md +83 -0
package/src/content/demo/components/type-table.md +77 -0
package/src/content/demo/components/update.md +48 -0
package/src/content/demo/components/video.md +56 -0
package/src/content/demo/components/webhooks.md +109 -0
package/src/content/demo/components/websockets.md +101 -0
package/src/content/demo/configuration/ai.md +40 -0
package/src/content/demo/configuration/cli.md +46 -0
package/src/content/demo/configuration/deployment.md +105 -0
package/src/content/demo/configuration/index.md +92 -0
package/src/content/demo/configuration/layouts.md +51 -0
package/src/content/demo/configuration/meta.json +5 -0
package/src/content/demo/configuration/navigation.md +167 -0
package/src/content/demo/configuration/openapi.md +103 -0
package/src/content/demo/configuration/search.md +36 -0
package/src/content/demo/index.md +59 -0
package/src/content/demo/installation.md +49 -0
package/src/content/demo/meta.json +15 -0
package/src/content/demo/quick-start.md +47 -0
package/src/content/demo/theming/advanced.md +116 -0
package/src/content/demo/theming/code.md +66 -0
package/src/content/demo/theming/colors.md +103 -0
package/src/content/demo/theming/index.md +88 -0
package/src/content/demo/theming/layout.md +71 -0
package/src/content/demo/theming/meta.json +5 -0
package/src/content/demo/theming/themes.md +99 -0
package/src/content/demo/theming/typography.md +83 -0
package/src/content/demo/writing/code-blocks.md +154 -0
package/src/content/demo/writing/diagrams.md +44 -0
package/src/content/demo/writing/frontmatter.md +33 -0
package/src/content/demo/writing/markdown.md +62 -0
package/src/content/demo/writing/meta.json +5 -0
package/src/hooks.server.ts +49 -0
package/src/lib/assets/favicon.svg +1 -0
package/src/lib/base.ts +12 -0
package/src/lib/components/DynamicIcon.svelte +26 -0
package/src/lib/components/docs/Analytics.svelte +38 -0
package/src/lib/components/docs/Banner.svelte +44 -0
package/src/lib/components/docs/Breadcrumbs.svelte +38 -0
package/src/lib/components/docs/CopyPageMenu.svelte +119 -0
package/src/lib/components/docs/DocsLayout.svelte +192 -0
package/src/lib/components/docs/Footer.svelte +60 -0
package/src/lib/components/docs/Mermaid.svelte +39 -0
package/src/lib/components/docs/Navbar.svelte +144 -0
package/src/lib/components/docs/PageMeta.svelte +35 -0
package/src/lib/components/docs/PageNav.svelte +44 -0
package/src/lib/components/docs/SearchDialog.svelte +182 -0
package/src/lib/components/docs/Sidebar.svelte +85 -0
package/src/lib/components/docs/SidebarDropdown.svelte +56 -0
package/src/lib/components/docs/SidebarFooterLinks.svelte +19 -0
package/src/lib/components/docs/SidebarGroup.svelte +54 -0
package/src/lib/components/docs/SidebarLink.svelte +67 -0
package/src/lib/components/docs/TableOfContents.svelte +77 -0
package/src/lib/components/docs/ThemeToggle.svelte +19 -0
package/src/lib/components/docs/VersionSwitcher.svelte +80 -0
package/src/lib/components/kit/Accordion.svelte +60 -0
package/src/lib/components/kit/AccordionGroup.svelte +13 -0
package/src/lib/components/kit/Badge.svelte +32 -0
package/src/lib/components/kit/Callout.svelte +51 -0
package/src/lib/components/kit/Card.svelte +72 -0
package/src/lib/components/kit/CardGroup.svelte +21 -0
package/src/lib/components/kit/CodeGroup.svelte +65 -0
package/src/lib/components/kit/Columns.svelte +26 -0
package/src/lib/components/kit/Event.svelte +23 -0
package/src/lib/components/kit/EventList.svelte +9 -0
package/src/lib/components/kit/File.svelte +15 -0
package/src/lib/components/kit/Folder.svelte +46 -0
package/src/lib/components/kit/Frame.svelte +81 -0
package/src/lib/components/kit/Icon.svelte +17 -0
package/src/lib/components/kit/Kbd.svelte +11 -0
package/src/lib/components/kit/Roadmap.svelte +15 -0
package/src/lib/components/kit/RoadmapItem.svelte +109 -0
package/src/lib/components/kit/Step.svelte +63 -0
package/src/lib/components/kit/Steps.svelte +16 -0
package/src/lib/components/kit/Tab.svelte +27 -0
package/src/lib/components/kit/Tabs.svelte +75 -0
package/src/lib/components/kit/Tooltip.svelte +33 -0
package/src/lib/components/kit/Tree.svelte +11 -0
package/src/lib/components/kit/TypeTable.svelte +187 -0
package/src/lib/components/kit/Update.svelte +32 -0
package/src/lib/components/kit/Video.svelte +64 -0
package/src/lib/components/kit/accordion-context.ts +1 -0
package/src/lib/components/kit/api/Api.svelte +80 -0
package/src/lib/components/kit/api/ApiExamplePanel.svelte +100 -0
package/src/lib/components/kit/api/ApiField.svelte +124 -0
package/src/lib/components/kit/api/Channel.svelte +121 -0
package/src/lib/components/kit/api/Endpoint.svelte +116 -0
package/src/lib/components/kit/api/Enum.svelte +44 -0
package/src/lib/components/kit/api/EnumValues.svelte +35 -0
package/src/lib/components/kit/api/Expandable.svelte +70 -0
package/src/lib/components/kit/api/Message.svelte +67 -0
package/src/lib/components/kit/api/ObjectExample.svelte +11 -0
package/src/lib/components/kit/api/RequestExample.svelte +11 -0
package/src/lib/components/kit/api/ResponseExample.svelte +11 -0
package/src/lib/components/kit/api/Webhook.svelte +115 -0
package/src/lib/components/kit/api/api-context.ts +15 -0
package/src/lib/components/kit/tabs-context.ts +8 -0
package/src/lib/components/kit/tabs-store.svelte.ts +28 -0
package/src/lib/config/site.ts +34 -0
package/src/lib/content/index.ts +50 -0
package/src/lib/content/raw.ts +21 -0
package/src/lib/content/tree.ts +169 -0
package/src/lib/index.ts +79 -0
package/src/lib/nav-match.ts +23 -0
package/src/lib/openapi/generate.ts +629 -0
package/src/lib/server/og.ts +140 -0
package/src/lib/state/search.svelte.ts +9 -0
package/src/lib/state/theme.svelte.ts +58 -0
package/src/lib/types.ts +216 -0
package/src/params/docpage.ts +3 -0
package/src/params/mdfile.ts +3 -0
package/src/routes/+error.svelte +46 -0
package/src/routes/+layout.svelte +25 -0
package/src/routes/[...path=mdfile]/+server.ts +21 -0
package/src/routes/[...slug=docpage]/+page.svelte +63 -0
package/src/routes/[...slug=docpage]/+page.ts +44 -0
package/src/routes/layout.css +897 -0
package/src/routes/llms-full.txt/+server.ts +22 -0
package/src/routes/llms.txt/+server.ts +20 -0
package/src/routes/og/[...slug]/+server.ts +77 -0
package/src/routes/rss.xml/+server.ts +65 -0
package/src/routes/search.json/+server.ts +54 -0
package/src/routes/sitemap.xml/+server.ts +21 -0
package/static/favicon-dark.svg +6 -0
package/static/favicon-light.svg +6 -0
package/static/favicon.svg +14 -0
package/static/fonts/geist-400.ttf +0 -0
package/static/fonts/geist-600.ttf +0 -0
package/static/fonts/geist-700.ttf +0 -0
package/static/og-image.png +0 -0
package/static/robots.txt +4 -0
package/svelte.config.js +35 -0
package/tsconfig.json +20 -0
package/vite.config.ts +46 -0

package/src/app.d.ts ADDED Viewed

@@ -0,0 +1,17 @@
+// See https://svelte.dev/docs/kit/types#app.d.ts
+// for information about these interfaces
+declare global {
+	namespace App {
+		// interface Error {}
+		// interface Locals {}
+		// interface PageData {}
+		// interface PageState {}
+		// interface Platform {}
+	}
+}
+// Fontsource ships CSS without type declarations; declare the side-effect imports.
+declare module '@fontsource-variable/geist/*';
+declare module '@fontsource-variable/geist-mono/*';
+export {};

package/src/app.html ADDED Viewed

@@ -0,0 +1,39 @@
+<!doctype html>
+<html lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<meta name="viewport" content="width=device-width, initial-scale=1" />
+		<meta name="text-scale" content="scale" />
+		<script>
+			(() => {
+				try {
+					const pref = localStorage.getItem('axerity-theme') ?? 'dark';
+					const dark =
+						pref === 'dark' ||
+						(pref === 'system' && window.matchMedia('(prefers-color-scheme: dark)').matches);
+					document.documentElement.classList.toggle('dark', dark);
+				} catch {}
+			})();
+			(() => {
+				try {
+					const hide = [];
+					for (let i = 0; i < localStorage.length; i++) {
+						const key = localStorage.key(i);
+						if (key && key.indexOf('axerity-banner:') === 0 && localStorage.getItem(key) === '1') {
+							hide.push('[data-banner-key="' + key.replace(/"/g, '\\"') + '"]');
+						}
+					}
+					if (hide.length) {
+						const style = document.createElement('style');
+						style.textContent = hide.join(',') + '{display:none!important}';
+						document.head.appendChild(style);
+					}
+				} catch {}
+			})();
+		</script>
+		%sveltekit.head%
+	</head>
+	<body data-sveltekit-preload-data="hover">
+		<div style="display: contents">%sveltekit.body%</div>
+	</body>
+</html>

package/src/content/demo/api/meta.json ADDED Viewed

@@ -0,0 +1,5 @@
+{
+	"title": "API Reference",
+	"icon": "code",
+	"pages": ["pet", "store", "user"]
+}

package/src/content/demo/api/pet/add-pet.md ADDED Viewed

@@ -0,0 +1,105 @@
+---
+title: Add a new pet
+description: Add a new pet to the store.
+icon: paw-print
+layout: api
+method: POST
+---
+<script>
+	import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample, ObjectExample } from '$lib';
+</script>
+# Add a new pet
+Add a new pet to the store.
+<Api>
+<Endpoint method="POST" path="/pet" baseUrl="https://petstore3.swagger.io/api/v3" />
+## Body parameters
+Create a new pet in the store.
+<ParamField name="name" type="string" required>
+The pet's name.
+</ParamField>
+<ParamField name="photoUrls" type="array of strings" required>
+URLs of the pet's photos.
+</ParamField>
+<ParamField name="category" type="Category" typeLink="/api/pet/pet-object">
+The category this pet belongs to.
+</ParamField>
+<ParamField name="status" type="enum">
+Pet status in the store. One of `available`, `pending`, or `sold`.
+</ParamField>
+## Returns
+Returns the created [Pet](/api/pet/pet-object).
+<ResponseField name="id" type="integer">
+Unique id for the new pet.
+</ResponseField>
+<RequestExample title="cURL">
+```bash
+curl https://petstore3.swagger.io/api/v3/pet \
+  -H "Content-Type: application/json" \
+  -d '{ "name": "doggie", "photoUrls": ["https://example.com/doggie.png"], "status": "available" }'
+```
+</RequestExample>
+<ResponseExample title="200 OK">
+```json
+{
+	"id": 10,
+	"name": "doggie",
+	"photoUrls": ["https://example.com/doggie.png"],
+	"status": "available"
+}
+```
+</ResponseExample>
+<ResponseExample title="400 Invalid input">
+```json
+{ "code": 400, "message": "Invalid input" }
+```
+</ResponseExample>
+<ObjectExample title="The Pet object">
+```json
+{
+	"id": 10,
+	"name": "doggie",
+	"category": { "id": 1, "name": "Dogs" },
+	"photoUrls": ["https://example.com/doggie.png"],
+	"tags": [{ "id": 1, "name": "friendly" }],
+	"status": "available"
+}
+```
+</ObjectExample>
+</Api>

package/src/content/demo/api/pet/delete-pet.md ADDED Viewed

@@ -0,0 +1,70 @@
+---
+title: Delete a pet
+description: Delete a pet from the store.
+icon: paw-print
+layout: api
+method: DELETE
+---
+<script>
+	import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample } from '$lib';
+</script>
+# Delete a pet
+Delete a pet.
+<Api>
+<Endpoint method="DELETE" path={'/pet/{petId}'} baseUrl="https://petstore3.swagger.io/api/v3" />
+## Headers
+<ParamField name="api_key" type="string">
+Your store API key.
+</ParamField>
+## Path parameters
+<ParamField name="petId" type="integer" required>
+The id of the pet to delete.
+</ParamField>
+## Returns
+<ResponseField name="code" type="integer">
+The HTTP status code of the result.
+</ResponseField>
+<RequestExample title="cURL">
+```bash
+curl -X DELETE https://petstore3.swagger.io/api/v3/pet/10 \
+  -H "api_key: special-key"
+```
+</RequestExample>
+<ResponseExample title="200 OK">
+```json
+{ "code": 200, "message": "Pet deleted" }
+```
+</ResponseExample>
+<ResponseExample title="400 Invalid value">
+```json
+{ "code": 400, "message": "Invalid pet value" }
+```
+</ResponseExample>
+</Api>

package/src/content/demo/api/pet/find-by-status.md ADDED Viewed

@@ -0,0 +1,72 @@
+---
+title: Find pets by status
+description: Find pets filtered by status.
+icon: paw-print
+layout: api
+method: GET
+---
+<script>
+	import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample, EnumValues, Enum } from '$lib';
+</script>
+# Find pets by status
+Multiple status values can be provided as comma separated strings.
+<Api>
+<Endpoint method="GET" path="/pet/findByStatus" baseUrl="https://petstore3.swagger.io/api/v3" />
+## Query parameters
+<ParamField name="status" type="enum" default="available">
+The status to filter by.
+<EnumValues>
+	<Enum value="available">Available for purchase.</Enum>
+	<Enum value="pending">Reserved, sale in progress.</Enum>
+	<Enum value="sold">Already sold.</Enum>
+</EnumValues>
+</ParamField>
+## Returns
+Returns an array of [Pet](/api/pet/pet-object) objects.
+<ResponseField name="data" type="Pet[]">
+The pets that match the status.
+</ResponseField>
+<RequestExample title="cURL">
+```bash
+curl "https://petstore3.swagger.io/api/v3/pet/findByStatus?status=available"
+```
+</RequestExample>
+<ResponseExample title="200 OK">
+```json
+[
+	{ "id": 10, "name": "doggie", "status": "available" },
+	{ "id": 11, "name": "kitty", "status": "available" }
+]
+```
+</ResponseExample>
+<ResponseExample title="400 Invalid status">
+```json
+{ "code": 400, "message": "Invalid status value" }
+```
+</ResponseExample>
+</Api>

package/src/content/demo/api/pet/find-by-tags.md ADDED Viewed

@@ -0,0 +1,64 @@
+---
+title: Find pets by tags
+description: Find pets filtered by tags.
+icon: paw-print
+layout: api
+method: GET
+---
+<script>
+	import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample } from '$lib';
+</script>
+# Find pets by tags
+Multiple tags can be provided as comma separated strings. Use `tag1`, `tag2`,
+`tag3` for testing.
+<Api>
+<Endpoint method="GET" path="/pet/findByTags" baseUrl="https://petstore3.swagger.io/api/v3" />
+## Query parameters
+<ParamField name="tags" type="array of strings">
+Tags to filter by.
+</ParamField>
+## Returns
+Returns an array of [Pet](/api/pet/pet-object) objects.
+<ResponseField name="data" type="Pet[]">
+The pets that match the tags.
+</ResponseField>
+<RequestExample title="cURL">
+```bash
+curl "https://petstore3.swagger.io/api/v3/pet/findByTags?tags=friendly"
+```
+</RequestExample>
+<ResponseExample title="200 OK">
+```json
+[{ "id": 10, "name": "doggie", "tags": [{ "id": 1, "name": "friendly" }] }]
+```
+</ResponseExample>
+<ResponseExample title="400 Invalid tag">
+```json
+{ "code": 400, "message": "Invalid tag value" }
+```
+</ResponseExample>
+</Api>

package/src/content/demo/api/pet/get-pet.md ADDED Viewed

@@ -0,0 +1,99 @@
+---
+title: Find pet by ID
+description: Return a single pet.
+icon: paw-print
+layout: api
+method: GET
+---
+<script>
+	import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample, ObjectExample } from '$lib';
+</script>
+# Find pet by ID
+Returns a single pet.
+<Api>
+<Endpoint method="GET" path={'/pet/{petId}'} baseUrl="https://petstore3.swagger.io/api/v3" />
+## Headers
+<ParamField name="api_key" type="string">
+Your store API key.
+</ParamField>
+## Path parameters
+<ParamField name="petId" type="integer" required>
+The id of the pet to return.
+</ParamField>
+## Returns
+Returns the [Pet](/api/pet/pet-object).
+<ResponseField name="id" type="integer">
+Unique id for the pet.
+</ResponseField>
+<ResponseField name="name" type="string">
+The pet's name.
+</ResponseField>
+<ResponseField name="status" type="enum">
+Pet status in the store.
+</ResponseField>
+<RequestExample title="cURL">
+```bash
+curl https://petstore3.swagger.io/api/v3/pet/10 \
+  -H "api_key: special-key"
+```
+</RequestExample>
+<ResponseExample title="200 OK">
+```json
+{ "id": 10, "name": "doggie", "status": "available" }
+```
+</ResponseExample>
+<ResponseExample title="404 Not Found">
+```json
+{ "code": 404, "message": "Pet not found" }
+```
+</ResponseExample>
+<ObjectExample title="The Pet object">
+```json
+{
+	"id": 10,
+	"name": "doggie",
+	"category": { "id": 1, "name": "Dogs" },
+	"photoUrls": ["https://example.com/photos/doggie.png"],
+	"tags": [{ "id": 1, "name": "friendly" }],
+	"status": "available"
+}
+```
+</ObjectExample>
+</Api>

package/src/content/demo/api/pet/meta.json ADDED Viewed

@@ -0,0 +1,15 @@
+{
+	"title": "Pet",
+	"icon": "paw-print",
+	"pages": [
+		"pet-object",
+		"add-pet",
+		"update-pet",
+		"find-by-status",
+		"find-by-tags",
+		"get-pet",
+		"update-pet-with-form",
+		"upload-image",
+		"delete-pet"
+	]
+}

package/src/content/demo/api/pet/pet-object.md ADDED Viewed

@@ -0,0 +1,112 @@
+---
+title: The Pet object
+description: The shape of a Pet resource.
+icon: paw-print
+layout: api
+---
+<script>
+	import { Api, ResponseField, ObjectExample, Expandable, EnumValues, Enum, Callout } from '$lib';
+</script>
+# The Pet object
+A Pet is an animal listed in the store.
+<Api>
+<Callout type="info">
+Pet endpoints are protected by `petstore_auth` (OAuth2) with the `read:pets` and
+`write:pets` scopes. Reads also accept an `api_key` header.
+</Callout>
+## Attributes
+<ResponseField name="id" type="integer">
+Unique id for the pet. Read only.
+</ResponseField>
+<ResponseField name="name" type="string" required>
+The pet's name, such as `doggie`.
+</ResponseField>
+<ResponseField name="category" type="Category">
+The category this pet belongs to.
+<Expandable title="properties">
+	<ResponseField name="id" type="integer">
+Category id.
+    </ResponseField>
+    <ResponseField name="name" type="string">
+Category name, such as `Dogs`.
+    </ResponseField>
+</Expandable>
+</ResponseField>
+<ResponseField name="photoUrls" type="array of strings" required>
+URLs of the pet's photos.
+</ResponseField>
+<ResponseField name="tags" type="array of Tag">
+Tags attached to the pet.
+<Expandable title="properties">
+	<ResponseField name="id" type="integer">
+Tag id.
+    </ResponseField>
+    <ResponseField name="name" type="string">
+Tag name.
+    </ResponseField>
+</Expandable>
+</ResponseField>
+<ResponseField name="status" type="enum">
+Pet status in the store.
+<EnumValues>
+	<Enum value="available">Available for purchase.</Enum>
+	<Enum value="pending">Reserved, sale in progress.</Enum>
+	<Enum value="sold">Already sold.</Enum>
+</EnumValues>
+</ResponseField>
+<ObjectExample title="The Pet object">
+```json
+{
+	"id": 10,
+	"name": "doggie",
+	"category": { "id": 1, "name": "Dogs" },
+	"photoUrls": ["https://example.com/photos/doggie.png"],
+	"tags": [{ "id": 1, "name": "friendly" }],
+	"status": "available"
+}
+```
+</ObjectExample>
+</Api>

package/src/content/demo/api/pet/update-pet-with-form.md ADDED Viewed

@@ -0,0 +1,69 @@
+---
+title: Update a pet with form data
+description: Update a pet using query parameters.
+icon: paw-print
+layout: api
+method: POST
+---
+<script>
+	import { Api, Endpoint, ParamField, ResponseField, RequestExample, ResponseExample } from '$lib';
+</script>
+# Update a pet with form data
+Updates a pet resource based on the form data.
+<Api>
+<Endpoint method="POST" path={'/pet/{petId}'} baseUrl="https://petstore3.swagger.io/api/v3" />
+## Path parameters
+<ParamField name="petId" type="integer" required>
+The id of the pet that needs to be updated.
+</ParamField>
+## Query parameters
+<ParamField name="name" type="string">
+The new name of the pet.
+</ParamField>
+<ParamField name="status" type="string">
+The new status of the pet.
+</ParamField>
+## Returns
+Returns the updated [Pet](/api/pet/pet-object).
+<ResponseField name="id" type="integer">
+Unique id for the pet.
+</ResponseField>
+<RequestExample title="cURL">
+```bash
+curl -X POST "https://petstore3.swagger.io/api/v3/pet/10?name=doggie&status=sold"
+```
+</RequestExample>
+<ResponseExample title="200 OK">
+```json
+{ "id": 10, "name": "doggie", "status": "sold" }
+```
+</ResponseExample>
+</Api>