@scalar/openapi-types 0.1.9 → 0.2.1

package/dist/schemas/3.1/processed/xml-object.js

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+
+/**
+ *
+ * XML Object
+ *
+ * A metadata object that allows for more fine-tuned XML model definitions.
+ *
+ * When using arrays, XML element names are not inferred (for singular/plural forms) and the name field SHOULD be used
+ * to add that information. See examples for expected behavior.
+ *
+ * @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.1.md#xml-object
+ */
+const XmlObjectSchema = z.object({
+    /**
+     * Replaces the name of the element/attribute used for the described schema property.
+     */
+    name: z.string().optional(),
+    /**
+     * The URI of the namespace definition. Value MUST be in the form of a URL.
+     */
+    namespace: z.string().optional(),
+    /**
+     * The prefix to be used for the name.
+     */
+    prefix: z.string().optional(),
+    /**
+     * Declares whether the property definition translates to an attribute instead of an element.
+     * Default value is false.
+     */
+    attribute: z.boolean().optional(),
+    /**
+     * MAY be used only for an array definition.
+     * Signifies whether the array is wrapped (for example, <books><book/><book/></books>)
+     * or unwrapped (<book/><book/>). Default value is false.
+     */
+    wrapped: z.boolean().optional(),
+});
+
+export { XmlObjectSchema };