diff --git a/assets/app.850f5e05.js b/assets/app.850f5e05.js
new file mode 100644
index 00000000..64042387
--- /dev/null
+++ b/assets/app.850f5e05.js
@@ -0,0 +1,32 @@
+const co="modulepreload",js={},uo="/swagger-php/",fo=function(t,n){return!n||n.length===0?t():Promise.all(n.map(s=>{if(s=`${uo}${s}`,s in js)return;js[s]=!0;const r=s.endsWith(".css"),i=r?'[rel="stylesheet"]':"";if(document.querySelector(`link[href="${s}"]${i}`))return;const o=document.createElement("link");if(o.rel=r?"stylesheet":co,r||(o.as="script",o.crossOrigin=""),o.href=s,document.head.appendChild(o),r)return new Promise((l,a)=>{o.addEventListener("load",l),o.addEventListener("error",()=>a(new Error(`Unable to preload CSS for ${s}`)))})})).then(()=>t())};/**
+* @vue/shared v3.4.31
+* (c) 2018-present Yuxi (Evan) You and Vue contributors
+* @license MIT
+**//*! #__NO_SIDE_EFFECTS__ */function Pt(e,t){const n=new Set(e.split(","));return t?s=>n.has(s.toLowerCase()):s=>n.has(s)}const te={},Ct=[],Ee=()=>{},ho=()=>!1,Xt=e=>e.charCodeAt(0)===111&&e.charCodeAt(1)===110&&(e.charCodeAt(2)>122||e.charCodeAt(2)<97),us=e=>e.startsWith("onUpdate:"),pe=Object.assign,fs=(e,t)=>{const n=e.indexOf(t);n>-1&&e.splice(n,1)},po=Object.prototype.hasOwnProperty,Y=(e,t)=>po.call(e,t),D=Array.isArray,kt=e=>In(e)==="[object Map]",Hr=e=>In(e)==="[object Set]",U=e=>typeof e=="function",le=e=>typeof e=="string",lt=e=>typeof e=="symbol",ne=e=>e!==null&&typeof e=="object",Mr=e=>(ne(e)||U(e))&&U(e.then)&&U(e.catch),Dr=Object.prototype.toString,In=e=>Dr.call(e),_o=e=>In(e).slice(8,-1),Nr=e=>In(e)==="[object Object]",ds=e=>le(e)&&e!=="NaN"&&e[0]!=="-"&&""+parseInt(e,10)===e,St=Pt(",key,ref,ref_for,ref_key,onVnodeBeforeMount,onVnodeMounted,onVnodeBeforeUpdate,onVnodeUpdated,onVnodeBeforeUnmount,onVnodeUnmounted"),En=e=>{const t=Object.create(null);return n=>t[n]||(t[n]=e(n))},go=/-(\w)/g,Ke=En(e=>e.replace(go,(t,n)=>n?n.toUpperCase():"")),mo=/\B([A-Z])/g,vt=En(e=>e.replace(mo,"-$1").toLowerCase()),Ln=En(e=>e.charAt(0).toUpperCase()+e.slice(1)),Wn=En(e=>e?`on${Ln(e)}`:""),ot=(e,t)=>!Object.is(e,t),Kn=(e,...t)=>{for(let n=0;n<e.length;n++)e[n](...t)},Fr=(e,t,n,s=!1)=>{Object.defineProperty(e,t,{configurable:!0,enumerable:!1,writable:s,value:n})},vo=e=>{const t=parseFloat(e);return isNaN(t)?e:t};let Bs;const hs=()=>Bs||(Bs=typeof globalThis!="undefined"?globalThis:typeof self!="undefined"?self:typeof window!="undefined"?window:typeof global!="undefined"?global:{});function Pn(e){if(D(e)){const t={};for(let n=0;n<e.length;n++){const s=e[n],r=le(s)?wo(s):Pn(s);if(r)for(const i in r)t[i]=r[i]}return t}else if(le(e)||ne(e))return e}const bo=/;(?![^(]*\))/g,yo=/:([^]+)/,xo=/\/\*[^]*?\*\//g;function wo(e){const t={};return e.replace(xo,"").split(bo).forEach(n=>{if(n){const s=n.split(yo);s.length>1&&(t[s[0].trim()]=s[1].trim())}}),t}function Co(e){let t="";if(!e||le(e))return t;for(const n in e){const s=e[n];(le(s)||typeof s=="number")&&(t+=`${n.startsWith("--")?n:vt(n)}:${s};`)}return t}function Se(e){let t="";if(le(e))t=e;else if(D(e))for(let n=0;n<e.length;n++){const s=Se(e[n]);s&&(t+=s+" ")}else if(ne(e))for(const n in e)e[n]&&(t+=n+" ");return t.trim()}const Ur="itemscope,allowfullscreen,formnovalidate,ismap,nomodule,novalidate,readonly",ko=Pt(Ur),Vs=Pt(Ur+",async,autofocus,autoplay,controls,default,defer,disabled,hidden,inert,loop,open,required,reversed,scoped,seamless,checked,muted,multiple,selected");function ps(e){return!!e||e===""}const So=Pt("accept,accept-charset,accesskey,action,align,allow,alt,async,autocapitalize,autocomplete,autofocus,autoplay,background,bgcolor,border,buffered,capture,challenge,charset,checked,cite,class,code,codebase,color,cols,colspan,content,contenteditable,contextmenu,controls,coords,crossorigin,csp,data,datetime,decoding,default,defer,dir,dirname,disabled,download,draggable,dropzone,enctype,enterkeyhint,for,form,formaction,formenctype,formmethod,formnovalidate,formtarget,headers,height,hidden,high,href,hreflang,http-equiv,icon,id,importance,inert,integrity,ismap,itemprop,keytype,kind,label,lang,language,loading,list,loop,low,manifest,max,maxlength,minlength,media,min,multiple,muted,name,novalidate,open,optimum,pattern,ping,placeholder,poster,preload,radiogroup,readonly,referrerpolicy,rel,required,reversed,rows,rowspan,sandbox,scope,scoped,selected,shape,size,sizes,slot,span,spellcheck,src,srcdoc,srclang,srcset,start,step,style,summary,tabindex,target,title,translate,type,usemap,value,width,wrap"),To=Pt("xmlns,accent-height,accumulate,additive,alignment-baseline,alphabetic,amplitude,arabic-form,ascent,attributeName,attributeType,azimuth,baseFrequency,baseline-shift,baseProfile,bbox,begin,bias,by,calcMode,cap-height,class,clip,clipPathUnits,clip-path,clip-rule,color,color-interpolation,color-interpolation-filters,color-profile,color-rendering,contentScriptType,contentStyleType,crossorigin,cursor,cx,cy,d,decelerate,descent,diffuseConstant,direction,display,divisor,dominant-baseline,dur,dx,dy,edgeMode,elevation,enable-background,end,exponent,fill,fill-opacity,fill-rule,filter,filterRes,filterUnits,flood-color,flood-opacity,font-family,font-size,font-size-adjust,font-stretch,font-style,font-variant,font-weight,format,from,fr,fx,fy,g1,g2,glyph-name,glyph-orientation-horizontal,glyph-orientation-vertical,glyphRef,gradientTransform,gradientUnits,hanging,height,href,hreflang,horiz-adv-x,horiz-origin-x,id,ideographic,image-rendering,in,in2,intercept,k,k1,k2,k3,k4,kernelMatrix,kernelUnitLength,kerning,keyPoints,keySplines,keyTimes,lang,lengthAdjust,letter-spacing,lighting-color,limitingConeAngle,local,marker-end,marker-mid,marker-start,markerHeight,markerUnits,markerWidth,mask,maskContentUnits,maskUnits,mathematical,max,media,method,min,mode,name,numOctaves,offset,opacity,operator,order,orient,orientation,origin,overflow,overline-position,overline-thickness,panose-1,paint-order,path,pathLength,patternContentUnits,patternTransform,patternUnits,ping,pointer-events,points,pointsAtX,pointsAtY,pointsAtZ,preserveAlpha,preserveAspectRatio,primitiveUnits,r,radius,referrerPolicy,refX,refY,rel,rendering-intent,repeatCount,repeatDur,requiredExtensions,requiredFeatures,restart,result,rotate,rx,ry,scale,seed,shape-rendering,slope,spacing,specularConstant,specularExponent,speed,spreadMethod,startOffset,stdDeviation,stemh,stemv,stitchTiles,stop-color,stop-opacity,strikethrough-position,strikethrough-thickness,string,stroke,stroke-dasharray,stroke-dashoffset,stroke-linecap,stroke-linejoin,stroke-miterlimit,stroke-opacity,stroke-width,style,surfaceScale,systemLanguage,tabindex,tableValues,target,targetX,targetY,text-anchor,text-decoration,text-rendering,textLength,to,transform,transform-origin,type,u1,u2,underline-position,underline-thickness,unicode,unicode-bidi,unicode-range,units-per-em,v-alphabetic,v-hanging,v-ideographic,v-mathematical,values,vector-effect,version,vert-adv-y,vert-origin-x,vert-origin-y,viewBox,viewTarget,visibility,width,widths,word-spacing,writing-mode,x,x-height,x1,x2,xChannelSelector,xlink:actuate,xlink:arcrole,xlink:href,xlink:role,xlink:show,xlink:title,xlink:type,xmlns:xlink,xml:base,xml:lang,xml:space,y,y1,y2,yChannelSelector,z,zoomAndPan");function $o(e){if(e==null)return!1;const t=typeof e;return t==="string"||t==="number"||t==="boolean"}const jr=e=>!!(e&&e.__v_isRef===!0),me=e=>le(e)?e:e==null?"":D(e)||ne(e)&&(e.toString===Dr||!U(e.toString))?jr(e)?me(e.value):JSON.stringify(e,Br,2):String(e),Br=(e,t)=>jr(t)?Br(e,t.value):kt(t)?{[`Map(${t.size})`]:[...t.entries()].reduce((n,[s,r],i)=>(n[qn(s,i)+" =>"]=r,n),{})}:Hr(t)?{[`Set(${t.size})`]:[...t.values()].map(n=>qn(n))}:lt(t)?qn(t):ne(t)&&!D(t)&&!Nr(t)?String(t):t,qn=(e,t="")=>{var n;return lt(e)?`Symbol(${(n=e.description)!=null?n:t})`:e};/**
+* @vue/reactivity v3.4.31
+* (c) 2018-present Yuxi (Evan) You and Vue contributors
+* @license MIT
+**/let He;class Ao{constructor(t=!1){this.detached=t,this._active=!0,this.effects=[],this.cleanups=[],this.parent=He,!t&&He&&(this.index=(He.scopes||(He.scopes=[])).push(this)-1)}get active(){return this._active}run(t){if(this._active){const n=He;try{return He=this,t()}finally{He=n}}}on(){He=this}off(){He=this.parent}stop(t){if(this._active){let n,s;for(n=0,s=this.effects.length;n<s;n++)this.effects[n].stop();for(n=0,s=this.cleanups.length;n<s;n++)this.cleanups[n]();if(this.scopes)for(n=0,s=this.scopes.length;n<s;n++)this.scopes[n].stop(!0);if(!this.detached&&this.parent&&!t){const r=this.parent.scopes.pop();r&&r!==this&&(this.parent.scopes[this.index]=r,r.index=this.index)}this.parent=void 0,this._active=!1}}}function Io(e,t=He){t&&t.active&&t.effects.push(e)}function Eo(){return He}let ht;class _s{constructor(t,n,s,r){this.fn=t,this.trigger=n,this.scheduler=s,this.active=!0,this.deps=[],this._dirtyLevel=4,this._trackId=0,this._runnings=0,this._shouldSchedule=!1,this._depsLength=0,Io(this,r)}get dirty(){if(this._dirtyLevel===2||this._dirtyLevel===3){this._dirtyLevel=1,Xe();for(let t=0;t<this._depsLength;t++){const n=this.deps[t];if(n.computed&&(Lo(n.computed),this._dirtyLevel>=4))break}this._dirtyLevel===1&&(this._dirtyLevel=0),Ze()}return this._dirtyLevel>=4}set dirty(t){this._dirtyLevel=t?4:0}run(){if(this._dirtyLevel=0,!this.active)return this.fn();let t=it,n=ht;try{return it=!0,ht=this,this._runnings++,Ws(this),this.fn()}finally{Ks(this),this._runnings--,ht=n,it=t}}stop(){this.active&&(Ws(this),Ks(this),this.onStop&&this.onStop(),this.active=!1)}}function Lo(e){return e.value}function Ws(e){e._trackId++,e._depsLength=0}function Ks(e){if(e.deps.length>e._depsLength){for(let t=e._depsLength;t<e.deps.length;t++)Vr(e.deps[t],e);e.deps.length=e._depsLength}}function Vr(e,t){const n=e.get(t);n!==void 0&&t._trackId!==n&&(e.delete(t),e.size===0&&e.cleanup())}let it=!0,es=0;const Wr=[];function Xe(){Wr.push(it),it=!1}function Ze(){const e=Wr.pop();it=e===void 0?!0:e}function gs(){es++}function ms(){for(es--;!es&&ts.length;)ts.shift()()}function Kr(e,t,n){if(t.get(e)!==e._trackId){t.set(e,e._trackId);const s=e.deps[e._depsLength];s!==t?(s&&Vr(s,e),e.deps[e._depsLength++]=t):e._depsLength++}}const ts=[];function qr(e,t,n){gs();for(const s of e.keys()){let r;s._dirtyLevel<t&&(r!=null?r:r=e.get(s)===s._trackId)&&(s._shouldSchedule||(s._shouldSchedule=s._dirtyLevel===0),s._dirtyLevel=t),s._shouldSchedule&&(r!=null?r:r=e.get(s)===s._trackId)&&(s.trigger(),(!s._runnings||s.allowRecurse)&&s._dirtyLevel!==2&&(s._shouldSchedule=!1,s.scheduler&&ts.push(s.scheduler)))}ms()}const zr=(e,t)=>{const n=new Map;return n.cleanup=e,n.computed=t,n},mn=new WeakMap,pt=Symbol(""),ns=Symbol("");function Ae(e,t,n){if(it&&ht){let s=mn.get(e);s||mn.set(e,s=new Map);let r=s.get(n);r||s.set(n,r=zr(()=>s.delete(n))),Kr(ht,r)}}function Ye(e,t,n,s,r,i){const o=mn.get(e);if(!o)return;let l=[];if(t==="clear")l=[...o.values()];else if(n==="length"&&D(e)){const a=Number(s);o.forEach((u,d)=>{(d==="length"||!lt(d)&&d>=a)&&l.push(u)})}else switch(n!==void 0&&l.push(o.get(n)),t){case"add":D(e)?ds(n)&&l.push(o.get("length")):(l.push(o.get(pt)),kt(e)&&l.push(o.get(ns)));break;case"delete":D(e)||(l.push(o.get(pt)),kt(e)&&l.push(o.get(ns)));break;case"set":kt(e)&&l.push(o.get(pt));break}gs();for(const a of l)a&&qr(a,4);ms()}function Po(e,t){const n=mn.get(e);return n&&n.get(t)}const Ro=Pt("__proto__,__v_isRef,__isVue"),Yr=new Set(Object.getOwnPropertyNames(Symbol).filter(e=>e!=="arguments"&&e!=="caller").map(e=>Symbol[e]).filter(lt)),qs=Oo();function Oo(){const e={};return["includes","indexOf","lastIndexOf"].forEach(t=>{e[t]=function(...n){const s=G(this);for(let i=0,o=this.length;i<o;i++)Ae(s,"get",i+"");const r=s[t](...n);return r===-1||r===!1?s[t](...n.map(G)):r}}),["push","pop","shift","unshift","splice"].forEach(t=>{e[t]=function(...n){Xe(),gs();const s=G(this)[t].apply(this,n);return ms(),Ze(),s}}),e}function Ho(e){lt(e)||(e=String(e));const t=G(this);return Ae(t,"has",e),t.hasOwnProperty(e)}class Gr{constructor(t=!1,n=!1){this._isReadonly=t,this._isShallow=n}get(t,n,s){const r=this._isReadonly,i=this._isShallow;if(n==="__v_isReactive")return!r;if(n==="__v_isReadonly")return r;if(n==="__v_isShallow")return i;if(n==="__v_raw")return s===(r?i?Yo:Qr:i?Zr:Xr).get(t)||Object.getPrototypeOf(t)===Object.getPrototypeOf(s)?t:void 0;const o=D(t);if(!r){if(o&&Y(qs,n))return Reflect.get(qs,n,s);if(n==="hasOwnProperty")return Ho}const l=Reflect.get(t,n,s);return(lt(n)?Yr.has(n):Ro(n))||(r||Ae(t,"get",n),i)?l:we(l)?o&&ds(n)?l:l.value:ne(l)?r?ei(l):Rt(l):l}}class Jr extends Gr{constructor(t=!1){super(!1,t)}set(t,n,s,r){let i=t[n];if(!this._isShallow){const a=qt(i);if(!vn(s)&&!qt(s)&&(i=G(i),s=G(s)),!D(t)&&we(i)&&!we(s))return a?!1:(i.value=s,!0)}const o=D(t)&&ds(n)?Number(n)<t.length:Y(t,n),l=Reflect.set(t,n,s,r);return t===G(r)&&(o?ot(s,i)&&Ye(t,"set",n,s):Ye(t,"add",n,s)),l}deleteProperty(t,n){const s=Y(t,n);t[n];const r=Reflect.deleteProperty(t,n);return r&&s&&Ye(t,"delete",n,void 0),r}has(t,n){const s=Reflect.has(t,n);return(!lt(n)||!Yr.has(n))&&Ae(t,"has",n),s}ownKeys(t){return Ae(t,"iterate",D(t)?"length":pt),Reflect.ownKeys(t)}}class Mo extends Gr{constructor(t=!1){super(!0,t)}set(t,n){return!0}deleteProperty(t,n){return!0}}const Do=new Jr,No=new Mo,Fo=new Jr(!0);const vs=e=>e,Rn=e=>Reflect.getPrototypeOf(e);function sn(e,t,n=!1,s=!1){e=e.__v_raw;const r=G(e),i=G(t);n||(ot(t,i)&&Ae(r,"get",t),Ae(r,"get",i));const{has:o}=Rn(r),l=s?vs:n?xs:zt;if(o.call(r,t))return l(e.get(t));if(o.call(r,i))return l(e.get(i));e!==r&&e.get(t)}function rn(e,t=!1){const n=this.__v_raw,s=G(n),r=G(e);return t||(ot(e,r)&&Ae(s,"has",e),Ae(s,"has",r)),e===r?n.has(e):n.has(e)||n.has(r)}function on(e,t=!1){return e=e.__v_raw,!t&&Ae(G(e),"iterate",pt),Reflect.get(e,"size",e)}function zs(e){e=G(e);const t=G(this);return Rn(t).has.call(t,e)||(t.add(e),Ye(t,"add",e,e)),this}function Ys(e,t){t=G(t);const n=G(this),{has:s,get:r}=Rn(n);let i=s.call(n,e);i||(e=G(e),i=s.call(n,e));const o=r.call(n,e);return n.set(e,t),i?ot(t,o)&&Ye(n,"set",e,t):Ye(n,"add",e,t),this}function Gs(e){const t=G(this),{has:n,get:s}=Rn(t);let r=n.call(t,e);r||(e=G(e),r=n.call(t,e)),s&&s.call(t,e);const i=t.delete(e);return r&&Ye(t,"delete",e,void 0),i}function Js(){const e=G(this),t=e.size!==0,n=e.clear();return t&&Ye(e,"clear",void 0,void 0),n}function ln(e,t){return function(s,r){const i=this,o=i.__v_raw,l=G(o),a=t?vs:e?xs:zt;return!e&&Ae(l,"iterate",pt),o.forEach((u,d)=>s.call(r,a(u),a(d),i))}}function an(e,t,n){return function(...s){const r=this.__v_raw,i=G(r),o=kt(i),l=e==="entries"||e===Symbol.iterator&&o,a=e==="keys"&&o,u=r[e](...s),d=n?vs:t?xs:zt;return!t&&Ae(i,"iterate",a?ns:pt),{next(){const{value:_,done:b}=u.next();return b?{value:_,done:b}:{value:l?[d(_[0]),d(_[1])]:d(_),done:b}},[Symbol.iterator](){return this}}}}function et(e){return function(...t){return e==="delete"?!1:e==="clear"?void 0:this}}function Uo(){const e={get(i){return sn(this,i)},get size(){return on(this)},has:rn,add:zs,set:Ys,delete:Gs,clear:Js,forEach:ln(!1,!1)},t={get(i){return sn(this,i,!1,!0)},get size(){return on(this)},has:rn,add:zs,set:Ys,delete:Gs,clear:Js,forEach:ln(!1,!0)},n={get(i){return sn(this,i,!0)},get size(){return on(this,!0)},has(i){return rn.call(this,i,!0)},add:et("add"),set:et("set"),delete:et("delete"),clear:et("clear"),forEach:ln(!0,!1)},s={get(i){return sn(this,i,!0,!0)},get size(){return on(this,!0)},has(i){return rn.call(this,i,!0)},add:et("add"),set:et("set"),delete:et("delete"),clear:et("clear"),forEach:ln(!0,!0)};return["keys","values","entries",Symbol.iterator].forEach(i=>{e[i]=an(i,!1,!1),n[i]=an(i,!0,!1),t[i]=an(i,!1,!0),s[i]=an(i,!0,!0)}),[e,n,t,s]}const[jo,Bo,Vo,Wo]=Uo();function bs(e,t){const n=t?e?Wo:Vo:e?Bo:jo;return(s,r,i)=>r==="__v_isReactive"?!e:r==="__v_isReadonly"?e:r==="__v_raw"?s:Reflect.get(Y(n,r)&&r in s?n:s,r,i)}const Ko={get:bs(!1,!1)},qo={get:bs(!1,!0)},zo={get:bs(!0,!1)};const Xr=new WeakMap,Zr=new WeakMap,Qr=new WeakMap,Yo=new WeakMap;function Go(e){switch(e){case"Object":case"Array":return 1;case"Map":case"Set":case"WeakMap":case"WeakSet":return 2;default:return 0}}function Jo(e){return e.__v_skip||!Object.isExtensible(e)?0:Go(_o(e))}function Rt(e){return qt(e)?e:ys(e,!1,Do,Ko,Xr)}function Xo(e){return ys(e,!1,Fo,qo,Zr)}function ei(e){return ys(e,!0,No,zo,Qr)}function ys(e,t,n,s,r){if(!ne(e)||e.__v_raw&&!(t&&e.__v_isReactive))return e;const i=r.get(e);if(i)return i;const o=Jo(e);if(o===0)return e;const l=new Proxy(e,o===2?s:n);return r.set(e,l),l}function Ut(e){return qt(e)?Ut(e.__v_raw):!!(e&&e.__v_isReactive)}function qt(e){return!!(e&&e.__v_isReadonly)}function vn(e){return!!(e&&e.__v_isShallow)}function ti(e){return e?!!e.__v_raw:!1}function G(e){const t=e&&e.__v_raw;return t?G(t):e}function hn(e){return Object.isExtensible(e)&&Fr(e,"__v_skip",!0),e}const zt=e=>ne(e)?Rt(e):e,xs=e=>ne(e)?ei(e):e;class ni{constructor(t,n,s,r){this.getter=t,this._setter=n,this.dep=void 0,this.__v_isRef=!0,this.__v_isReadonly=!1,this.effect=new _s(()=>t(this._value),()=>pn(this,this.effect._dirtyLevel===2?2:3)),this.effect.computed=this,this.effect.active=this._cacheable=!r,this.__v_isReadonly=s}get value(){const t=G(this);return(!t._cacheable||t.effect.dirty)&&ot(t._value,t._value=t.effect.run())&&pn(t,4),si(t),t.effect._dirtyLevel>=2&&pn(t,2),t._value}set value(t){this._setter(t)}get _dirty(){return this.effect.dirty}set _dirty(t){this.effect.dirty=t}}function Zo(e,t,n=!1){let s,r;const i=U(e);return i?(s=e,r=Ee):(s=e.get,r=e.set),new ni(s,r,i||!r,n)}function si(e){var t;it&&ht&&(e=G(e),Kr(ht,(t=e.dep)!=null?t:e.dep=zr(()=>e.dep=void 0,e instanceof ni?e:void 0)))}function pn(e,t=4,n,s){e=G(e);const r=e.dep;r&&qr(r,t)}function we(e){return!!(e&&e.__v_isRef===!0)}function gt(e){return ri(e,!1)}function Qo(e){return ri(e,!0)}function ri(e,t){return we(e)?e:new el(e,t)}class el{constructor(t,n){this.__v_isShallow=n,this.dep=void 0,this.__v_isRef=!0,this._rawValue=n?t:G(t),this._value=n?t:zt(t)}get value(){return si(this),this._value}set value(t){const n=this.__v_isShallow||vn(t)||qt(t);t=n?t:G(t),ot(t,this._rawValue)&&(this._rawValue,this._rawValue=t,this._value=n?t:zt(t),pn(this,4))}}function $(e){return we(e)?e.value:e}const tl={get:(e,t,n)=>$(Reflect.get(e,t,n)),set:(e,t,n,s)=>{const r=e[t];return we(r)&&!we(n)?(r.value=n,!0):Reflect.set(e,t,n,s)}};function ii(e){return Ut(e)?e:new Proxy(e,tl)}function ws(e){const t=D(e)?new Array(e.length):{};for(const n in e)t[n]=sl(e,n);return t}class nl{constructor(t,n,s){this._object=t,this._key=n,this._defaultValue=s,this.__v_isRef=!0}get value(){const t=this._object[this._key];return t===void 0?this._defaultValue:t}set value(t){this._object[this._key]=t}get dep(){return Po(G(this._object),this._key)}}function sl(e,t,n){const s=e[t];return we(s)?s:new nl(e,t,n)}/**
+* @vue/runtime-core v3.4.31
+* (c) 2018-present Yuxi (Evan) You and Vue contributors
+* @license MIT
+**/const jt=[];function tt(e,...t){Xe();const n=jt.length?jt[jt.length-1].component:null,s=n&&n.appContext.config.warnHandler,r=rl();if(s)Ge(s,n,11,[e+t.map(i=>{var o,l;return(l=(o=i.toString)==null?void 0:o.call(i))!=null?l:JSON.stringify(i)}).join(""),n&&n.proxy,r.map(({vnode:i})=>`at <${Bi(n,i.type)}>`).join(`
+`),r]);else{const i=[`[Vue warn]: ${e}`,...t];r.length&&i.push(`
+`,...il(r)),console.warn(...i)}Ze()}function rl(){let e=jt[jt.length-1];if(!e)return[];const t=[];for(;e;){const n=t[0];n&&n.vnode===e?n.recurseCount++:t.push({vnode:e,recurseCount:0});const s=e.component&&e.component.parent;e=s&&s.vnode}return t}function il(e){const t=[];return e.forEach((n,s)=>{t.push(...s===0?[]:[`
+`],...ol(n))}),t}function ol({vnode:e,recurseCount:t}){const n=t>0?`... (${t} recursive calls)`:"",s=e.component?e.component.parent==null:!1,r=` at <${Bi(e.component,e.type,s)}`,i=">"+n;return e.props?[r,...ll(e.props),i]:[r+i]}function ll(e){const t=[],n=Object.keys(e);return n.slice(0,3).forEach(s=>{t.push(...oi(s,e[s]))}),n.length>3&&t.push(" ..."),t}function oi(e,t,n){return le(t)?(t=JSON.stringify(t),n?t:[`${e}=${t}`]):typeof t=="number"||typeof t=="boolean"||t==null?n?t:[`${e}=${t}`]:we(t)?(t=oi(e,G(t.value),!0),n?t:[`${e}=Ref<`,t,">"]):U(t)?[`${e}=fn${t.name?`<${t.name}>`:""}`]:(t=G(t),n?t:[`${e}=`,t])}function Ge(e,t,n,s){try{return s?e(...s):e()}catch(r){On(r,t,n)}}function Fe(e,t,n,s){if(U(e)){const r=Ge(e,t,n,s);return r&&Mr(r)&&r.catch(i=>{On(i,t,n)}),r}if(D(e)){const r=[];for(let i=0;i<e.length;i++)r.push(Fe(e[i],t,n,s));return r}}function On(e,t,n,s=!0){const r=t?t.vnode:null;if(t){let i=t.parent;const o=t.proxy,l=`https://vuejs.org/error-reference/#runtime-${n}`;for(;i;){const u=i.ec;if(u){for(let d=0;d<u.length;d++)if(u[d](e,o,l)===!1)return}i=i.parent}const a=t.appContext.config.errorHandler;if(a){Xe(),Ge(a,null,10,[e,o,l]),Ze();return}}al(e,n,r,s)}function al(e,t,n,s=!0){console.error(e)}let Yt=!1,ss=!1;const ye=[];let Ve=0;const Tt=[];let nt=null,dt=0;const li=Promise.resolve();let Cs=null;function ai(e){const t=Cs||li;return e?t.then(this?e.bind(this):e):t}function cl(e){let t=Ve+1,n=ye.length;for(;t<n;){const s=t+n>>>1,r=ye[s],i=Gt(r);i<e||i===e&&r.pre?t=s+1:n=s}return t}function ks(e){(!ye.length||!ye.includes(e,Yt&&e.allowRecurse?Ve+1:Ve))&&(e.id==null?ye.push(e):ye.splice(cl(e.id),0,e),ci())}function ci(){!Yt&&!ss&&(ss=!0,Cs=li.then(ui))}function ul(e){const t=ye.indexOf(e);t>Ve&&ye.splice(t,1)}function fl(e){D(e)?Tt.push(...e):(!nt||!nt.includes(e,e.allowRecurse?dt+1:dt))&&Tt.push(e),ci()}function Xs(e,t,n=Yt?Ve+1:0){for(;n<ye.length;n++){const s=ye[n];if(s&&s.pre){if(e&&s.id!==e.uid)continue;ye.splice(n,1),n--,s()}}}function bn(e){if(Tt.length){const t=[...new Set(Tt)].sort((n,s)=>Gt(n)-Gt(s));if(Tt.length=0,nt){nt.push(...t);return}for(nt=t,dt=0;dt<nt.length;dt++){const n=nt[dt];n.active!==!1&&n()}nt=null,dt=0}}const Gt=e=>e.id==null?1/0:e.id,dl=(e,t)=>{const n=Gt(e)-Gt(t);if(n===0){if(e.pre&&!t.pre)return-1;if(t.pre&&!e.pre)return 1}return n};function ui(e){ss=!1,Yt=!0,ye.sort(dl);const t=Ee;try{for(Ve=0;Ve<ye.length;Ve++){const n=ye[Ve];n&&n.active!==!1&&Ge(n,null,14)}}finally{Ve=0,ye.length=0,bn(),Yt=!1,Cs=null,(ye.length||Tt.length)&&ui()}}function hl(e,t,...n){if(e.isUnmounted)return;const s=e.vnode.props||te;let r=n;const i=t.startsWith("update:"),o=i&&t.slice(7);if(o&&o in s){const d=`${o==="modelValue"?"model":o}Modifiers`,{number:_,trim:b}=s[d]||te;b&&(r=n.map(T=>le(T)?T.trim():T)),_&&(r=n.map(vo))}let l,a=s[l=Wn(t)]||s[l=Wn(Ke(t))];!a&&i&&(a=s[l=Wn(vt(t))]),a&&Fe(a,e,6,r);const u=s[l+"Once"];if(u){if(!e.emitted)e.emitted={};else if(e.emitted[l])return;e.emitted[l]=!0,Fe(u,e,6,r)}}function fi(e,t,n=!1){const s=t.emitsCache,r=s.get(e);if(r!==void 0)return r;const i=e.emits;let o={},l=!1;if(!U(e)){const a=u=>{const d=fi(u,t,!0);d&&(l=!0,pe(o,d))};!n&&t.mixins.length&&t.mixins.forEach(a),e.extends&&a(e.extends),e.mixins&&e.mixins.forEach(a)}return!i&&!l?(ne(e)&&s.set(e,null),null):(D(i)?i.forEach(a=>o[a]=null):pe(o,i),ne(e)&&s.set(e,o),o)}function Hn(e,t){return!e||!Xt(t)?!1:(t=t.slice(2).replace(/Once$/,""),Y(e,t[0].toLowerCase()+t.slice(1))||Y(e,vt(t))||Y(e,t))}let ge=null,Mn=null;function yn(e){const t=ge;return ge=e,Mn=e&&e.type.__scopeId||null,t}function Ss(e){Mn=e}function Ts(){Mn=null}function Re(e,t=ge,n){if(!t||e._n)return e;const s=(...r)=>{s._d&&dr(-1);const i=yn(t);let o;try{o=e(...r)}finally{yn(i),s._d&&dr(1)}return o};return s._n=!0,s._c=!0,s._d=!0,s}function zn(e){const{type:t,vnode:n,proxy:s,withProxy:r,propsOptions:[i],slots:o,attrs:l,emit:a,render:u,renderCache:d,props:_,data:b,setupState:T,ctx:F,inheritAttrs:V}=e,ue=yn(e);let re,ae;try{if(n.shapeFlag&4){const y=r||s,R=y;re=Me(u.call(R,y,d,_,T,b,F)),ae=l}else{const y=t;re=Me(y.length>1?y(_,{attrs:l,slots:o,emit:a}):y(_,null)),ae=t.props?l:pl(l)}}catch(y){Kt.length=0,On(y,e,1),re=j(Je)}let h=re;if(ae&&V!==!1){const y=Object.keys(ae),{shapeFlag:R}=h;y.length&&R&7&&(i&&y.some(us)&&(ae=_l(ae,i)),h=Et(h,ae,!1,!0))}return n.dirs&&(h=Et(h,null,!1,!0),h.dirs=h.dirs?h.dirs.concat(n.dirs):n.dirs),n.transition&&(h.transition=n.transition),re=h,yn(ue),re}const pl=e=>{let t;for(const n in e)(n==="class"||n==="style"||Xt(n))&&((t||(t={}))[n]=e[n]);return t},_l=(e,t)=>{const n={};for(const s in e)(!us(s)||!(s.slice(9)in t))&&(n[s]=e[s]);return n};function gl(e,t,n){const{props:s,children:r,component:i}=e,{props:o,children:l,patchFlag:a}=t,u=i.emitsOptions;if(t.dirs||t.transition)return!0;if(n&&a>=0){if(a&1024)return!0;if(a&16)return s?Zs(s,o,u):!!o;if(a&8){const d=t.dynamicProps;for(let _=0;_<d.length;_++){const b=d[_];if(o[b]!==s[b]&&!Hn(u,b))return!0}}}else return(r||l)&&(!l||!l.$stable)?!0:s===o?!1:s?o?Zs(s,o,u):!0:!!o;return!1}function Zs(e,t,n){const s=Object.keys(t);if(s.length!==Object.keys(e).length)return!0;for(let r=0;r<s.length;r++){const i=s[r];if(t[i]!==e[i]&&!Hn(n,i))return!0}return!1}function ml({vnode:e,parent:t},n){for(;t;){const s=t.subTree;if(s.suspense&&s.suspense.activeBranch===e&&(s.el=e.el),s===e)(e=t.vnode).el=n,t=t.parent;else break}}const di="components";function At(e,t){return bl(di,e,!0,t)||e}const vl=Symbol.for("v-ndc");function bl(e,t,n=!0,s=!1){const r=ge||xe;if(r){const i=r.type;if(e===di){const l=ji(i,!1);if(l&&(l===t||l===Ke(t)||l===Ln(Ke(t))))return i}const o=Qs(r[e]||i[e],t)||Qs(r.appContext[e],t);return!o&&s?i:o}}function Qs(e,t){return e&&(e[t]||e[Ke(t)]||e[Ln(Ke(t))])}const yl=e=>e.__isSuspense;function hi(e,t){t&&t.pendingBranch?D(e)?t.effects.push(...e):t.effects.push(e):fl(e)}function Dn(e,t,n=xe,s=!1){if(n){const r=n[e]||(n[e]=[]),i=t.__weh||(t.__weh=(...o)=>{Xe();const l=en(n),a=Fe(t,n,e,o);return l(),Ze(),a});return s?r.unshift(i):r.push(i),i}}const Qe=e=>(t,n=xe)=>{(!Fn||e==="sp")&&Dn(e,(...s)=>t(...s),n)},pi=Qe("bm"),bt=Qe("m"),xl=Qe("bu"),_i=Qe("u"),gi=Qe("bum"),Nn=Qe("um"),wl=Qe("sp"),Cl=Qe("rtg"),kl=Qe("rtc");function Sl(e,t=xe){Dn("ec",e,t)}function Tl(e,t){if(ge===null)return e;const n=Un(ge),s=e.dirs||(e.dirs=[]);for(let r=0;r<t.length;r++){let[i,o,l,a=te]=t[r];i&&(U(i)&&(i={mounted:i,updated:i}),i.deep&&rt(o),s.push({dir:i,instance:n,value:o,oldValue:void 0,arg:l,modifiers:a}))}return e}function Be(e,t,n,s){const r=e.dirs,i=t&&t.dirs;for(let o=0;o<r.length;o++){const l=r[o];i&&(l.oldValue=i[o].value);let a=l.dir[s];a&&(Xe(),Fe(a,n,8,[e.el,l,e,t]),Ze())}}function Zt(e,t,n,s){let r;const i=n&&n[s];if(D(e)||le(e)){r=new Array(e.length);for(let o=0,l=e.length;o<l;o++)r[o]=t(e[o],o,void 0,i&&i[o])}else if(typeof e=="number"){r=new Array(e);for(let o=0;o<e;o++)r[o]=t(o+1,o,void 0,i&&i[o])}else if(ne(e))if(e[Symbol.iterator])r=Array.from(e,(o,l)=>t(o,l,void 0,i&&i[l]));else{const o=Object.keys(e);r=new Array(o.length);for(let l=0,a=o.length;l<a;l++){const u=o[l];r[l]=t(e[u],u,l,i&&i[l])}}else r=[];return n&&(n[s]=r),r}/*! #__NO_SIDE_EFFECTS__ */function se(e,t){return U(e)?(()=>pe({name:e.name},t,{setup:e}))():e}const $t=e=>!!e.type.__asyncLoader;function oe(e,t,n={},s,r){if(ge.isCE||ge.parent&&$t(ge.parent)&&ge.parent.isCE)return t!=="default"&&(n.name=t),j("slot",n,s&&s());let i=e[t];i&&i._c&&(i._d=!1),A();const o=i&&mi(i(n)),l=be(de,{key:n.key||o&&o.key||`_${t}`},o||(s?s():[]),o&&e._===1?64:-2);return!r&&l.scopeId&&(l.slotScopeIds=[l.scopeId+"-s"]),i&&i._c&&(i._d=!0),l}function mi(e){return e.some(t=>Cn(t)?!(t.type===Je||t.type===de&&!mi(t.children)):!0)?e:null}const rs=e=>e?Fi(e)?Un(e):rs(e.parent):null,Bt=pe(Object.create(null),{$:e=>e,$el:e=>e.vnode.el,$data:e=>e.data,$props:e=>e.props,$attrs:e=>e.attrs,$slots:e=>e.slots,$refs:e=>e.refs,$parent:e=>rs(e.parent),$root:e=>rs(e.root),$emit:e=>e.emit,$options:e=>$s(e),$forceUpdate:e=>e.f||(e.f=()=>{e.effect.dirty=!0,ks(e.update)}),$nextTick:e=>e.n||(e.n=ai.bind(e.proxy)),$watch:e=>Zl.bind(e)}),Yn=(e,t)=>e!==te&&!e.__isScriptSetup&&Y(e,t),$l={get({_:e},t){if(t==="__v_skip")return!0;const{ctx:n,setupState:s,data:r,props:i,accessCache:o,type:l,appContext:a}=e;let u;if(t[0]!=="$"){const T=o[t];if(T!==void 0)switch(T){case 1:return s[t];case 2:return r[t];case 4:return n[t];case 3:return i[t]}else{if(Yn(s,t))return o[t]=1,s[t];if(r!==te&&Y(r,t))return o[t]=2,r[t];if((u=e.propsOptions[0])&&Y(u,t))return o[t]=3,i[t];if(n!==te&&Y(n,t))return o[t]=4,n[t];is&&(o[t]=0)}}const d=Bt[t];let _,b;if(d)return t==="$attrs"&&Ae(e.attrs,"get",""),d(e);if((_=l.__cssModules)&&(_=_[t]))return _;if(n!==te&&Y(n,t))return o[t]=4,n[t];if(b=a.config.globalProperties,Y(b,t))return b[t]},set({_:e},t,n){const{data:s,setupState:r,ctx:i}=e;return Yn(r,t)?(r[t]=n,!0):s!==te&&Y(s,t)?(s[t]=n,!0):Y(e.props,t)||t[0]==="$"&&t.slice(1)in e?!1:(i[t]=n,!0)},has({_:{data:e,setupState:t,accessCache:n,ctx:s,appContext:r,propsOptions:i}},o){let l;return!!n[o]||e!==te&&Y(e,o)||Yn(t,o)||(l=i[0])&&Y(l,o)||Y(s,o)||Y(Bt,o)||Y(r.config.globalProperties,o)},defineProperty(e,t,n){return n.get!=null?e._.accessCache[t]=0:Y(n,"value")&&this.set(e,t,n.value,null),Reflect.defineProperty(e,t,n)}};function er(e){return D(e)?e.reduce((t,n)=>(t[n]=null,t),{}):e}let is=!0;function Al(e){const t=$s(e),n=e.proxy,s=e.ctx;is=!1,t.beforeCreate&&tr(t.beforeCreate,e,"bc");const{data:r,computed:i,methods:o,watch:l,provide:a,inject:u,created:d,beforeMount:_,mounted:b,beforeUpdate:T,updated:F,activated:V,deactivated:ue,beforeDestroy:re,beforeUnmount:ae,destroyed:h,unmounted:y,render:R,renderTracked:I,renderTriggered:q,errorCaptured:J,serverPrefetch:Q,expose:B,inheritAttrs:ie,components:_e,directives:ce,filters:Ce}=t;if(u&&Il(u,s,null),o)for(const z in o){const E=o[z];U(E)&&(s[z]=E.bind(n))}if(r){const z=r.call(n,n);ne(z)&&(e.data=Rt(z))}if(is=!0,i)for(const z in i){const E=i[z],Le=U(E)?E.bind(n,n):U(E.get)?E.get.bind(n,n):Ee,yt=!U(E)&&U(E.set)?E.set.bind(n):Ee,ct=K({get:Le,set:yt});Object.defineProperty(s,z,{enumerable:!0,configurable:!0,get:()=>ct.value,set:Ue=>ct.value=Ue})}if(l)for(const z in l)vi(l[z],s,n,z);if(a){const z=U(a)?a.call(n):a;Reflect.ownKeys(z).forEach(E=>{Ft(E,z[E])})}d&&tr(d,e,"c");function O(z,E){D(E)?E.forEach(Le=>z(Le.bind(n))):E&&z(E.bind(n))}if(O(pi,_),O(bt,b),O(xl,T),O(_i,F),O(Ql,V),O(ea,ue),O(Sl,J),O(kl,I),O(Cl,q),O(gi,ae),O(Nn,y),O(wl,Q),D(B))if(B.length){const z=e.exposed||(e.exposed={});B.forEach(E=>{Object.defineProperty(z,E,{get:()=>n[E],set:Le=>n[E]=Le})})}else e.exposed||(e.exposed={});R&&e.render===Ee&&(e.render=R),ie!=null&&(e.inheritAttrs=ie),_e&&(e.components=_e),ce&&(e.directives=ce)}function Il(e,t,n=Ee){D(e)&&(e=os(e));for(const s in e){const r=e[s];let i;ne(r)?"default"in r?i=_t(r.from||s,r.default,!0):i=_t(r.from||s):i=_t(r),we(i)?Object.defineProperty(t,s,{enumerable:!0,configurable:!0,get:()=>i.value,set:o=>i.value=o}):t[s]=i}}function tr(e,t,n){Fe(D(e)?e.map(s=>s.bind(t.proxy)):e.bind(t.proxy),t,n)}function vi(e,t,n,s){const r=s.includes(".")?Ri(n,s):()=>n[s];if(le(e)){const i=t[e];U(i)&&We(r,i)}else if(U(e))We(r,e.bind(n));else if(ne(e))if(D(e))e.forEach(i=>vi(i,t,n,s));else{const i=U(e.handler)?e.handler.bind(n):t[e.handler];U(i)&&We(r,i,e)}}function $s(e){const t=e.type,{mixins:n,extends:s}=t,{mixins:r,optionsCache:i,config:{optionMergeStrategies:o}}=e.appContext,l=i.get(t);let a;return l?a=l:!r.length&&!n&&!s?a=t:(a={},r.length&&r.forEach(u=>xn(a,u,o,!0)),xn(a,t,o)),ne(t)&&i.set(t,a),a}function xn(e,t,n,s=!1){const{mixins:r,extends:i}=t;i&&xn(e,i,n,!0),r&&r.forEach(o=>xn(e,o,n,!0));for(const o in t)if(!(s&&o==="expose")){const l=El[o]||n&&n[o];e[o]=l?l(e[o],t[o]):t[o]}return e}const El={data:nr,props:sr,emits:sr,methods:Nt,computed:Nt,beforeCreate:ke,created:ke,beforeMount:ke,mounted:ke,beforeUpdate:ke,updated:ke,beforeDestroy:ke,beforeUnmount:ke,destroyed:ke,unmounted:ke,activated:ke,deactivated:ke,errorCaptured:ke,serverPrefetch:ke,components:Nt,directives:Nt,watch:Pl,provide:nr,inject:Ll};function nr(e,t){return t?e?function(){return pe(U(e)?e.call(this,this):e,U(t)?t.call(this,this):t)}:t:e}function Ll(e,t){return Nt(os(e),os(t))}function os(e){if(D(e)){const t={};for(let n=0;n<e.length;n++)t[e[n]]=e[n];return t}return e}function ke(e,t){return e?[...new Set([].concat(e,t))]:t}function Nt(e,t){return e?pe(Object.create(null),e,t):t}function sr(e,t){return e?D(e)&&D(t)?[...new Set([...e,...t])]:pe(Object.create(null),er(e),er(t!=null?t:{})):t}function Pl(e,t){if(!e)return t;if(!t)return e;const n=pe(Object.create(null),e);for(const s in t)n[s]=ke(e[s],t[s]);return n}function bi(){return{app:null,config:{isNativeTag:ho,performance:!1,globalProperties:{},optionMergeStrategies:{},errorHandler:void 0,warnHandler:void 0,compilerOptions:{}},mixins:[],components:{},directives:{},provides:Object.create(null),optionsCache:new WeakMap,propsCache:new WeakMap,emitsCache:new WeakMap}}let Rl=0;function Ol(e,t){return function(s,r=null){U(s)||(s=pe({},s)),r!=null&&!ne(r)&&(r=null);const i=bi(),o=new WeakSet;let l=!1;const a=i.app={_uid:Rl++,_component:s,_props:r,_container:null,_context:i,_instance:null,version:ga,get config(){return i.config},set config(u){},use(u,...d){return o.has(u)||(u&&U(u.install)?(o.add(u),u.install(a,...d)):U(u)&&(o.add(u),u(a,...d))),a},mixin(u){return i.mixins.includes(u)||i.mixins.push(u),a},component(u,d){return d?(i.components[u]=d,a):i.components[u]},directive(u,d){return d?(i.directives[u]=d,a):i.directives[u]},mount(u,d,_){if(!l){const b=j(s,r);return b.appContext=i,_===!0?_="svg":_===!1&&(_=void 0),d&&t?t(b,u):e(b,u,_),l=!0,a._container=u,u.__vue_app__=a,Un(b.component)}},unmount(){l&&(e(null,a._container),delete a._container.__vue_app__)},provide(u,d){return i.provides[u]=d,a},runWithContext(u){const d=Vt;Vt=a;try{return u()}finally{Vt=d}}};return a}}let Vt=null;function Ft(e,t){if(xe){let n=xe.provides;const s=xe.parent&&xe.parent.provides;s===n&&(n=xe.provides=Object.create(s)),n[e]=t}}function _t(e,t,n=!1){const s=xe||ge;if(s||Vt){const r=s?s.parent==null?s.vnode.appContext&&s.vnode.appContext.provides:s.parent.provides:Vt._context.provides;if(r&&e in r)return r[e];if(arguments.length>1)return n&&U(t)?t.call(s&&s.proxy):t}}const yi={},xi=()=>Object.create(yi),wi=e=>Object.getPrototypeOf(e)===yi;function Hl(e,t,n,s=!1){const r={},i=xi();e.propsDefaults=Object.create(null),Ci(e,t,r,i);for(const o in e.propsOptions[0])o in r||(r[o]=void 0);n?e.props=s?r:Xo(r):e.type.props?e.props=r:e.props=i,e.attrs=i}function Ml(e,t,n,s){const{props:r,attrs:i,vnode:{patchFlag:o}}=e,l=G(r),[a]=e.propsOptions;let u=!1;if((s||o>0)&&!(o&16)){if(o&8){const d=e.vnode.dynamicProps;for(let _=0;_<d.length;_++){let b=d[_];if(Hn(e.emitsOptions,b))continue;const T=t[b];if(a)if(Y(i,b))T!==i[b]&&(i[b]=T,u=!0);else{const F=Ke(b);r[F]=ls(a,l,F,T,e,!1)}else T!==i[b]&&(i[b]=T,u=!0)}}}else{Ci(e,t,r,i)&&(u=!0);let d;for(const _ in l)(!t||!Y(t,_)&&((d=vt(_))===_||!Y(t,d)))&&(a?n&&(n[_]!==void 0||n[d]!==void 0)&&(r[_]=ls(a,l,_,void 0,e,!0)):delete r[_]);if(i!==l)for(const _ in i)(!t||!Y(t,_)&&!0)&&(delete i[_],u=!0)}u&&Ye(e.attrs,"set","")}function Ci(e,t,n,s){const[r,i]=e.propsOptions;let o=!1,l;if(t)for(let a in t){if(St(a))continue;const u=t[a];let d;r&&Y(r,d=Ke(a))?!i||!i.includes(d)?n[d]=u:(l||(l={}))[d]=u:Hn(e.emitsOptions,a)||(!(a in s)||u!==s[a])&&(s[a]=u,o=!0)}if(i){const a=G(n),u=l||te;for(let d=0;d<i.length;d++){const _=i[d];n[_]=ls(r,a,_,u[_],e,!Y(u,_))}}return o}function ls(e,t,n,s,r,i){const o=e[n];if(o!=null){const l=Y(o,"default");if(l&&s===void 0){const a=o.default;if(o.type!==Function&&!o.skipFactory&&U(a)){const{propsDefaults:u}=r;if(n in u)s=u[n];else{const d=en(r);s=u[n]=a.call(null,t),d()}}else s=a}o[0]&&(i&&!l?s=!1:o[1]&&(s===""||s===vt(n))&&(s=!0))}return s}function ki(e,t,n=!1){const s=t.propsCache,r=s.get(e);if(r)return r;const i=e.props,o={},l=[];let a=!1;if(!U(e)){const d=_=>{a=!0;const[b,T]=ki(_,t,!0);pe(o,b),T&&l.push(...T)};!n&&t.mixins.length&&t.mixins.forEach(d),e.extends&&d(e.extends),e.mixins&&e.mixins.forEach(d)}if(!i&&!a)return ne(e)&&s.set(e,Ct),Ct;if(D(i))for(let d=0;d<i.length;d++){const _=Ke(i[d]);rr(_)&&(o[_]=te)}else if(i)for(const d in i){const _=Ke(d);if(rr(_)){const b=i[d],T=o[_]=D(b)||U(b)?{type:b}:pe({},b);if(T){const F=lr(Boolean,T.type),V=lr(String,T.type);T[0]=F>-1,T[1]=V<0||F<V,(F>-1||Y(T,"default"))&&l.push(_)}}}const u=[o,l];return ne(e)&&s.set(e,u),u}function rr(e){return e[0]!=="$"&&!St(e)}function ir(e){return e===null?"null":typeof e=="function"?e.name||"":typeof e=="object"&&e.constructor&&e.constructor.name||""}function or(e,t){return ir(e)===ir(t)}function lr(e,t){return D(t)?t.findIndex(n=>or(n,e)):U(t)&&or(t,e)?0:-1}const Si=e=>e[0]==="_"||e==="$stable",As=e=>D(e)?e.map(Me):[Me(e)],Dl=(e,t,n)=>{if(t._n)return t;const s=Re((...r)=>As(t(...r)),n);return s._c=!1,s},Ti=(e,t,n)=>{const s=e._ctx;for(const r in e){if(Si(r))continue;const i=e[r];if(U(i))t[r]=Dl(r,i,s);else if(i!=null){const o=As(i);t[r]=()=>o}}},$i=(e,t)=>{const n=As(t);e.slots.default=()=>n},Nl=(e,t)=>{const n=e.slots=xi();if(e.vnode.shapeFlag&32){const s=t._;s?(pe(n,t),Fr(n,"_",s,!0)):Ti(t,n)}else t&&$i(e,t)},Fl=(e,t,n)=>{const{vnode:s,slots:r}=e;let i=!0,o=te;if(s.shapeFlag&32){const l=t._;l?n&&l===1?i=!1:(pe(r,t),!n&&l===1&&delete r._):(i=!t.$stable,Ti(t,r)),o=t}else t&&($i(e,t),o={default:1});if(i)for(const l in r)!Si(l)&&o[l]==null&&delete r[l]};function wn(e,t,n,s,r=!1){if(D(e)){e.forEach((b,T)=>wn(b,t&&(D(t)?t[T]:t),n,s,r));return}if($t(s)&&!r)return;const i=s.shapeFlag&4?Un(s.component):s.el,o=r?null:i,{i:l,r:a}=e,u=t&&t.r,d=l.refs===te?l.refs={}:l.refs,_=l.setupState;if(u!=null&&u!==a&&(le(u)?(d[u]=null,Y(_,u)&&(_[u]=null)):we(u)&&(u.value=null)),U(a))Ge(a,l,12,[o,d]);else{const b=le(a),T=we(a);if(b||T){const F=()=>{if(e.f){const V=b?Y(_,a)?_[a]:d[a]:a.value;r?D(V)&&fs(V,i):D(V)?V.includes(i)||V.push(i):b?(d[a]=[i],Y(_,a)&&(_[a]=d[a])):(a.value=[i],e.k&&(d[e.k]=a.value))}else b?(d[a]=o,Y(_,a)&&(_[a]=o)):T&&(a.value=o,e.k&&(d[e.k]=o))};o?(F.id=-1,$e(F,n)):F()}}}let ar=!1;const ut=()=>{ar||(console.error("Hydration completed but contains mismatches."),ar=!0)},Ul=e=>e.namespaceURI.includes("svg")&&e.tagName!=="foreignObject",jl=e=>e.namespaceURI.includes("MathML"),cn=e=>{if(Ul(e))return"svg";if(jl(e))return"mathml"},Ht=e=>e.nodeType===8;function Bl(e){const{mt:t,p:n,o:{patchProp:s,createText:r,nextSibling:i,parentNode:o,remove:l,insert:a,createComment:u}}=e,d=(h,y)=>{if(!y.hasChildNodes()){__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&tt("Attempting to hydrate existing markup but container is empty. Performing full mount instead."),n(null,h,y),bn(),y._vnode=h;return}_(y.firstChild,h,null,null,null),bn(),y._vnode=h},_=(h,y,R,I,q,J=!1)=>{J=J||!!y.dynamicChildren;const Q=Ht(h)&&h.data==="[",B=()=>V(h,y,R,I,q,Q),{type:ie,ref:_e,shapeFlag:ce,patchFlag:Ce}=y;let Te=h.nodeType;y.el=h,Ce===-2&&(J=!1,y.dynamicChildren=null);let O=null;switch(ie){case It:Te!==3?y.children===""?(a(y.el=r(""),o(h),h),O=h):O=B():(h.data!==y.children&&(__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&tt("Hydration text mismatch in",h.parentNode,`
+  - rendered on server: ${JSON.stringify(h.data)}
+  - expected on client: ${JSON.stringify(y.children)}`),ut(),h.data=y.children),O=i(h));break;case Je:ae(h)?(O=i(h),re(y.el=h.content.firstChild,h,R)):Te!==8||Q?O=B():O=i(h);break;case Wt:if(Q&&(h=i(h),Te=h.nodeType),Te===1||Te===3){O=h;const z=!y.children.length;for(let E=0;E<y.staticCount;E++)z&&(y.children+=O.nodeType===1?O.outerHTML:O.data),E===y.staticCount-1&&(y.anchor=O),O=i(O);return Q?i(O):O}else B();break;case de:Q?O=F(h,y,R,I,q,J):O=B();break;default:if(ce&1)(Te!==1||y.type.toLowerCase()!==h.tagName.toLowerCase())&&!ae(h)?O=B():O=b(h,y,R,I,q,J);else if(ce&6){y.slotScopeIds=q;const z=o(h);if(Q?O=ue(h):Ht(h)&&h.data==="teleport start"?O=ue(h,h.data,"teleport end"):O=i(h),t(y,z,null,R,I,cn(z),J),$t(y)){let E;Q?(E=j(de),E.anchor=O?O.previousSibling:z.lastChild):E=h.nodeType===3?Qt(""):j("div"),E.el=h,y.component.subTree=E}}else ce&64?Te!==8?O=B():O=y.type.hydrate(h,y,R,I,q,J,e,T):ce&128?O=y.type.hydrate(h,y,R,I,cn(o(h)),q,J,e,_):__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&tt("Invalid HostVNode type:",ie,`(${typeof ie})`)}return _e!=null&&wn(_e,null,I,y),O},b=(h,y,R,I,q,J)=>{J=J||!!y.dynamicChildren;const{type:Q,props:B,patchFlag:ie,shapeFlag:_e,dirs:ce,transition:Ce}=y,Te=Q==="input"||Q==="option";if(Te||ie!==-1){ce&&Be(y,null,R,"created");let O=!1;if(ae(h)){O=Ii(I,Ce)&&R&&R.vnode.props&&R.vnode.props.appear;const E=h.content.firstChild;O&&Ce.beforeEnter(E),re(E,h,R),y.el=h=E}if(_e&16&&!(B&&(B.innerHTML||B.textContent))){let E=T(h.firstChild,y,h,R,I,q,J),Le=!1;for(;E;){__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&!Le&&(tt("Hydration children mismatch on",h,`
+Server rendered element contains more child nodes than client vdom.`),Le=!0),ut();const yt=E;E=E.nextSibling,l(yt)}}else _e&8&&h.textContent!==y.children&&(__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&tt("Hydration text content mismatch on",h,`
+  - rendered on server: ${h.textContent}
+  - expected on client: ${y.children}`),ut(),h.textContent=y.children);if(B)if(__VUE_PROD_HYDRATION_MISMATCH_DETAILS__||Te||!J||ie&48)for(const E in B)__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&!(ce&&ce.some(Le=>Le.dir.created))&&Vl(h,E,B[E],y,R)&&ut(),(Te&&(E.endsWith("value")||E==="indeterminate")||Xt(E)&&!St(E)||E[0]===".")&&s(h,E,null,B[E],void 0,void 0,R);else B.onClick&&s(h,"onClick",null,B.onClick,void 0,void 0,R);let z;(z=B&&B.onVnodeBeforeMount)&&Pe(z,R,y),ce&&Be(y,null,R,"beforeMount"),((z=B&&B.onVnodeMounted)||ce||O)&&hi(()=>{z&&Pe(z,R,y),O&&Ce.enter(h),ce&&Be(y,null,R,"mounted")},I)}return h.nextSibling},T=(h,y,R,I,q,J,Q)=>{Q=Q||!!y.dynamicChildren;const B=y.children,ie=B.length;let _e=!1;for(let ce=0;ce<ie;ce++){const Ce=Q?B[ce]:B[ce]=Me(B[ce]);h?h=_(h,Ce,I,q,J,Q):Ce.type===It&&!Ce.children?a(Ce.el=r(""),R):(__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&!_e&&(tt("Hydration children mismatch on",R,`
+Server rendered element contains fewer child nodes than client vdom.`),_e=!0),ut(),n(null,Ce,R,null,I,q,cn(R),J))}return h},F=(h,y,R,I,q,J)=>{const{slotScopeIds:Q}=y;Q&&(q=q?q.concat(Q):Q);const B=o(h),ie=T(i(h),y,B,R,I,q,J);return ie&&Ht(ie)&&ie.data==="]"?i(y.anchor=ie):(ut(),a(y.anchor=u("]"),B,ie),ie)},V=(h,y,R,I,q,J)=>{if(__VUE_PROD_HYDRATION_MISMATCH_DETAILS__&&tt(`Hydration node mismatch:
+- rendered on server:`,h,h.nodeType===3?"(text)":Ht(h)&&h.data==="["?"(start of fragment)":"",`
+- expected on client:`,y.type),ut(),y.el=null,J){const ie=ue(h);for(;;){const _e=i(h);if(_e&&_e!==ie)l(_e);else break}}const Q=i(h),B=o(h);return l(h),n(null,y,B,Q,R,I,cn(B),q),Q},ue=(h,y="[",R="]")=>{let I=0;for(;h;)if(h=i(h),h&&Ht(h)&&(h.data===y&&I++,h.data===R)){if(I===0)return i(h);I--}return h},re=(h,y,R)=>{const I=y.parentNode;I&&I.replaceChild(h,y);let q=R;for(;q;)q.vnode.el===y&&(q.vnode.el=q.subTree.el=h),q=q.parent},ae=h=>h.nodeType===1&&h.tagName.toLowerCase()==="template";return[d,_]}function Vl(e,t,n,s,r){let i,o,l,a;if(t==="class")l=e.getAttribute("class"),a=Se(n),Wl(cr(l||""),cr(a))||(i=o="class");else if(t==="style"){l=e.getAttribute("style")||"",a=le(n)?n:Co(Pn(n));const u=ur(l),d=ur(a);if(s.dirs)for(const{dir:_,value:b}of s.dirs)_.name==="show"&&!b&&d.set("display","none");r&&Ai(r,s,d),Kl(u,d)||(i=o="style")}else(e instanceof SVGElement&&To(t)||e instanceof HTMLElement&&(Vs(t)||So(t)))&&(Vs(t)?(l=e.hasAttribute(t),a=ps(n)):n==null?(l=e.hasAttribute(t),a=!1):(e.hasAttribute(t)?l=e.getAttribute(t):t==="value"&&e.tagName==="TEXTAREA"?l=e.value:l=!1,a=$o(n)?String(n):!1),l!==a&&(i="attribute",o=t));if(i){const u=b=>b===!1?"(not rendered)":`${o}="${b}"`,d=`Hydration ${i} mismatch on`,_=`
+  - rendered on server: ${u(l)}
+  - expected on client: ${u(a)}
+  Note: this mismatch is check-only. The DOM will not be rectified in production due to performance overhead.
+  You should fix the source of the mismatch.`;return tt(d,e,_),!0}return!1}function cr(e){return new Set(e.trim().split(/\s+/))}function Wl(e,t){if(e.size!==t.size)return!1;for(const n of e)if(!t.has(n))return!1;return!0}function ur(e){const t=new Map;for(const n of e.split(";")){let[s,r]=n.split(":");s=s.trim(),r=r&&r.trim(),s&&r&&t.set(s,r)}return t}function Kl(e,t){if(e.size!==t.size)return!1;for(const[n,s]of e)if(s!==t.get(n))return!1;return!0}function Ai(e,t,n){const s=e.subTree;if(e.getCssVars&&(t===s||s&&s.type===de&&s.children.includes(t))){const r=e.getCssVars();for(const i in r)n.set(`--${i}`,String(r[i]))}t===s&&e.parent&&Ai(e.parent,e.vnode,n)}function ql(){typeof __VUE_PROD_HYDRATION_MISMATCH_DETAILS__!="boolean"&&(hs().__VUE_PROD_HYDRATION_MISMATCH_DETAILS__=!1)}const $e=hi;function zl(e){return Yl(e,Bl)}function Yl(e,t){ql();const n=hs();n.__VUE__=!0;const{insert:s,remove:r,patchProp:i,createElement:o,createText:l,createComment:a,setText:u,setElementText:d,parentNode:_,nextSibling:b,setScopeId:T=Ee,insertStaticContent:F}=e,V=(c,f,p,g=null,m=null,w=null,k=void 0,x=null,C=!!f.dynamicChildren)=>{if(c===f)return;c&&!Mt(c,f)&&(g=nn(c),Ue(c,m,w,!0),c=null),f.patchFlag===-2&&(C=!1,f.dynamicChildren=null);const{type:v,ref:S,shapeFlag:P}=f;switch(v){case It:ue(c,f,p,g);break;case Je:re(c,f,p,g);break;case Wt:c==null&&ae(f,p,g,k);break;case de:_e(c,f,p,g,m,w,k,x,C);break;default:P&1?R(c,f,p,g,m,w,k,x,C):P&6?ce(c,f,p,g,m,w,k,x,C):(P&64||P&128)&&v.process(c,f,p,g,m,w,k,x,C,xt)}S!=null&&m&&wn(S,c&&c.ref,w,f||c,!f)},ue=(c,f,p,g)=>{if(c==null)s(f.el=l(f.children),p,g);else{const m=f.el=c.el;f.children!==c.children&&u(m,f.children)}},re=(c,f,p,g)=>{c==null?s(f.el=a(f.children||""),p,g):f.el=c.el},ae=(c,f,p,g)=>{[c.el,c.anchor]=F(c.children,f,p,g,c.el,c.anchor)},h=({el:c,anchor:f},p,g)=>{let m;for(;c&&c!==f;)m=b(c),s(c,p,g),c=m;s(f,p,g)},y=({el:c,anchor:f})=>{let p;for(;c&&c!==f;)p=b(c),r(c),c=p;r(f)},R=(c,f,p,g,m,w,k,x,C)=>{f.type==="svg"?k="svg":f.type==="math"&&(k="mathml"),c==null?I(f,p,g,m,w,k,x,C):Q(c,f,m,w,k,x,C)},I=(c,f,p,g,m,w,k,x)=>{let C,v;const{props:S,shapeFlag:P,transition:L,dirs:N}=c;if(C=c.el=o(c.type,w,S&&S.is,S),P&8?d(C,c.children):P&16&&J(c.children,C,null,g,m,Gn(c,w),k,x),N&&Be(c,null,g,"created"),q(C,c,c.scopeId,k,g),S){for(const ee in S)ee!=="value"&&!St(ee)&&i(C,ee,null,S[ee],w,c.children,g,m,qe);"value"in S&&i(C,"value",null,S.value,w),(v=S.onVnodeBeforeMount)&&Pe(v,g,c)}N&&Be(c,null,g,"beforeMount");const W=Ii(m,L);W&&L.beforeEnter(C),s(C,f,p),((v=S&&S.onVnodeMounted)||W||N)&&$e(()=>{v&&Pe(v,g,c),W&&L.enter(C),N&&Be(c,null,g,"mounted")},m)},q=(c,f,p,g,m)=>{if(p&&T(c,p),g)for(let w=0;w<g.length;w++)T(c,g[w]);if(m){let w=m.subTree;if(f===w){const k=m.vnode;q(c,k,k.scopeId,k.slotScopeIds,m.parent)}}},J=(c,f,p,g,m,w,k,x,C=0)=>{for(let v=C;v<c.length;v++){const S=c[v]=x?st(c[v]):Me(c[v]);V(null,S,f,p,g,m,w,k,x)}},Q=(c,f,p,g,m,w,k)=>{const x=f.el=c.el;let{patchFlag:C,dynamicChildren:v,dirs:S}=f;C|=c.patchFlag&16;const P=c.props||te,L=f.props||te;let N;if(p&&ft(p,!1),(N=L.onVnodeBeforeUpdate)&&Pe(N,p,f,c),S&&Be(f,c,p,"beforeUpdate"),p&&ft(p,!0),v?B(c.dynamicChildren,v,x,p,g,Gn(f,m),w):k||E(c,f,x,null,p,g,Gn(f,m),w,!1),C>0){if(C&16)ie(x,f,P,L,p,g,m);else if(C&2&&P.class!==L.class&&i(x,"class",null,L.class,m),C&4&&i(x,"style",P.style,L.style,m),C&8){const W=f.dynamicProps;for(let ee=0;ee<W.length;ee++){const X=W[ee],he=P[X],Oe=L[X];(Oe!==he||X==="value")&&i(x,X,he,Oe,m,c.children,p,g,qe)}}C&1&&c.children!==f.children&&d(x,f.children)}else!k&&v==null&&ie(x,f,P,L,p,g,m);((N=L.onVnodeUpdated)||S)&&$e(()=>{N&&Pe(N,p,f,c),S&&Be(f,c,p,"updated")},g)},B=(c,f,p,g,m,w,k)=>{for(let x=0;x<f.length;x++){const C=c[x],v=f[x],S=C.el&&(C.type===de||!Mt(C,v)||C.shapeFlag&70)?_(C.el):p;V(C,v,S,null,g,m,w,k,!0)}},ie=(c,f,p,g,m,w,k)=>{if(p!==g){if(p!==te)for(const x in p)!St(x)&&!(x in g)&&i(c,x,p[x],null,k,f.children,m,w,qe);for(const x in g){if(St(x))continue;const C=g[x],v=p[x];C!==v&&x!=="value"&&i(c,x,v,C,k,f.children,m,w,qe)}"value"in g&&i(c,"value",p.value,g.value,k)}},_e=(c,f,p,g,m,w,k,x,C)=>{const v=f.el=c?c.el:l(""),S=f.anchor=c?c.anchor:l("");let{patchFlag:P,dynamicChildren:L,slotScopeIds:N}=f;N&&(x=x?x.concat(N):N),c==null?(s(v,p,g),s(S,p,g),J(f.children||[],p,S,m,w,k,x,C)):P>0&&P&64&&L&&c.dynamicChildren?(B(c.dynamicChildren,L,p,m,w,k,x),(f.key!=null||m&&f===m.subTree)&&Ei(c,f,!0)):E(c,f,p,S,m,w,k,x,C)},ce=(c,f,p,g,m,w,k,x,C)=>{f.slotScopeIds=x,c==null?f.shapeFlag&512?m.ctx.activate(f,p,g,k,C):Ce(f,p,g,m,w,k,C):Te(c,f,C)},Ce=(c,f,p,g,m,w,k)=>{const x=c.component=aa(c,g,m);if(Oi(c)&&(x.ctx.renderer=xt),ca(x),x.asyncDep){if(m&&m.registerDep(x,O,k),!c.el){const C=x.subTree=j(Je);re(null,C,f,p)}}else O(x,c,f,p,m,w,k)},Te=(c,f,p)=>{const g=f.component=c.component;if(gl(c,f,p))if(g.asyncDep&&!g.asyncResolved){z(g,f,p);return}else g.next=f,ul(g.update),g.effect.dirty=!0,g.update();else f.el=c.el,g.vnode=f},O=(c,f,p,g,m,w,k)=>{const x=()=>{if(c.isMounted){let{next:S,bu:P,u:L,parent:N,vnode:W}=c;{const wt=Li(c);if(wt){S&&(S.el=W.el,z(c,S,k)),wt.asyncDep.then(()=>{c.isUnmounted||x()});return}}let ee=S,X;ft(c,!1),S?(S.el=W.el,z(c,S,k)):S=W,P&&Kn(P),(X=S.props&&S.props.onVnodeBeforeUpdate)&&Pe(X,N,S,W),ft(c,!0);const he=zn(c),Oe=c.subTree;c.subTree=he,V(Oe,he,_(Oe.el),nn(Oe),c,m,w),S.el=he.el,ee===null&&ml(c,he.el),L&&$e(L,m),(X=S.props&&S.props.onVnodeUpdated)&&$e(()=>Pe(X,N,S,W),m)}else{let S;const{el:P,props:L}=f,{bm:N,m:W,parent:ee}=c,X=$t(f);if(ft(c,!1),N&&Kn(N),!X&&(S=L&&L.onVnodeBeforeMount)&&Pe(S,ee,f),ft(c,!0),P&&Vn){const he=()=>{c.subTree=zn(c),Vn(P,c.subTree,c,m,null)};X?f.type.__asyncLoader().then(()=>!c.isUnmounted&&he()):he()}else{const he=c.subTree=zn(c);V(null,he,p,g,c,m,w),f.el=he.el}if(W&&$e(W,m),!X&&(S=L&&L.onVnodeMounted)){const he=f;$e(()=>Pe(S,ee,he),m)}(f.shapeFlag&256||ee&&$t(ee.vnode)&&ee.vnode.shapeFlag&256)&&c.a&&$e(c.a,m),c.isMounted=!0,f=p=g=null}},C=c.effect=new _s(x,Ee,()=>ks(v),c.scope),v=c.update=()=>{C.dirty&&C.run()};v.id=c.uid,ft(c,!0),v()},z=(c,f,p)=>{f.component=c;const g=c.vnode.props;c.vnode=f,c.next=null,Ml(c,f.props,g,p),Fl(c,f.children,p),Xe(),Xs(c),Ze()},E=(c,f,p,g,m,w,k,x,C=!1)=>{const v=c&&c.children,S=c?c.shapeFlag:0,P=f.children,{patchFlag:L,shapeFlag:N}=f;if(L>0){if(L&128){yt(v,P,p,g,m,w,k,x,C);return}else if(L&256){Le(v,P,p,g,m,w,k,x,C);return}}N&8?(S&16&&qe(v,m,w),P!==v&&d(p,P)):S&16?N&16?yt(v,P,p,g,m,w,k,x,C):qe(v,m,w,!0):(S&8&&d(p,""),N&16&&J(P,p,g,m,w,k,x,C))},Le=(c,f,p,g,m,w,k,x,C)=>{c=c||Ct,f=f||Ct;const v=c.length,S=f.length,P=Math.min(v,S);let L;for(L=0;L<P;L++){const N=f[L]=C?st(f[L]):Me(f[L]);V(c[L],N,p,null,m,w,k,x,C)}v>S?qe(c,m,w,!0,!1,P):J(f,p,g,m,w,k,x,C,P)},yt=(c,f,p,g,m,w,k,x,C)=>{let v=0;const S=f.length;let P=c.length-1,L=S-1;for(;v<=P&&v<=L;){const N=c[v],W=f[v]=C?st(f[v]):Me(f[v]);if(Mt(N,W))V(N,W,p,null,m,w,k,x,C);else break;v++}for(;v<=P&&v<=L;){const N=c[P],W=f[L]=C?st(f[L]):Me(f[L]);if(Mt(N,W))V(N,W,p,null,m,w,k,x,C);else break;P--,L--}if(v>P){if(v<=L){const N=L+1,W=N<S?f[N].el:g;for(;v<=L;)V(null,f[v]=C?st(f[v]):Me(f[v]),p,W,m,w,k,x,C),v++}}else if(v>L)for(;v<=P;)Ue(c[v],m,w,!0),v++;else{const N=v,W=v,ee=new Map;for(v=W;v<=L;v++){const Ie=f[v]=C?st(f[v]):Me(f[v]);Ie.key!=null&&ee.set(Ie.key,v)}let X,he=0;const Oe=L-W+1;let wt=!1,Ns=0;const Ot=new Array(Oe);for(v=0;v<Oe;v++)Ot[v]=0;for(v=N;v<=P;v++){const Ie=c[v];if(he>=Oe){Ue(Ie,m,w,!0);continue}let je;if(Ie.key!=null)je=ee.get(Ie.key);else for(X=W;X<=L;X++)if(Ot[X-W]===0&&Mt(Ie,f[X])){je=X;break}je===void 0?Ue(Ie,m,w,!0):(Ot[je-W]=v+1,je>=Ns?Ns=je:wt=!0,V(Ie,f[je],p,null,m,w,k,x,C),he++)}const Fs=wt?Gl(Ot):Ct;for(X=Fs.length-1,v=Oe-1;v>=0;v--){const Ie=W+v,je=f[Ie],Us=Ie+1<S?f[Ie+1].el:g;Ot[v]===0?V(null,je,p,Us,m,w,k,x,C):wt&&(X<0||v!==Fs[X]?ct(je,p,Us,2):X--)}}},ct=(c,f,p,g,m=null)=>{const{el:w,type:k,transition:x,children:C,shapeFlag:v}=c;if(v&6){ct(c.component.subTree,f,p,g);return}if(v&128){c.suspense.move(f,p,g);return}if(v&64){k.move(c,f,p,xt);return}if(k===de){s(w,f,p);for(let P=0;P<C.length;P++)ct(C[P],f,p,g);s(c.anchor,f,p);return}if(k===Wt){h(c,f,p);return}if(g!==2&&v&1&&x)if(g===0)x.beforeEnter(w),s(w,f,p),$e(()=>x.enter(w),m);else{const{leave:P,delayLeave:L,afterLeave:N}=x,W=()=>s(w,f,p),ee=()=>{P(w,()=>{W(),N&&N()})};L?L(w,W,ee):ee()}else s(w,f,p)},Ue=(c,f,p,g=!1,m=!1)=>{const{type:w,props:k,ref:x,children:C,dynamicChildren:v,shapeFlag:S,patchFlag:P,dirs:L,memoIndex:N}=c;if(P===-2&&(m=!1),x!=null&&wn(x,null,p,c,!0),N!=null&&(f.renderCache[N]=void 0),S&256){f.ctx.deactivate(c);return}const W=S&1&&L,ee=!$t(c);let X;if(ee&&(X=k&&k.onVnodeBeforeUnmount)&&Pe(X,f,c),S&6)ao(c.component,p,g);else{if(S&128){c.suspense.unmount(p,g);return}W&&Be(c,null,f,"beforeUnmount"),S&64?c.type.remove(c,f,p,xt,g):v&&(w!==de||P>0&&P&64)?qe(v,f,p,!1,!0):(w===de&&P&384||!m&&S&16)&&qe(C,f,p),g&&Ms(c)}(ee&&(X=k&&k.onVnodeUnmounted)||W)&&$e(()=>{X&&Pe(X,f,c),W&&Be(c,null,f,"unmounted")},p)},Ms=c=>{const{type:f,el:p,anchor:g,transition:m}=c;if(f===de){lo(p,g);return}if(f===Wt){y(c);return}const w=()=>{r(p),m&&!m.persisted&&m.afterLeave&&m.afterLeave()};if(c.shapeFlag&1&&m&&!m.persisted){const{leave:k,delayLeave:x}=m,C=()=>k(p,w);x?x(c.el,w,C):C()}else w()},lo=(c,f)=>{let p;for(;c!==f;)p=b(c),r(c),c=p;r(f)},ao=(c,f,p)=>{const{bum:g,scope:m,update:w,subTree:k,um:x,m:C,a:v}=c;fr(C),fr(v),g&&Kn(g),m.stop(),w&&(w.active=!1,Ue(k,c,f,p)),x&&$e(x,f),$e(()=>{c.isUnmounted=!0},f),f&&f.pendingBranch&&!f.isUnmounted&&c.asyncDep&&!c.asyncResolved&&c.suspenseId===f.pendingId&&(f.deps--,f.deps===0&&f.resolve())},qe=(c,f,p,g=!1,m=!1,w=0)=>{for(let k=w;k<c.length;k++)Ue(c[k],f,p,g,m)},nn=c=>c.shapeFlag&6?nn(c.component.subTree):c.shapeFlag&128?c.suspense.next():b(c.anchor||c.el);let jn=!1;const Ds=(c,f,p)=>{c==null?f._vnode&&Ue(f._vnode,null,null,!0):V(f._vnode||null,c,f,null,null,null,p),jn||(jn=!0,Xs(),bn(),jn=!1),f._vnode=c},xt={p:V,um:Ue,m:ct,r:Ms,mt:Ce,mc:J,pc:E,pbc:B,n:nn,o:e};let Bn,Vn;return t&&([Bn,Vn]=t(xt)),{render:Ds,hydrate:Bn,createApp:Ol(Ds,Bn)}}function Gn({type:e,props:t},n){return n==="svg"&&e==="foreignObject"||n==="mathml"&&e==="annotation-xml"&&t&&t.encoding&&t.encoding.includes("html")?void 0:n}function ft({effect:e,update:t},n){e.allowRecurse=t.allowRecurse=n}function Ii(e,t){return(!e||e&&!e.pendingBranch)&&t&&!t.persisted}function Ei(e,t,n=!1){const s=e.children,r=t.children;if(D(s)&&D(r))for(let i=0;i<s.length;i++){const o=s[i];let l=r[i];l.shapeFlag&1&&!l.dynamicChildren&&((l.patchFlag<=0||l.patchFlag===32)&&(l=r[i]=st(r[i]),l.el=o.el),!n&&l.patchFlag!==-2&&Ei(o,l)),l.type===It&&(l.el=o.el)}}function Gl(e){const t=e.slice(),n=[0];let s,r,i,o,l;const a=e.length;for(s=0;s<a;s++){const u=e[s];if(u!==0){if(r=n[n.length-1],e[r]<u){t[s]=r,n.push(s);continue}for(i=0,o=n.length-1;i<o;)l=i+o>>1,e[n[l]]<u?i=l+1:o=l;u<e[n[i]]&&(i>0&&(t[s]=n[i-1]),n[i]=s)}}for(i=n.length,o=n[i-1];i-- >0;)n[i]=o,o=t[o];return n}function Li(e){const t=e.subTree.component;if(t)return t.asyncDep&&!t.asyncResolved?t:Li(t)}function fr(e){if(e)for(let t=0;t<e.length;t++)e[t].active=!1}const Jl=Symbol.for("v-scx"),Xl=()=>_t(Jl);function Pi(e,t){return Is(e,null,t)}const un={};function We(e,t,n){return Is(e,t,n)}function Is(e,t,{immediate:n,deep:s,flush:r,once:i,onTrack:o,onTrigger:l}=te){if(t&&i){const I=t;t=(...q)=>{I(...q),R()}}const a=xe,u=I=>s===!0?I:rt(I,s===!1?1:void 0);let d,_=!1,b=!1;if(we(e)?(d=()=>e.value,_=vn(e)):Ut(e)?(d=()=>u(e),_=!0):D(e)?(b=!0,_=e.some(I=>Ut(I)||vn(I)),d=()=>e.map(I=>{if(we(I))return I.value;if(Ut(I))return u(I);if(U(I))return Ge(I,a,2)})):U(e)?t?d=()=>Ge(e,a,2):d=()=>(T&&T(),Fe(e,a,3,[F])):d=Ee,t&&s){const I=d;d=()=>rt(I())}let T,F=I=>{T=h.onStop=()=>{Ge(I,a,4),T=h.onStop=void 0}},V;if(Fn)if(F=Ee,t?n&&Fe(t,a,3,[d(),b?[]:void 0,F]):d(),r==="sync"){const I=Xl();V=I.__watcherHandles||(I.__watcherHandles=[])}else return Ee;let ue=b?new Array(e.length).fill(un):un;const re=()=>{if(!(!h.active||!h.dirty))if(t){const I=h.run();(s||_||(b?I.some((q,J)=>ot(q,ue[J])):ot(I,ue)))&&(T&&T(),Fe(t,a,3,[I,ue===un?void 0:b&&ue[0]===un?[]:ue,F]),ue=I)}else h.run()};re.allowRecurse=!!t;let ae;r==="sync"?ae=re:r==="post"?ae=()=>$e(re,a&&a.suspense):(re.pre=!0,a&&(re.id=a.uid),ae=()=>ks(re));const h=new _s(d,Ee,ae),y=Eo(),R=()=>{h.stop(),y&&fs(y.effects,h)};return t?n?re():ue=h.run():r==="post"?$e(h.run.bind(h),a&&a.suspense):h.run(),V&&V.push(R),R}function Zl(e,t,n){const s=this.proxy,r=le(e)?e.includes(".")?Ri(s,e):()=>s[e]:e.bind(s,s);let i;U(t)?i=t:(i=t.handler,n=t);const o=en(this),l=Is(r,i.bind(s),n);return o(),l}function Ri(e,t){const n=t.split(".");return()=>{let s=e;for(let r=0;r<n.length&&s;r++)s=s[n[r]];return s}}function rt(e,t=1/0,n){if(t<=0||!ne(e)||e.__v_skip||(n=n||new Set,n.has(e)))return e;if(n.add(e),t--,we(e))rt(e.value,t,n);else if(D(e))for(let s=0;s<e.length;s++)rt(e[s],t,n);else if(Hr(e)||kt(e))e.forEach(s=>{rt(s,t,n)});else if(Nr(e)){for(const s in e)rt(e[s],t,n);for(const s of Object.getOwnPropertySymbols(e))Object.prototype.propertyIsEnumerable.call(e,s)&&rt(e[s],t,n)}return e}const Oi=e=>e.type.__isKeepAlive;function Ql(e,t){Hi(e,"a",t)}function ea(e,t){Hi(e,"da",t)}function Hi(e,t,n=xe){const s=e.__wdc||(e.__wdc=()=>{let r=n;for(;r;){if(r.isDeactivated)return;r=r.parent}return e()});if(Dn(t,s,n),n){let r=n.parent;for(;r&&r.parent;)Oi(r.parent.vnode)&&ta(s,t,n,r),r=r.parent}}function ta(e,t,n,s){const r=Dn(t,e,s,!0);Nn(()=>{fs(s[t],r)},n)}function Mi(e,t){e.shapeFlag&6&&e.component?Mi(e.component.subTree,t):e.shapeFlag&128?(e.ssContent.transition=t.clone(e.ssContent),e.ssFallback.transition=t.clone(e.ssFallback)):e.transition=t}const na=e=>e.__isTeleport,de=Symbol.for("v-fgt"),It=Symbol.for("v-txt"),Je=Symbol.for("v-cmt"),Wt=Symbol.for("v-stc"),Kt=[];let De=null;function A(e=!1){Kt.push(De=e?null:[])}function sa(){Kt.pop(),De=Kt[Kt.length-1]||null}let Jt=1;function dr(e){Jt+=e}function Di(e){return e.dynamicChildren=Jt>0?De||Ct:null,sa(),Jt>0&&De&&De.push(e),e}function H(e,t,n,s,r,i){return Di(M(e,t,n,s,r,i,!0))}function be(e,t,n,s,r){return Di(j(e,t,n,s,r,!0))}function Cn(e){return e?e.__v_isVNode===!0:!1}function Mt(e,t){return e.type===t.type&&e.key===t.key}const Ni=({key:e})=>e!=null?e:null,_n=({ref:e,ref_key:t,ref_for:n})=>(typeof e=="number"&&(e=""+e),e!=null?le(e)||we(e)||U(e)?{i:ge,r:e,k:t,f:!!n}:e:null);function M(e,t=null,n=null,s=0,r=null,i=e===de?0:1,o=!1,l=!1){const a={__v_isVNode:!0,__v_skip:!0,type:e,props:t,key:t&&Ni(t),ref:t&&_n(t),scopeId:Mn,slotScopeIds:null,children:n,component:null,suspense:null,ssContent:null,ssFallback:null,dirs:null,transition:null,el:null,anchor:null,target:null,targetAnchor:null,staticCount:0,shapeFlag:i,patchFlag:s,dynamicProps:r,dynamicChildren:null,appContext:null,ctx:ge};return l?(Es(a,n),i&128&&e.normalize(a)):n&&(a.shapeFlag|=le(n)?8:16),Jt>0&&!o&&De&&(a.patchFlag>0||i&6)&&a.patchFlag!==32&&De.push(a),a}const j=ra;function ra(e,t=null,n=null,s=0,r=null,i=!1){if((!e||e===vl)&&(e=Je),Cn(e)){const l=Et(e,t,!0);return n&&Es(l,n),Jt>0&&!i&&De&&(l.shapeFlag&6?De[De.indexOf(e)]=l:De.push(l)),l.patchFlag=-2,l}if(_a(e)&&(e=e.__vccOpts),t){t=ia(t);let{class:l,style:a}=t;l&&!le(l)&&(t.class=Se(l)),ne(a)&&(ti(a)&&!D(a)&&(a=pe({},a)),t.style=Pn(a))}const o=le(e)?1:yl(e)?128:na(e)?64:ne(e)?4:U(e)?2:0;return M(e,t,n,s,r,o,i,!0)}function ia(e){return e?ti(e)||wi(e)?pe({},e):e:null}function Et(e,t,n=!1,s=!1){const{props:r,ref:i,patchFlag:o,children:l,transition:a}=e,u=t?Ls(r||{},t):r,d={__v_isVNode:!0,__v_skip:!0,type:e.type,props:u,key:u&&Ni(u),ref:t&&t.ref?n&&i?D(i)?i.concat(_n(t)):[i,_n(t)]:_n(t):i,scopeId:e.scopeId,slotScopeIds:e.slotScopeIds,children:l,target:e.target,targetAnchor:e.targetAnchor,staticCount:e.staticCount,shapeFlag:e.shapeFlag,patchFlag:t&&e.type!==de?o===-1?16:o|16:o,dynamicProps:e.dynamicProps,dynamicChildren:e.dynamicChildren,appContext:e.appContext,dirs:e.dirs,transition:a,component:e.component,suspense:e.suspense,ssContent:e.ssContent&&Et(e.ssContent),ssFallback:e.ssFallback&&Et(e.ssFallback),el:e.el,anchor:e.anchor,ctx:e.ctx,ce:e.ce};return a&&s&&Mi(d,a.clone(d)),d}function Qt(e=" ",t=0){return j(It,null,e,t)}function ld(e,t){const n=j(Wt,null,e);return n.staticCount=t,n}function Z(e="",t=!1){return t?(A(),be(Je,null,e)):j(Je,null,e)}function Me(e){return e==null||typeof e=="boolean"?j(Je):D(e)?j(de,null,e.slice()):typeof e=="object"?st(e):j(It,null,String(e))}function st(e){return e.el===null&&e.patchFlag!==-1||e.memo?e:Et(e)}function Es(e,t){let n=0;const{shapeFlag:s}=e;if(t==null)t=null;else if(D(t))n=16;else if(typeof t=="object")if(s&65){const r=t.default;r&&(r._c&&(r._d=!1),Es(e,r()),r._c&&(r._d=!0));return}else{n=32;const r=t._;!r&&!wi(t)?t._ctx=ge:r===3&&ge&&(ge.slots._===1?t._=1:(t._=2,e.patchFlag|=1024))}else U(t)?(t={default:t,_ctx:ge},n=32):(t=String(t),s&64?(n=16,t=[Qt(t)]):n=8);e.children=t,e.shapeFlag|=n}function Ls(...e){const t={};for(let n=0;n<e.length;n++){const s=e[n];for(const r in s)if(r==="class")t.class!==s.class&&(t.class=Se([t.class,s.class]));else if(r==="style")t.style=Pn([t.style,s.style]);else if(Xt(r)){const i=t[r],o=s[r];o&&i!==o&&!(D(i)&&i.includes(o))&&(t[r]=i?[].concat(i,o):o)}else r!==""&&(t[r]=s[r])}return t}function Pe(e,t,n,s=null){Fe(e,t,7,[n,s])}const oa=bi();let la=0;function aa(e,t,n){const s=e.type,r=(t?t.appContext:e.appContext)||oa,i={uid:la++,vnode:e,type:s,parent:t,appContext:r,root:null,next:null,subTree:null,effect:null,update:null,scope:new Ao(!0),render:null,proxy:null,exposed:null,exposeProxy:null,withProxy:null,provides:t?t.provides:Object.create(r.provides),accessCache:null,renderCache:[],components:null,directives:null,propsOptions:ki(s,r),emitsOptions:fi(s,r),emit:null,emitted:null,propsDefaults:te,inheritAttrs:s.inheritAttrs,ctx:te,data:te,props:te,attrs:te,slots:te,refs:te,setupState:te,setupContext:null,attrsProxy:null,slotsProxy:null,suspense:n,suspenseId:n?n.pendingId:0,asyncDep:null,asyncResolved:!1,isMounted:!1,isUnmounted:!1,isDeactivated:!1,bc:null,c:null,bm:null,m:null,bu:null,u:null,um:null,bum:null,da:null,a:null,rtg:null,rtc:null,ec:null,sp:null};return i.ctx={_:i},i.root=t?t.root:i,i.emit=hl.bind(null,i),e.ce&&e.ce(i),i}let xe=null,kn,as;{const e=hs(),t=(n,s)=>{let r;return(r=e[n])||(r=e[n]=[]),r.push(s),i=>{r.length>1?r.forEach(o=>o(i)):r[0](i)}};kn=t("__VUE_INSTANCE_SETTERS__",n=>xe=n),as=t("__VUE_SSR_SETTERS__",n=>Fn=n)}const en=e=>{const t=xe;return kn(e),e.scope.on(),()=>{e.scope.off(),kn(t)}},hr=()=>{xe&&xe.scope.off(),kn(null)};function Fi(e){return e.vnode.shapeFlag&4}let Fn=!1;function ca(e,t=!1){t&&as(t);const{props:n,children:s}=e.vnode,r=Fi(e);Hl(e,n,r,t),Nl(e,s);const i=r?ua(e,t):void 0;return t&&as(!1),i}function ua(e,t){const n=e.type;e.accessCache=Object.create(null),e.proxy=new Proxy(e.ctx,$l);const{setup:s}=n;if(s){const r=e.setupContext=s.length>1?da(e):null,i=en(e);Xe();const o=Ge(s,e,0,[e.props,r]);if(Ze(),i(),Mr(o)){if(o.then(hr,hr),t)return o.then(l=>{pr(e,l,t)}).catch(l=>{On(l,e,0)});e.asyncDep=o}else pr(e,o,t)}else Ui(e,t)}function pr(e,t,n){U(t)?e.type.__ssrInlineRender?e.ssrRender=t:e.render=t:ne(t)&&(e.setupState=ii(t)),Ui(e,n)}let _r;function Ui(e,t,n){const s=e.type;if(!e.render){if(!t&&_r&&!s.render){const r=s.template||$s(e).template;if(r){const{isCustomElement:i,compilerOptions:o}=e.appContext.config,{delimiters:l,compilerOptions:a}=s,u=pe(pe({isCustomElement:i,delimiters:l},o),a);s.render=_r(r,u)}}e.render=s.render||Ee}{const r=en(e);Xe();try{Al(e)}finally{Ze(),r()}}}const fa={get(e,t){return Ae(e,"get",""),e[t]}};function da(e){const t=n=>{e.exposed=n||{}};return{attrs:new Proxy(e.attrs,fa),slots:e.slots,emit:e.emit,expose:t}}function Un(e){return e.exposed?e.exposeProxy||(e.exposeProxy=new Proxy(ii(hn(e.exposed)),{get(t,n){if(n in t)return t[n];if(n in Bt)return Bt[n](e)},has(t,n){return n in t||n in Bt}})):e.proxy}const ha=/(?:^|[-_])(\w)/g,pa=e=>e.replace(ha,t=>t.toUpperCase()).replace(/[-_]/g,"");function ji(e,t=!0){return U(e)?e.displayName||e.name:e.name||t&&e.__name}function Bi(e,t,n=!1){let s=ji(t);if(!s&&t.__file){const r=t.__file.match(/([^/\\]+)\.\w+$/);r&&(s=r[1])}if(!s&&e&&e.parent){const r=i=>{for(const o in i)if(i[o]===t)return o};s=r(e.components||e.parent.type.components)||r(e.appContext.components)}return s?pa(s):n?"App":"Anonymous"}function _a(e){return U(e)&&"__vccOpts"in e}const K=(e,t)=>Zo(e,t,Fn);function mt(e,t,n){const s=arguments.length;return s===2?ne(t)&&!D(t)?Cn(t)?j(e,null,[t]):j(e,t):j(e,null,t):(s>3?n=Array.prototype.slice.call(arguments,2):s===3&&Cn(n)&&(n=[n]),j(e,t,n))}const ga="3.4.31";/**
+* @vue/runtime-dom v3.4.31
+* (c) 2018-present Yuxi (Evan) You and Vue contributors
+* @license MIT
+**/const ma="http://www.w3.org/2000/svg",va="http://www.w3.org/1998/Math/MathML",ze=typeof document!="undefined"?document:null,gr=ze&&ze.createElement("template"),ba={insert:(e,t,n)=>{t.insertBefore(e,n||null)},remove:e=>{const t=e.parentNode;t&&t.removeChild(e)},createElement:(e,t,n,s)=>{const r=t==="svg"?ze.createElementNS(ma,e):t==="mathml"?ze.createElementNS(va,e):n?ze.createElement(e,{is:n}):ze.createElement(e);return e==="select"&&s&&s.multiple!=null&&r.setAttribute("multiple",s.multiple),r},createText:e=>ze.createTextNode(e),createComment:e=>ze.createComment(e),setText:(e,t)=>{e.nodeValue=t},setElementText:(e,t)=>{e.textContent=t},parentNode:e=>e.parentNode,nextSibling:e=>e.nextSibling,querySelector:e=>ze.querySelector(e),setScopeId(e,t){e.setAttribute(t,"")},insertStaticContent(e,t,n,s,r,i){const o=n?n.previousSibling:t.lastChild;if(r&&(r===i||r.nextSibling))for(;t.insertBefore(r.cloneNode(!0),n),!(r===i||!(r=r.nextSibling)););else{gr.innerHTML=s==="svg"?`<svg>${e}</svg>`:s==="mathml"?`<math>${e}</math>`:e;const l=gr.content;if(s==="svg"||s==="mathml"){const a=l.firstChild;for(;a.firstChild;)l.appendChild(a.firstChild);l.removeChild(a)}t.insertBefore(l,n)}return[o?o.nextSibling:t.firstChild,n?n.previousSibling:t.lastChild]}},ya=Symbol("_vtc");function xa(e,t,n){const s=e[ya];s&&(t=(t?[t,...s]:[...s]).join(" ")),t==null?e.removeAttribute("class"):n?e.setAttribute("class",t):e.className=t}const Sn=Symbol("_vod"),Vi=Symbol("_vsh"),wa={beforeMount(e,{value:t},{transition:n}){e[Sn]=e.style.display==="none"?"":e.style.display,n&&t?n.beforeEnter(e):Dt(e,t)},mounted(e,{value:t},{transition:n}){n&&t&&n.enter(e)},updated(e,{value:t,oldValue:n},{transition:s}){!t!=!n&&(s?t?(s.beforeEnter(e),Dt(e,!0),s.enter(e)):s.leave(e,()=>{Dt(e,!1)}):Dt(e,t))},beforeUnmount(e,{value:t}){Dt(e,t)}};function Dt(e,t){e.style.display=t?e[Sn]:"none",e[Vi]=!t}const Ca=Symbol(""),ka=/(^|;)\s*display\s*:/;function Sa(e,t,n){const s=e.style,r=le(n);let i=!1;if(n&&!r){if(t)if(le(t))for(const o of t.split(";")){const l=o.slice(0,o.indexOf(":")).trim();n[l]==null&&gn(s,l,"")}else for(const o in t)n[o]==null&&gn(s,o,"");for(const o in n)o==="display"&&(i=!0),gn(s,o,n[o])}else if(r){if(t!==n){const o=s[Ca];o&&(n+=";"+o),s.cssText=n,i=ka.test(n)}}else t&&e.removeAttribute("style");Sn in e&&(e[Sn]=i?s.display:"",e[Vi]&&(s.display="none"))}const mr=/\s*!important$/;function gn(e,t,n){if(D(n))n.forEach(s=>gn(e,t,s));else if(n==null&&(n=""),t.startsWith("--"))e.setProperty(t,n);else{const s=Ta(e,t);mr.test(n)?e.setProperty(vt(s),n.replace(mr,""),"important"):e[s]=n}}const vr=["Webkit","Moz","ms"],Jn={};function Ta(e,t){const n=Jn[t];if(n)return n;let s=Ke(t);if(s!=="filter"&&s in e)return Jn[t]=s;s=Ln(s);for(let r=0;r<vr.length;r++){const i=vr[r]+s;if(i in e)return Jn[t]=i}return t}const br="http://www.w3.org/1999/xlink";function yr(e,t,n,s,r,i=ko(t)){s&&t.startsWith("xlink:")?n==null?e.removeAttributeNS(br,t.slice(6,t.length)):e.setAttributeNS(br,t,n):n==null||i&&!ps(n)?e.removeAttribute(t):e.setAttribute(t,i?"":lt(n)?String(n):n)}function $a(e,t,n,s,r,i,o){if(t==="innerHTML"||t==="textContent"){s&&o(s,r,i),e[t]=n==null?"":n;return}const l=e.tagName;if(t==="value"&&l!=="PROGRESS"&&!l.includes("-")){const u=l==="OPTION"?e.getAttribute("value")||"":e.value,d=n==null?"":String(n);(u!==d||!("_value"in e))&&(e.value=d),n==null&&e.removeAttribute(t),e._value=n;return}let a=!1;if(n===""||n==null){const u=typeof e[t];u==="boolean"?n=ps(n):n==null&&u==="string"?(n="",a=!0):u==="number"&&(n=0,a=!0)}try{e[t]=n}catch{}a&&e.removeAttribute(t)}function Aa(e,t,n,s){e.addEventListener(t,n,s)}function Ia(e,t,n,s){e.removeEventListener(t,n,s)}const xr=Symbol("_vei");function Ea(e,t,n,s,r=null){const i=e[xr]||(e[xr]={}),o=i[t];if(s&&o)o.value=s;else{const[l,a]=La(t);if(s){const u=i[t]=Oa(s,r);Aa(e,l,u,a)}else o&&(Ia(e,l,o,a),i[t]=void 0)}}const wr=/(?:Once|Passive|Capture)$/;function La(e){let t;if(wr.test(e)){t={};let s;for(;s=e.match(wr);)e=e.slice(0,e.length-s[0].length),t[s[0].toLowerCase()]=!0}return[e[2]===":"?e.slice(3):vt(e.slice(2)),t]}let Xn=0;const Pa=Promise.resolve(),Ra=()=>Xn||(Pa.then(()=>Xn=0),Xn=Date.now());function Oa(e,t){const n=s=>{if(!s._vts)s._vts=Date.now();else if(s._vts<=n.attached)return;Fe(Ha(s,n.value),t,5,[s])};return n.value=e,n.attached=Ra(),n}function Ha(e,t){if(D(t)){const n=e.stopImmediatePropagation;return e.stopImmediatePropagation=()=>{n.call(e),e._stopped=!0},t.map(s=>r=>!r._stopped&&s&&s(r))}else return t}const Cr=e=>e.charCodeAt(0)===111&&e.charCodeAt(1)===110&&e.charCodeAt(2)>96&&e.charCodeAt(2)<123,Ma=(e,t,n,s,r,i,o,l,a)=>{const u=r==="svg";t==="class"?xa(e,s,u):t==="style"?Sa(e,n,s):Xt(t)?us(t)||Ea(e,t,n,s,o):(t[0]==="."?(t=t.slice(1),!0):t[0]==="^"?(t=t.slice(1),!1):Da(e,t,s,u))?($a(e,t,s,i,o,l,a),!e.tagName.includes("-")&&(t==="value"||t==="checked"||t==="selected")&&yr(e,t,s,u,o,t!=="value")):(t==="true-value"?e._trueValue=s:t==="false-value"&&(e._falseValue=s),yr(e,t,s,u))};function Da(e,t,n,s){if(s)return!!(t==="innerHTML"||t==="textContent"||t in e&&Cr(t)&&U(n));if(t==="spellcheck"||t==="draggable"||t==="translate"||t==="form"||t==="list"&&e.tagName==="INPUT"||t==="type"&&e.tagName==="TEXTAREA")return!1;if(t==="width"||t==="height"){const r=e.tagName;if(r==="IMG"||r==="VIDEO"||r==="CANVAS"||r==="SOURCE")return!1}return Cr(t)&&le(n)?!1:t in e}const Na=pe({patchProp:Ma},ba);let Zn,kr=!1;function Fa(){return Zn=kr?Zn:zl(Na),kr=!0,Zn}const Ua=(...e)=>{const t=Fa().createApp(...e),{mount:n}=t;return t.mount=s=>{const r=Ba(s);if(r)return n(r,!0,ja(r))},t};function ja(e){if(e instanceof SVGElement)return"svg";if(typeof MathMLElement=="function"&&e instanceof MathMLElement)return"mathml"}function Ba(e){return le(e)?document.querySelector(e):e}var Va='{"lang":"en-US","title":"Swagger-PHP","description":"Generate OpenAPI documentation for your RESTful API.","base":"/swagger-php/","head":[],"themeConfig":{"repo":"zircote/swagger-php","docsDir":"docs","docsBranch":"master","editLinks":false,"editLinkText":"Edit this page on GitHub","nav":[{"text":"User Guide","link":"/guide/"},{"text":"Reference","link":"/reference/"},{"text":"OpenApi","link":"https://learn.openapis.org/"},{"text":"Releases","link":"https://github.com/zircote/swagger-php/releases"}],"sidebar":{"/guide/":[{"text":"Introduction","children":[{"text":"What is Swagger-PHP?","link":"/guide/"},{"text":"Installation","link":"/guide/installation"},{"text":"Generating OpenAPI documents","link":"/guide/generating-openapi-documents"}]},{"text":"Annotating your code","children":[{"text":"Attributes","link":"/guide/attributes"},{"text":"Annotations","link":"/guide/annotations"},{"text":"Required elements","link":"/guide/required-elements"},{"text":"Common techniques","link":"/guide/common-techniques"}]},{"text":"Upgrading","children":[{"text":"Migration from 3.x to 4.x","link":"/guide/migrating-to-v4"},{"text":"Migration from 2.x to 3.x","link":"/guide/migrating-to-v3"}]},{"text":"Other","children":[{"text":"Cookbook","link":"/guide/cookbook"},{"text":"FAQ","link":"/guide/faq"},{"text":"Under the hood","link":"/guide/under-the-hood"},{"text":"Related Projects","link":"/related-projects"}]}],"/reference/":[{"text":"Reference","children":[{"text":"Attributes","link":"/reference/attributes"},{"text":"Annotations","link":"/reference/annotations"}]},{"text":"Api","children":[{"text":"Generator","link":"/reference/generator"},{"text":"Processors","link":"/reference/processors"}]}]}},"locales":{},"langs":{},"scrollOffset":90}';const Wi=/^https?:/i,Ne=typeof window!="undefined";function Wa(e,t){t.sort((n,s)=>{const r=s.split("/").length-n.split("/").length;return r!==0?r:s.length-n.length});for(const n of t)if(e.startsWith(n))return n}function Sr(e,t){const n=Wa(t,Object.keys(e));return n?e[n]:void 0}function Ka(e){const{locales:t}=e.themeConfig||{},n=e.locales;return t&&n?Object.keys(t).reduce((s,r)=>(s[r]={label:t[r].label,lang:n[r].lang},s),{}):{}}function qa(e,t){t=za(e,t);const n=Sr(e.locales||{},t),s=Sr(e.themeConfig.locales||{},t);return Object.assign({},e,n,{themeConfig:Object.assign({},e.themeConfig,s,{locales:{}}),lang:(n||e).lang,locales:{},langs:Ka(e)})}function za(e,t){if(!Ne)return t;const n=e.base,s=n.endsWith("/")?n.slice(0,-1):n;return t.slice(s.length)}const Ki=Symbol(),tn=Qo(Ya(Va));function Ya(e){return JSON.parse(e)}function Ga(e){const t=K(()=>qa(tn.value,e.path));return{site:t,theme:K(()=>t.value.themeConfig),page:K(()=>e.data),frontmatter:K(()=>e.data.frontmatter),lang:K(()=>t.value.lang),localePath:K(()=>{const{langs:n,lang:s}=t.value,r=Object.keys(n).find(i=>n[i].lang===s);return Lt(r||"/")}),title:K(()=>e.data.title?e.data.title+" | "+t.value.title:t.value.title),description:K(()=>e.data.description||t.value.description)}}function ve(){const e=_t(Ki);if(!e)throw new Error("vitepress data not properly injected in app");return e}function Ja(e,t){return`${e}${t}`.replace(/\/+/g,"/")}function Lt(e){return Wi.test(e)?e:Ja(tn.value.base,e)}function qi(e){let t=e.replace(/\.html$/,"");if(t=decodeURIComponent(t),t.endsWith("/")&&(t+="index"),Ne){const n="/swagger-php/";t=t.slice(n.length).replace(/\//g,"_")+".md";const s=__VP_HASH_MAP__[t.toLowerCase()];t=`${n}assets/${t}.${s}.js`}else t=`./${t.slice(1).replace(/\//g,"_")}.md.js`;return t}const zi=Symbol(),Tr="http://a.com",Yi={relativePath:"",title:"404",description:"Not Found",headers:[],frontmatter:{},lastUpdated:0},Xa=()=>({path:"/",component:null,data:Yi});function Za(e,t){const n=Rt(Xa());function s(o=Ne?location.href:"/"){const l=new URL(o,Tr);return!l.pathname.endsWith("/")&&!l.pathname.endsWith(".html")&&(l.pathname+=".html",o=l.pathname+l.search+l.hash),Ne&&(history.replaceState({scrollPosition:window.scrollY},document.title),history.pushState(null,"",o)),i(o)}let r=null;async function i(o,l=0,a=!1){const u=new URL(o,Tr),d=r=u.pathname;try{let _=e(d);if("then"in _&&typeof _.then=="function"&&(_=await _),r===d){r=null;const{default:b,__pageData:T}=_;if(!b)throw new Error(`Invalid route component: ${b}`);n.path=d,n.component=hn(b),n.data=hn(JSON.parse(T)),Ne&&ai(()=>{if(u.hash&&!l){let F=null;try{F=document.querySelector(decodeURIComponent(u.hash))}catch(V){console.warn(V)}if(F){$r(F,u.hash);return}}window.scrollTo(0,l)})}}catch(_){if(_.message.match(/fetch/)||console.error(_),!a)try{const b=await fetch(tn.value.base+"hashmap.json");window.__VP_HASH_MAP__=await b.json(),await i(o,l,!0);return}catch{}r===d&&(r=null,n.path=d,n.component=t?hn(t):null,n.data=Yi)}}return Ne&&(window.addEventListener("click",o=>{const l=o.target.closest("a");if(l){const{href:a,protocol:u,hostname:d,pathname:_,hash:b,target:T}=l,F=window.location,V=_.match(/\.\w+$/);!o.ctrlKey&&!o.shiftKey&&!o.altKey&&!o.metaKey&&T!=="_blank"&&u===F.protocol&&d===F.hostname&&!(V&&V[0]!==".html")&&(o.preventDefault(),_===F.pathname?b&&b!==F.hash&&(history.pushState(null,"",b),window.dispatchEvent(new Event("hashchange")),$r(l,b,l.classList.contains("header-anchor"))):s(a))}},{capture:!0}),window.addEventListener("popstate",o=>{i(location.href,o.state&&o.state.scrollPosition||0)}),window.addEventListener("hashchange",o=>{o.preventDefault()})),{route:n,go:s}}function Qa(){const e=_t(zi);if(!e)throw new Error("useRouter() is called without provider.");return e}function at(){return Qa().route}function $r(e,t,n=!1){let s=null;try{s=e.classList.contains("header-anchor")?e:document.querySelector(decodeURIComponent(t))}catch(r){console.warn(r)}if(s){let r=tn.value.scrollOffset;typeof r=="string"&&(r=document.querySelector(r).getBoundingClientRect().bottom+24);const i=parseInt(window.getComputedStyle(s).paddingTop,10),o=window.scrollY+s.getBoundingClientRect().top-r+i;!n||Math.abs(o-window.scrollY)>window.innerHeight?window.scrollTo(0,o):window.scrollTo({left:0,top:o,behavior:"smooth"})}}function ec(e,t){let n=[],s=!0;const r=i=>{if(s){s=!1;return}const o=[],l=Math.min(n.length,i.length);for(let a=0;a<l;a++){let u=n[a];const[d,_,b=""]=i[a];if(u.tagName.toLocaleLowerCase()===d){for(const T in _)u.getAttribute(T)!==_[T]&&u.setAttribute(T,_[T]);for(let T=0;T<u.attributes.length;T++){const F=u.attributes[T].name;F in _||u.removeAttribute(F)}u.innerHTML!==b&&(u.innerHTML=b)}else document.head.removeChild(u),u=Ar(i[a]),document.head.append(u);o.push(u)}n.slice(l).forEach(a=>document.head.removeChild(a)),i.slice(l).forEach(a=>{const u=Ar(a);document.head.appendChild(u),o.push(u)}),n=o};Pi(()=>{const i=e.data,o=t.value,l=i&&i.title,a=i&&i.description,u=i&&i.frontmatter.head;document.title=(l?l+" | ":"")+o.title,document.querySelector("meta[name=description]").setAttribute("content",a||o.description),r([...u?nc(u):[]])})}function Ar([e,t,n]){const s=document.createElement(e);for(const r in t)s.setAttribute(r,t[r]);return n&&(s.innerHTML=n),s}function tc(e){return e[0]==="meta"&&e[1]&&e[1].name==="description"}function nc(e){return e.filter(t=>!tc(t))}const sc=se({name:"VitePressContent",setup(){const e=at();return()=>mt("div",{style:{position:"relative"}},[e.component?mt(e.component):null])}});var fe=(e,t)=>{const n=e.__vccOpts||e;for(const[s,r]of t)n[s]=r;return n};const rc=e=>(Ss("data-v-765646fb"),e=e(),Ts(),e),ic=rc(()=>M("p",{class:"title"},"Debug",-1)),oc={class:"block"};se({__name:"Debug",setup(e){const t=ve(),n=gt(null),s=gt(!1),r=Rt(t);return We(s,i=>{i||(n.value.scrollTop=0)}),(i,o)=>(A(),H("div",{class:Se(["debug",{open:s.value}]),ref_key:"el",ref:n,onClick:o[0]||(o[0]=l=>s.value=!s.value)},[ic,M("pre",oc,me(r),1)],2))}});const lc=/#.*$/,ac=/(index)?\.(md|html)$/,Tn=/\/$/,cc=/^[a-z]+:/i;function Ps(e){return Array.isArray(e)}function Rs(e){return cc.test(e)}function uc(e,t){if(t===void 0)return!1;const n=Ir(`/${e.data.relativePath}`),s=Ir(t);return n===s}function Ir(e){return decodeURI(e).replace(lc,"").replace(ac,"")}function fc(e,t){const n=e.endsWith("/"),s=t.startsWith("/");return n&&s?e.slice(0,-1)+t:!n&&!s?`${e}/${t}`:e+t}function cs(e){return/^\//.test(e)?e:`/${e}`}function Gi(e){return e.replace(/(index)?(\.(md|html))?$/,"")||"/"}function dc(e){return e===!1||e==="auto"||Ps(e)}function hc(e){return e.children!==void 0}function pc(e){return Ps(e)?e.length===0:!e}function Os(e,t){if(dc(e))return e;t=cs(t);for(const n in e)if(t.startsWith(cs(n)))return e[n];return"auto"}function Ji(e){return e.reduce((t,n)=>(n.link&&t.push({text:n.text,link:Gi(n.link)}),hc(n)&&(t=[...t,...Ji(n.children)]),t),[])}function Xi(e){const t=at(),n=Rs(e.value.link);return{props:K(()=>{const r=Er(`/${t.data.relativePath}`);let i=!1;if(e.value.activeMatch)i=new RegExp(e.value.activeMatch).test(r);else{const o=Er(e.value.link);i=o==="/"?o===r:r.startsWith(o)}return{class:{active:i,isExternal:n},href:n?e.value.link:Lt(e.value.link),target:e.value.target||(n?"_blank":null),rel:e.value.rel||(n?"noopener noreferrer":null),"aria-label":e.value.ariaLabel}}),isExternal:n}}function Er(e){return e.replace(/#.*$/,"").replace(/\?.*$/,"").replace(/\.(html|md)$/,"").replace(/\/index$/,"/")}const _c={},gc={class:"icon outbound",xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",x:"0px",y:"0px",viewBox:"0 0 100 100",width:"15",height:"15"},mc=M("path",{fill:"currentColor",d:"M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"},null,-1),vc=M("polygon",{fill:"currentColor",points:"45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"},null,-1),bc=[mc,vc];function yc(e,t){return A(),H("svg",gc,bc)}var Hs=fe(_c,[["render",yc]]);const xc={class:"nav-link"},wc=se({__name:"NavLink",props:{item:{}},setup(e){const n=ws(e),{props:s,isExternal:r}=Xi(n.item);return(i,o)=>(A(),H("div",xc,[M("a",Ls({class:"item"},$(s)),[Qt(me(i.item.text)+" ",1),$(r)?(A(),be(Hs,{key:0})):Z("",!0)],16)]))}});var $n=fe(wc,[["__scopeId","data-v-49fe041d"]]);const Cc={key:0,class:"home-hero"},kc={key:0,class:"figure"},Sc=["src","alt"],Tc={key:1,id:"main-title",class:"title"},$c={key:2,class:"tagline"},Ac=se({__name:"HomeHero",setup(e){const{site:t,frontmatter:n}=ve(),s=K(()=>{const{heroImage:o,heroText:l,tagline:a,actionLink:u,actionText:d}=n.value;return o||l||a||u&&d}),r=K(()=>n.value.heroText||t.value.title),i=K(()=>n.value.tagline||t.value.description);return(o,l)=>s.value?(A(),H("header",Cc,[$(n).heroImage?(A(),H("figure",kc,[M("img",{class:"image",src:$(Lt)($(n).heroImage),alt:$(n).heroAlt},null,8,Sc)])):Z("",!0),r.value?(A(),H("h1",Tc,me(r.value),1)):Z("",!0),i.value?(A(),H("p",$c,me(i.value),1)):Z("",!0),$(n).actionLink&&$(n).actionText?(A(),be($n,{key:3,item:{link:$(n).actionLink,text:$(n).actionText},class:"action"},null,8,["item"])):Z("",!0),$(n).altActionLink&&$(n).altActionText?(A(),be($n,{key:4,item:{link:$(n).altActionLink,text:$(n).altActionText},class:"action alt"},null,8,["item"])):Z("",!0)])):Z("",!0)}});var Ic=fe(Ac,[["__scopeId","data-v-5d8b683d"]]);const Ec={key:0,class:"home-features"},Lc={class:"wrapper"},Pc={class:"container"},Rc={class:"features"},Oc={key:0,class:"title"},Hc={key:1,class:"details"},Mc=se({__name:"HomeFeatures",setup(e){const{frontmatter:t}=ve(),n=K(()=>t.value.features&&t.value.features.length>0),s=K(()=>t.value.features?t.value.features:[]);return(r,i)=>n.value?(A(),H("div",Ec,[M("div",Lc,[M("div",Pc,[M("div",Rc,[(A(!0),H(de,null,Zt(s.value,(o,l)=>(A(),H("section",{key:l,class:"feature"},[o.title?(A(),H("h2",Oc,me(o.title),1)):Z("",!0),o.details?(A(),H("p",Hc,me(o.details),1)):Z("",!0)]))),128))])])])])):Z("",!0)}});var Dc=fe(Mc,[["__scopeId","data-v-245bde66"]]);const Nc={key:0,class:"footer"},Fc={class:"container"},Uc={class:"text"},jc=se({__name:"HomeFooter",setup(e){const{frontmatter:t}=ve();return(n,s)=>$(t).footer?(A(),H("footer",Nc,[M("div",Fc,[M("p",Uc,me($(t).footer),1)])])):Z("",!0)}});var Bc=fe(jc,[["__scopeId","data-v-bff49316"]]);const Vc={class:"home","aria-labelledby":"main-title"},Wc={class:"home-content"},Kc=se({__name:"Home",setup(e){return(t,n)=>{const s=At("Content");return A(),H("main",Vc,[j(Ic),oe(t.$slots,"hero",{},void 0,!0),j(Dc),M("div",Wc,[j(s)]),oe(t.$slots,"features",{},void 0,!0),j(Bc),oe(t.$slots,"footer",{},void 0,!0)])}}});var qc=fe(Kc,[["__scopeId","data-v-8382b818"]]);const zc=["href","aria-label"],Yc=["src"],Gc=se({__name:"NavBarTitle",setup(e){const{site:t,theme:n,localePath:s}=ve();return(r,i)=>(A(),H("a",{class:"nav-bar-title",href:$(s),"aria-label":`${$(t).title}, back to home`},[$(n).logo?(A(),H("img",{key:0,class:"logo",src:$(Lt)($(n).logo),alt:"Logo"},null,8,Yc)):Z("",!0),Qt(" "+me($(t).title),1)],8,zc))}});var Jc=fe(Gc,[["__scopeId","data-v-016a8bd8"]]);function Xc(){const{site:e,localePath:t,theme:n}=ve();return K(()=>{const s=e.value.langs,r=Object.keys(s);if(r.length<2)return null;const o=at().path.replace(t.value,""),l=r.map(u=>({text:s[u].label,link:`${u}${o}`}));return{text:n.value.selectText||"Languages",items:l}})}const Zc=["GitHub","GitLab","Bitbucket"].map(e=>[e,new RegExp(e,"i")]);function Qc(){const{site:e}=ve();return K(()=>{const t=e.value.themeConfig,n=t.docsRepo||t.repo;if(!n)return null;const s=eu(n);return{text:tu(s,t.repoLabel),link:s}})}function eu(e){return Wi.test(e)?e:`https://github.com/${e}`}function tu(e,t){if(t)return t;const n=e.match(/^https?:\/\/[^/]+/);if(!n)return"Source";const s=Zc.find(([r,i])=>i.test(n[0]));return s&&s[0]?s[0]:"Source"}const nu=e=>(Ss("data-v-07381bdb"),e=e(),Ts(),e),su={class:"nav-dropdown-link-item"},ru=nu(()=>M("span",{class:"arrow"},null,-1)),iu={class:"text"},ou={class:"icon"},lu=se({__name:"NavDropdownLinkItem",props:{item:{}},setup(e){const n=ws(e),{props:s,isExternal:r}=Xi(n.item);return(i,o)=>(A(),H("div",su,[M("a",Ls({class:"item"},$(s)),[ru,M("span",iu,me(i.item.text),1),M("span",ou,[$(r)?(A(),be(Hs,{key:0})):Z("",!0)])],16)]))}});var au=fe(lu,[["__scopeId","data-v-07381bdb"]]);const cu=["aria-label"],uu={class:"button-text"},fu={class:"dialog"},du=se({__name:"NavDropdownLink",props:{item:{}},setup(e){const t=at(),n=gt(!1);We(()=>t.path,()=>{n.value=!1});function s(){n.value=!n.value}return(r,i)=>(A(),H("div",{class:Se(["nav-dropdown-link",{open:n.value}])},[M("button",{class:"button","aria-label":r.item.ariaLabel,onClick:s},[M("span",uu,me(r.item.text),1),M("span",{class:Se(["button-arrow",n.value?"down":"right"])},null,2)],8,cu),M("ul",fu,[(A(!0),H(de,null,Zt(r.item.items,o=>(A(),H("li",{key:o.text,class:"dialog-item"},[j(au,{item:o},null,8,["item"])]))),128))])],2))}});var Lr=fe(du,[["__scopeId","data-v-18d75f62"]]);const hu={key:0,class:"nav-links"},pu={key:1,class:"item"},_u={key:2,class:"item"},gu=se({__name:"NavLinks",setup(e){const{theme:t}=ve(),n=Xc(),s=Qc(),r=K(()=>t.value.nav||s.value||n.value);return(i,o)=>r.value?(A(),H("nav",hu,[$(t).nav?(A(!0),H(de,{key:0},Zt($(t).nav,l=>(A(),H("div",{key:l.text,class:"item"},[l.items?(A(),be(Lr,{key:0,item:l},null,8,["item"])):(A(),be($n,{key:1,item:l},null,8,["item"]))]))),128)):Z("",!0),$(n)?(A(),H("div",pu,[j(Lr,{item:$(n)},null,8,["item"])])):Z("",!0),$(s)?(A(),H("div",_u,[j($n,{item:$(s)},null,8,["item"])])):Z("",!0)])):Z("",!0)}});var Zi=fe(gu,[["__scopeId","data-v-35b91e7e"]]);const mu={emits:["toggle"]},vu=M("svg",{class:"icon",xmlns:"http://www.w3.org/2000/svg","aria-hidden":"true",role:"img",viewBox:"0 0 448 512"},[M("path",{fill:"currentColor",d:"M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z",class:""})],-1),bu=[vu];function yu(e,t,n,s,r,i){return A(),H("div",{class:"sidebar-button",onClick:t[0]||(t[0]=o=>e.$emit("toggle"))},bu)}var xu=fe(mu,[["render",yu]]);const wu=e=>(Ss("data-v-40587210"),e=e(),Ts(),e),Cu={class:"nav-bar"},ku=wu(()=>M("div",{class:"flex-grow"},null,-1)),Su={class:"nav"},Tu=se({__name:"NavBar",emits:["toggle"],setup(e){return(t,n)=>(A(),H("header",Cu,[j(xu,{onToggle:n[0]||(n[0]=s=>t.$emit("toggle"))}),j(Jc),ku,M("div",Su,[j(Zi)]),oe(t.$slots,"search",{},void 0,!0)]))}});var $u=fe(Tu,[["__scopeId","data-v-40587210"]]);function Au(){let e=null,t=null;const n=Ru(s,300);function s(){const o=Iu(),l=Eu(o);for(let a=0;a<l.length;a++){const u=l[a],d=l[a+1],[_,b]=Pu(a,u,d);if(_){history.replaceState(null,document.title,b||" "),r(b);return}}}function r(o){if(i(t),i(e),t=document.querySelector(`.sidebar a[href="${o}"]`),!t)return;t.classList.add("active");const l=t.closest(".sidebar-links > ul > li");l&&l!==t.parentElement?(e=l.querySelector("a"),e&&e.classList.add("active")):e=null}function i(o){o&&o.classList.remove("active")}bt(()=>{s(),window.addEventListener("scroll",n)}),_i(()=>{r(decodeURIComponent(location.hash))}),Nn(()=>{window.removeEventListener("scroll",n)})}function Iu(){return[].slice.call(document.querySelectorAll(".sidebar a.sidebar-link-item"))}function Eu(e){return[].slice.call(document.querySelectorAll(".header-anchor")).filter(t=>e.some(n=>n.hash===t.hash))}function Lu(){return document.querySelector(".nav-bar").offsetHeight}function Pr(e){const t=Lu();return e.parentElement.offsetTop-t-15}function Pu(e,t,n){const s=window.scrollY;return e===0&&s===0?[!0,null]:s<Pr(t)?[!1,null]:!n||s<Pr(n)?[!0,decodeURIComponent(t.hash)]:[!1,null]}function Ru(e,t){let n,s=!1;return()=>{n&&clearTimeout(n),s?n=setTimeout(e,t):(e(),s=!0,setTimeout(()=>{s=!1},t))}}function Ou(){const e=at(),{site:t}=ve();return Au(),K(()=>{const n=e.data.headers,s=e.data.frontmatter.sidebar,r=e.data.frontmatter.sidebarDepth;if(s===!1)return[];if(s==="auto")return Rr(n,r);const i=Os(t.value.themeConfig.sidebar,e.data.relativePath);return i===!1?[]:i==="auto"?Rr(n,r):i})}function Rr(e,t){const n=[];if(e===void 0)return[];let s;return e.forEach(({level:r,title:i,slug:o})=>{if(r-1>t)return;const l={text:i,link:`#${o}`};r===2?(s=l,n.push(l)):s&&(s.children||(s.children=[])).push(l)}),n}const Qi=e=>{const t=at(),{site:n,frontmatter:s}=ve(),r=e.depth||1,i=s.value.sidebarDepth||1/0,o=t.data.headers,l=e.item.text,a=Hu(n.value.base,e.item.link),u=e.item.children,d=uc(t,e.item.link),_=r<i?eo(d,u,o,r+1):null;return mt("li",{class:"sidebar-link"},[mt(a?"a":"p",{class:{"sidebar-link-item":!0,active:d},href:a},l),_])};function Hu(e,t){return t===void 0||t.startsWith("#")?t:fc(e,t)}function eo(e,t,n,s=1){return t&&t.length>0?mt("ul",{class:"sidebar-links"},t.map(r=>mt(Qi,{item:r,depth:s}))):e&&n?eo(!1,Mu(n),void 0,s):null}function Mu(e){return to(Du(e))}function Du(e){e=e.map(n=>Object.assign({},n));let t;return e.forEach(n=>{n.level===2?t=n:t&&(t.children||(t.children=[])).push(n)}),e.filter(n=>n.level===2)}function to(e){return e.map(t=>({text:t.title,link:`#${t.slug}`,children:t.children?to(t.children):void 0}))}const Nu={key:0,class:"sidebar-links"},Fu=se({__name:"SideBarLinks",setup(e){const t=Ou();return(n,s)=>$(t).length>0?(A(),H("ul",Nu,[(A(!0),H(de,null,Zt($(t),r=>(A(),be($(Qi),{item:r},null,8,["item"]))),256))])):Z("",!0)}});const Uu=se({__name:"SideBar",props:{open:{type:Boolean}},setup(e){return(t,n)=>(A(),H("aside",{class:Se(["sidebar",{open:t.open}])},[j(Zi,{class:"nav"}),oe(t.$slots,"sidebar-top",{},void 0,!0),j(Fu),oe(t.$slots,"sidebar-bottom",{},void 0,!0)],2))}});var ju=fe(Uu,[["__scopeId","data-v-17c48e2f"]]);const Bu=/bitbucket.org/;function Vu(){const{page:e,theme:t,frontmatter:n}=ve(),s=K(()=>{const{repo:i,docsDir:o="",docsBranch:l="master",docsRepo:a=i,editLinks:u}=t.value,d=n.value.editLink!=null?n.value.editLink:u,{relativePath:_}=e.value;return!d||!_||!i?null:Wu(i,a,o,l,_)}),r=K(()=>t.value.editLinkText||"Edit this page");return{url:s,text:r}}function Wu(e,t,n,s,r){return Bu.test(e)?qu(e,t,n,s,r):Ku(e,t,n,s,r)}function Ku(e,t,n,s,r){return(Rs(t)?t:`https://github.com/${t}`).replace(Tn,"")+`/edit/${s}/`+(n?n.replace(Tn,"")+"/":"")+r}function qu(e,t,n,s,r){return(Rs(t)?t:e).replace(Tn,"")+`/src/${s}/`+(n?n.replace(Tn,"")+"/":"")+r+`?mode=edit&spa=0&at=${s}&fileviewer=file-view-default`}const zu={class:"edit-link"},Yu=["href"],Gu=se({__name:"EditLink",setup(e){const{url:t,text:n}=Vu();return(s,r)=>(A(),H("div",zu,[$(t)?(A(),H("a",{key:0,class:"link",href:$(t),target:"_blank",rel:"noopener noreferrer"},[Qt(me($(n))+" ",1),j(Hs,{class:"icon"})],8,Yu)):Z("",!0)]))}});var Ju=fe(Gu,[["__scopeId","data-v-55695e90"]]);const Xu={key:0,class:"last-updated"},Zu={class:"prefix"},Qu={class:"datetime"},ef=se({__name:"LastUpdated",setup(e){const{theme:t,page:n}=ve(),s=K(()=>{const o=t.value.lastUpdated;return o!==void 0&&o!==!1&&n.value.lastUpdated!==0}),r=K(()=>{const o=t.value.lastUpdated;return o===!0?"Last Updated":o}),i=gt("");return bt(()=>{Pi(()=>{i.value=new Date(n.value.lastUpdated).toLocaleString("en-US")})}),(o,l)=>s.value?(A(),H("p",Xu,[M("span",Zu,me(r.value)+":",1),M("span",Qu,me(i.value),1)])):Z("",!0)}});var tf=fe(ef,[["__scopeId","data-v-7e06cdca"]]);const nf={class:"page-footer"},sf={class:"edit"},rf={class:"updated"},of=se({__name:"PageFooter",setup(e){const{page:t}=ve();return(n,s)=>(A(),H("footer",nf,[M("div",sf,[j(Ju)]),M("div",rf,[$(t).lastUpdated?(A(),be(tf,{key:0})):Z("",!0)])]))}});var lf=fe(of,[["__scopeId","data-v-b65b4b36"]]);function af(){const{page:e,theme:t}=ve(),n=K(()=>Gi(cs(e.value.relativePath))),s=K(()=>{const a=Os(t.value.sidebar,n.value);return Ps(a)?Ji(a):[]}),r=K(()=>s.value.findIndex(a=>a.link===n.value)),i=K(()=>{if(t.value.nextLinks!==!1&&r.value>-1&&r.value<s.value.length-1)return s.value[r.value+1]}),o=K(()=>{if(t.value.prevLinks!==!1&&r.value>0)return s.value[r.value-1]}),l=K(()=>!!i.value||!!o.value);return{next:i,prev:o,hasLinks:l}}const cf={},uf={xmlns:"http://www.w3.org/2000/svg",viewBox:"0 0 24 24"},ff=M("path",{d:"M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"},null,-1),df=[ff];function hf(e,t){return A(),H("svg",uf,df)}var pf=fe(cf,[["render",hf]]);const _f={},gf={xmlns:"http://www.w3.org/2000/svg",viewBox:"0 0 24 24"},mf=M("path",{d:"M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"},null,-1),vf=[mf];function bf(e,t){return A(),H("svg",gf,vf)}var yf=fe(_f,[["render",bf]]);const xf={key:0,class:"next-and-prev-link"},wf={class:"container"},Cf={class:"prev"},kf=["href"],Sf={class:"text"},Tf={class:"next"},$f=["href"],Af={class:"text"},If=se({__name:"NextAndPrevLinks",setup(e){const{hasLinks:t,prev:n,next:s}=af();return(r,i)=>$(t)?(A(),H("div",xf,[M("div",wf,[M("div",Cf,[$(n)?(A(),H("a",{key:0,class:"link",href:$(Lt)($(n).link)},[j(pf,{class:"icon icon-prev"}),M("span",Sf,me($(n).text),1)],8,kf)):Z("",!0)]),M("div",Tf,[$(s)?(A(),H("a",{key:0,class:"link",href:$(Lt)($(s).link)},[M("span",Af,me($(s).text),1),j(yf,{class:"icon icon-next"})],8,$f)):Z("",!0)])])])):Z("",!0)}});var Ef=fe(If,[["__scopeId","data-v-e65a9748"]]);const Lf={class:"page"},Pf={class:"container"},Rf=se({__name:"Page",setup(e){return(t,n)=>{const s=At("Content");return A(),H("main",Lf,[M("div",Pf,[oe(t.$slots,"top",{},void 0,!0),j(s,{class:"content"}),j(lf),j(Ef),oe(t.$slots,"bottom",{},void 0,!0)])])}}});var Of=fe(Rf,[["__scopeId","data-v-8fcebc32"]]);const Hf={key:0,id:"ads-container"},Mf=se({__name:"Layout",setup(e){const t=()=>null,n=t,s=t,r=t,i=at(),{site:o,page:l,theme:a,frontmatter:u}=ve(),d=K(()=>!!u.value.customLayout),_=K(()=>!!u.value.home),b=K(()=>Object.keys(o.value.langs).length>1),T=K(()=>{const h=a.value;return u.value.navbar===!1||h.navbar===!1?!1:o.value.title||h.logo||h.repo||h.nav}),F=gt(!1),V=K(()=>u.value.home||u.value.sidebar===!1?!1:!pc(Os(a.value.sidebar,i.data.relativePath))),ue=h=>{F.value=typeof h=="boolean"?h:!F.value},re=ue.bind(null,!1);We(i,re);const ae=K(()=>[{"no-navbar":!T.value,"sidebar-open":F.value,"no-sidebar":!V.value}]);return(h,y)=>{const R=At("Content"),I=At("Debug");return A(),H(de,null,[M("div",{class:Se(["theme",ae.value])},[T.value?(A(),be($u,{key:0,onToggle:ue},{search:Re(()=>[oe(h.$slots,"navbar-search",{},()=>[$(a).algolia?(A(),be($(r),{key:0,options:$(a).algolia,multilang:b.value},null,8,["options","multilang"])):Z("",!0)])]),_:3})):Z("",!0),j(ju,{open:F.value},{"sidebar-top":Re(()=>[oe(h.$slots,"sidebar-top")]),"sidebar-bottom":Re(()=>[oe(h.$slots,"sidebar-bottom")]),_:3},8,["open"]),M("div",{class:"sidebar-mask",onClick:y[0]||(y[0]=q=>ue(!1))}),d.value?(A(),be(R,{key:1})):_.value?oe(h.$slots,"home",{key:2},()=>[j(qc,null,{hero:Re(()=>[oe(h.$slots,"home-hero")]),features:Re(()=>[oe(h.$slots,"home-features")]),footer:Re(()=>[oe(h.$slots,"home-footer")]),_:3})]):(A(),be(Of,{key:3},{top:Re(()=>[oe(h.$slots,"page-top-ads",{},()=>[$(a).carbonAds&&$(a).carbonAds.carbon?(A(),H("div",Hf,[(A(),be($(n),{key:"carbon"+$(l).relativePath,code:$(a).carbonAds.carbon,placement:$(a).carbonAds.placement},null,8,["code","placement"]))])):Z("",!0)]),oe(h.$slots,"page-top")]),bottom:Re(()=>[oe(h.$slots,"page-bottom"),oe(h.$slots,"page-bottom-ads",{},()=>[$(a).carbonAds&&$(a).carbonAds.custom?(A(),be($(s),{key:"custom"+$(l).relativePath,code:$(a).carbonAds.custom,placement:$(a).carbonAds.placement},null,8,["code","placement"])):Z("",!0)])]),_:3}))],2),j(I)],64)}}}),Df={class:"theme"},Nf=M("h1",null,"404",-1),Ff=["href"],Uf=se({__name:"NotFound",setup(e){const{site:t}=ve(),n=["There's nothing here.","How did we get here?","That's a Four-Oh-Four.","Looks like we've got some broken links."];function s(){return n[Math.floor(Math.random()*n.length)]}return(r,i)=>(A(),H("div",Df,[Nf,M("blockquote",null,me(s()),1),M("a",{href:$(t).base,"aria-label":"go to home"},"Take me home.",8,Ff)]))}}),jf={Layout:Mf,NotFound:Uf},no=Symbol("addTab"),so=Symbol("updateTab"),ro=Symbol("deleteTab"),io=Symbol("tabsProvider");function fn(e,t){const n=_t(e,t);if(typeof n>"u")throw new Error(`Could not resolve ${e.description}`);return n}const Bf=["data-tab-id","aria-hidden"],Vf=se({__name:"Tab",props:{panelClass:{default:"tabs-component-panel"},id:{default:void 0},name:null,prefix:{default:""},suffix:{default:""},isDisabled:{type:Boolean,default:!1},navItemClass:{default:void 0},navItemLinkClass:{default:void 0}},setup(e,{expose:t}){const n=e,s=gt(!1),r=fn(io),i=fn(no),o=fn(so),l=fn(ro),a=n.prefix+n.name+n.suffix,u=n.id?n.id:n.name.toLowerCase().replace(/ /g,"-"),d=u+"-pane",_=K(()=>"#"+(n.isDisabled?"":u));return We(()=>r.activeTabHash,()=>{s.value=_.value===r.activeTabHash}),We(()=>Object.assign({},n),()=>{o(u,{name:n.name,header:n.prefix+n.name+n.suffix,isDisabled:n.isDisabled,hash:_.value,index:r.tabs.length,computedId:u,paneId:d,navItemClass:n.navItemClass,navItemLinkClass:n.navItemLinkClass})}),pi(()=>{i({name:n.name,header:a,isDisabled:n.isDisabled,hash:_.value,index:r.tabs.length,computedId:u,paneId:d,navItemClass:n.navItemClass,navItemLinkClass:n.navItemLinkClass})}),gi(()=>{l(u)}),t({header:a,computedId:u,paneId:d,hash:_,isActive:s}),(b,T)=>Tl((A(),H("section",{ref:"tab",id:d,"data-tab-id":$(u),"aria-hidden":!s.value,class:Se(e.panelClass),role:"tabpanel",tabindex:"-1"},[oe(b.$slots,"default")],10,Bf)),[[wa,s.value]])}});class Wf{get(t){const n=localStorage.getItem(t);if(n===null)return null;const s=JSON.parse(n);return s?new Date(s.expires)<new Date?(localStorage.removeItem(t),null):s.value:null}set(t,n,s){const r=new Date().getTime(),i=new Date(r+s*6e4);localStorage.setItem(t,JSON.stringify({value:n,expires:i}))}}const Or=new Wf,Kf=["id"],qf=["aria-controls","aria-selected","href","onClick","innerHTML"],zf=se({__name:"Tabs",props:{id:{default:void 0},cacheLifetime:{default:5},options:{default:()=>({useUrlFragment:!0,defaultTabHash:void 0,storageKey:void 0})},wrapperClass:{default:"tabs-component"},panelsWrapperClass:{default:"tabs-component-panels"},navClass:{default:"tabs-component-tabs"},navItemClass:{default:"tabs-component-tab"},navItemDisabledClass:{default:"is-disabled"},navItemActiveClass:{default:"is-active"},navItemInactiveClass:{default:"is-inactive"},navItemLinkClass:{default:"tabs-component-tab-a"},navItemLinkActiveClass:{default:"is-active"},navItemLinkInactiveClass:{default:"is-inactive"},navItemLinkDisabledClass:{default:"is-disabled"}},emits:["changed","clicked"],setup(e,{expose:t,emit:n}){const s=e,r=Rt({activeTabHash:"",lastActiveTabHash:"",tabs:[]});Ft(io,r),Ft(no,a=>{r.tabs.push(a)}),Ft(so,(a,u)=>{const d=r.tabs.findIndex(_=>_.computedId===a);u.isActive=r.tabs[d].isActive,r.tabs[d]=u}),Ft(ro,a=>{const u=r.tabs.findIndex(d=>d.computedId===a);r.tabs.splice(u,1)});const i=K(()=>{let a;return s.options.storageKey&&(a=s.options.storageKey),!a&&s.id&&(a=`vue-tabs-component.${s.id}.cache.${window.location.host}${window.location.pathname}`),a||(a=`vue-tabs-component.cache.${window.location.host}${window.location.pathname}`),a}),o=(a,u)=>{u&&!s.options.useUrlFragment&&u.preventDefault();const d=l(a);if(d){if(u&&d.isDisabled){u.preventDefault();return}if(r.lastActiveTabHash===d.hash){n("clicked",{tab:d});return}r.tabs.forEach(_=>{_.isActive=_.hash===d.hash}),n("changed",{tab:d}),r.lastActiveTabHash=r.activeTabHash=d.hash,!(s.cacheLifetime<=0)&&Or.set(i.value,d.hash,s.cacheLifetime)}},l=a=>r.tabs.find(u=>u.hash===a);return bt(()=>{if(r.tabs.length){if(window.addEventListener("hashchange",()=>o(window.location.hash)),l(window.location.hash)){o(window.location.hash);return}if(s.cacheLifetime>0){const a=Or.get(i.value);if(a!==null&&l(a)){o(a);return}}if(s.options.defaultTabHash&&l("#"+s.options.defaultTabHash)){o("#"+s.options.defaultTabHash);return}o(r.tabs[0].hash)}}),t({...ws(r),selectTab:o,findTab:l}),(a,u)=>(A(),H("div",{class:Se(e.wrapperClass),id:e.id},[M("ul",{role:"tablist",class:Se(e.navClass)},[(A(!0),H(de,null,Zt(r.tabs,(d,_)=>{var b,T;return A(),H("li",{key:_,class:Se([(b=d.navItemClass)!=null?b:e.navItemClass,d.isDisabled?e.navItemDisabledClass:"",d.isActive?e.navItemActiveClass:d.isDisabled?"":e.navItemInactiveClass]),role:"presentation"},[M("a",{role:"tab",class:Se([(T=d.navItemLinkClass)!=null?T:e.navItemLinkClass,d.isDisabled?e.navItemLinkDisabledClass:"",d.isActive?e.navItemLinkActiveClass:d.isDisabled?"":e.navItemLinkInactiveClass]),"aria-controls":d.paneId,"aria-selected":d.isActive,href:d.hash,onClick:F=>o(d.hash,F),innerHTML:d.header,tabindex:"0"},null,10,qf)],2)}),128))],2),M("div",{class:Se(e.panelsWrapperClass)},[oe(a.$slots,"default")],2)],10,Kf))}}),Yf={props:{id:{type:String,default:null}},computed:{anId(){return this.id+"-an"},atId(){return this.id+"-at"}}};function Gf(e,t,n,s,r,i){const o=At("tab"),l=At("tabs");return A(),H("div",null,[j(l,{options:{useUrlFragment:!1}},{default:Re(()=>[j(o,{id:i.atId,name:"Attributes"},{default:Re(()=>[oe(e.$slots,"at")]),_:3},8,["id"]),j(o,{id:i.anId,name:"Annotations"},{default:Re(()=>[oe(e.$slots,"an")]),_:3},8,["id"])]),_:3})])}var Jf=fe(Yf,[["render",Gf]]);var An={...jf,enhanceApp({app:e,router:t,siteData:n}){e.component("tabs",zf),e.component("tab",Vf),e.component("codeblock",Jf)}};const Qn=new Set,oo=()=>document.createElement("link"),Xf=e=>{const t=oo();t.rel="prefetch",t.href=e,document.head.appendChild(t)},Zf=e=>{const t=new XMLHttpRequest;t.open("GET",e,t.withCredentials=!0),t.send()};let dn;const Qf=Ne&&(dn=oo())&&dn.relList&&dn.relList.supports&&dn.relList.supports("prefetch")?Xf:Zf;function ed(){if(!Ne||!window.IntersectionObserver)return;let e;if((e=navigator.connection)&&(e.saveData||/2g/.test(e.effectiveType)))return;const t=window.requestIdleCallback||setTimeout;let n=null;const s=()=>{n&&n.disconnect(),n=new IntersectionObserver(i=>{i.forEach(o=>{if(o.isIntersecting){const l=o.target;n.unobserve(l);const{pathname:a}=l;if(!Qn.has(a)){Qn.add(a);const u=qi(a);Qf(u)}}})}),t(()=>{document.querySelectorAll("#app a").forEach(i=>{const{target:o,hostname:l,pathname:a}=i,u=a.match(/\.\w+$/);u&&u[0]!==".html"||o!=="_blank"&&l===location.hostname&&(a!==location.pathname?n.observe(i):Qn.add(a))})})};bt(s);const r=at();We(()=>r.path,s),Nn(()=>{n&&n.disconnect()})}const td=se({setup(e,{slots:t}){const n=gt(!1);return bt(()=>{n.value=!0}),()=>n.value&&t.default?t.default():null}}),nd=An.NotFound||(()=>"404 Not Found"),sd={name:"VitePressApp",setup(){const{site:e}=ve();return bt(()=>{We(()=>e.value.lang,t=>{document.documentElement.lang=t},{immediate:!0})}),ed(),()=>mt(An.Layout)}};function rd(){const e=od(),t=id();t.provide(zi,e);const n=Ga(e.route);return t.provide(Ki,n),t.component("Content",sc),t.component("ClientOnly",td),t.component("Debug",()=>null),Object.defineProperty(t.config.globalProperties,"$frontmatter",{get(){return n.frontmatter.value}}),An.enhanceApp&&An.enhanceApp({app:t,router:e,siteData:tn}),{app:t,router:e,data:n}}function id(){return Ua(sd)}function od(){let e=Ne,t;return Za(n=>{let s=qi(n);return e&&(t=s),(e||t===s)&&(s=s.replace(/\.js$/,".lean.js")),Ne?(e=!1,fo(()=>import(s),[])):require(s)},nd)}if(Ne){const{app:e,router:t,data:n}=rd();t.go().then(()=>{ec(t.route,n.site),e.mount("#app")})}export{fe as _,ld as a,j as b,H as c,rd as createApp,M as d,Qt as e,A as o,At as r,Re as w};
diff --git a/assets/guide_annotations.md.8cc52798.js b/assets/guide_annotations.md.8cc52798.js
new file mode 100644
index 00000000..c561aea6
--- /dev/null
+++ b/assets/guide_annotations.md.8cc52798.js
@@ -0,0 +1,76 @@
+import{_ as n,c as s,o as a,a as t}from"./app.850f5e05.js";const q='{"title":"Annotations","description":"","frontmatter":{},"headers":[{"level":2,"title":"Doctrine","slug":"doctrine"},{"level":2,"title":"Escaping","slug":"escaping"},{"level":2,"title":"Arrays and Objects","slug":"arrays-and-objects"},{"level":2,"title":"Constants","slug":"constants"}],"relativePath":"guide/annotations.md"}',o={},e=t(`<h1 id="annotations" tabindex="-1">Annotations <a class="header-anchor" href="#annotations" aria-hidden="true">#</a></h1><div class="tip custom-block"><p class="custom-block-title">Namespace</p><p>Using a namespace alias simplifies typing and improves readability.</p><p>All annotations are in the <code>OpenApi\\Annotations</code> namespace.</p></div><p>Since Annotations are technically PHP comments, adding <code>use OpenApi\\Annotations as OA;</code> is strictly speaking not necessary. However, doctrine will be quite specific about whether an alias is valid or not.</p><p><code>swagger-php</code> will automatically register the <code>@OA</code> alias so all annotations can be used using the <code>@OA</code> shortcut without any additional work.</p><h2 id="doctrine" tabindex="-1">Doctrine <a class="header-anchor" href="#doctrine" aria-hidden="true">#</a></h2><p>Annotations are PHP comments (docblocks) containing <a href="https://www.doctrine-project.org/projects/annotations.html" target="_blank" rel="noopener noreferrer">doctrine style annotations</a>.</p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>All documentation related to doctrine applies to annotations only.</p></div><p><strong>Example:</strong></p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Annotations</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @OA\\Info(title=&quot;My First API&quot;, version=&quot;0.1&quot;)
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApi</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span> <span class="token punctuation">{</span>
+
+    <span class="token comment">/**
+     * @OA\\Get(
+     *     path=&quot;/api/resource.json&quot;,
+     *     @OA\\Response(response=&quot;200&quot;, description=&quot;An example resource&quot;)
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">resource</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token comment">// ...</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><h2 id="escaping" tabindex="-1">Escaping <a class="header-anchor" href="#escaping" aria-hidden="true">#</a></h2><div class="tip custom-block"><p class="custom-block-title">Escaping double quotes</p><p>Double quotes can be escaped by doubling them rather than using <code>\\</code></p><p>For example:</p><div class="language-php"><pre><code>    @<span class="token constant">OA</span><span class="token function"><span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span>
+       title<span class="token operator">=</span><span class="token string double-quoted-string">&quot;Request&quot;</span><span class="token punctuation">,</span>
+       schema<span class="token operator">=</span><span class="token string double-quoted-string">&quot;Request&quot;</span><span class="token punctuation">,</span>
+       example<span class="token operator">=</span><span class="token punctuation">{</span>
+          <span class="token string double-quoted-string">&quot;configuration&quot;</span><span class="token punctuation">:</span><span class="token string double-quoted-string">&quot;{&quot;</span><span class="token string double-quoted-string">&quot;formConfig&quot;</span><span class="token string double-quoted-string">&quot;:123}&quot;</span>
+       <span class="token punctuation">}</span>
+     <span class="token punctuation">)</span>
+</code></pre></div></div><h2 id="arrays-and-objects" tabindex="-1">Arrays and Objects <a class="header-anchor" href="#arrays-and-objects" aria-hidden="true">#</a></h2><p>Doctrine annotations support arrays, but use <code>{</code> and <code>}</code> instead of <code>[</code> and <code>]</code>.</p><p>Doctrine also supports objects, which also use <code>{</code> and <code>}</code> and require the property names to be surrounded with <code>&quot;</code>.</p><div class="warning custom-block"><p class="custom-block-title">DON&#39;T WRITE</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Info(
+ *   title=&quot;My first API&quot;,
+ *   version=&quot;1.0.0&quot;,
+ *   contact={
+ *     &quot;email&quot;: &quot;support@example.com&quot;
+ *   }
+ * )
+ */</span>
+</code></pre></div></div><p>This &quot;works&quot; but most objects have an annotation with the same name as the property, such as <code>@OA\\Contact</code> for <code>contact</code>:</p><div class="tip custom-block"><p class="custom-block-title">WRITE</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Info(
+ *   title=&quot;My first API&quot;,
+ *   version=&quot;1.0.0&quot;,
+ *   @OA\\Contact(
+ *     email=&quot;support@example.com&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div></div><p>This also adds validation, so when you misspell a property or forget a required property, it will trigger a PHP warning.</p><p>For example, if you write <code>emial=&quot;support@example.com&quot;</code>, swagger-php would generate a notice with <code>Unexpected field &quot;emial&quot; for @OA\\Contact(), expecting &quot;name&quot;, &quot;email&quot;, ...</code></p><p>Placing multiple annotations of the same type will result in an array of objects. For objects, the key is defined by the field with the same name as the annotation: <code>response</code> in a <code>@OA\\Response</code>, <code>property</code> in a <code>@OA\\Property</code>, etc.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Get(
+ *   path=&quot;/products&quot;,
+ *   summary=&quot;list products&quot;,
+ *   @OA\\Response(
+ *     response=200,
+ *     description=&quot;A list with products&quot;
+ *   ),
+ *   @OA\\Response(
+ *     response=&quot;default&quot;,
+ *     description=&quot;an &quot;&quot;unexpected&quot;&quot; error&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div><p><strong>Results in</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">paths</span><span class="token punctuation">:</span>
+  <span class="token key atrule">/products</span><span class="token punctuation">:</span>
+    <span class="token key atrule">get</span><span class="token punctuation">:</span>
+      <span class="token key atrule">summary</span><span class="token punctuation">:</span> <span class="token string">&quot;list products&quot;</span>
+      <span class="token key atrule">responses</span><span class="token punctuation">:</span>
+        <span class="token key atrule">&quot;200&quot;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&quot;A list with products&quot;</span>
+        <span class="token key atrule">default</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;an &quot;unexpected&quot; error&#39;</span>
+</code></pre></div><h2 id="constants" tabindex="-1">Constants <a class="header-anchor" href="#constants" aria-hidden="true">#</a></h2><p>You can use constants inside doctrine annotations.</p><div class="language-php"><pre><code><span class="token function">define</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;API_HOST&quot;</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token variable">$env</span> <span class="token operator">===</span> <span class="token string double-quoted-string">&quot;production&quot;</span><span class="token punctuation">)</span> <span class="token operator">?</span> <span class="token string double-quoted-string">&quot;example.com&quot;</span> <span class="token punctuation">:</span> <span class="token string double-quoted-string">&quot;localhost&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Server(url=API_HOST)
+ */</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Using the CLI you might need to include the php file with the constants using the <code>--bootstrap</code> options.</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> openapi <span class="token parameter variable">--bootstrap</span> constants.php
+</code></pre></div></div>`,28),p=[e];function c(i,l,u,r,d,k){return a(),s("div",null,p)}var g=n(o,[["render",c]]);export{q as __pageData,g as default};
diff --git a/assets/guide_annotations.md.8cc52798.lean.js b/assets/guide_annotations.md.8cc52798.lean.js
new file mode 100644
index 00000000..2599ebb6
--- /dev/null
+++ b/assets/guide_annotations.md.8cc52798.lean.js
@@ -0,0 +1 @@
+import{_ as n,c as s,o as a,a as t}from"./app.850f5e05.js";const q='{"title":"Annotations","description":"","frontmatter":{},"headers":[{"level":2,"title":"Doctrine","slug":"doctrine"},{"level":2,"title":"Escaping","slug":"escaping"},{"level":2,"title":"Arrays and Objects","slug":"arrays-and-objects"},{"level":2,"title":"Constants","slug":"constants"}],"relativePath":"guide/annotations.md"}',o={},e=t("",28),p=[e];function c(i,l,u,r,d,k){return a(),s("div",null,p)}var g=n(o,[["render",c]]);export{q as __pageData,g as default};
diff --git a/assets/guide_attributes.md.3e0b725a.js b/assets/guide_attributes.md.3e0b725a.js
new file mode 100644
index 00000000..2a2f80d9
--- /dev/null
+++ b/assets/guide_attributes.md.3e0b725a.js
@@ -0,0 +1,13 @@
+import{_ as s,c as n,o as a,a as t}from"./app.850f5e05.js";const b='{"title":"Attributes","description":"","frontmatter":{},"headers":[{"level":2,"title":"Nesting","slug":"nesting"}],"relativePath":"guide/attributes.md"}',e={},p=t(`<h1 id="attributes" tabindex="-1">Attributes <a class="header-anchor" href="#attributes" aria-hidden="true">#</a></h1><div class="tip custom-block"><p class="custom-block-title">Namespace</p><p>Using a namespace alias simplifies typing and improves readability.</p><p>All attributes are in the <code>OpenApi\\Attributes</code> namespace.</p></div><h2 id="nesting" tabindex="-1">Nesting <a class="header-anchor" href="#nesting" aria-hidden="true">#</a></h2><p>Similar to annotations attributes can be top level or nested. However, attributes <strong>may be put at the same level</strong> if there is no ambiguity. <code>swagger-php</code> will then merge attributes according to the defined rules about parent/child relationships.</p><p><strong>Example</strong></p><p>Nested:</p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Get</span><span class="token punctuation">(</span>
+        <span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/api/users&#39;</span><span class="token punctuation">,</span>
+        <span class="token attribute-class-name class-name">responses</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
+            <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">200</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;AOK&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+            <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">401</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;Not allowed&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+        <span class="token punctuation">]</span>
+    <span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">users</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Not nested:</p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/api/users&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">200</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;AOK&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">401</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;Not allowed&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">users</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Depending on how much nesting there is this can make things a bit simpler and easier to read.</p><div class="warning custom-block"><p class="custom-block-title">Top level only</p><p>Automatic merging of attributes works only at the top level - in the example that would be the method <code>users()</code>.</p></div>`,11),c=[p];function o(i,l,u,r,k,m){return a(),n("div",null,c)}var g=s(e,[["render",o]]);export{b as __pageData,g as default};
diff --git a/assets/guide_attributes.md.3e0b725a.lean.js b/assets/guide_attributes.md.3e0b725a.lean.js
new file mode 100644
index 00000000..360addcd
--- /dev/null
+++ b/assets/guide_attributes.md.3e0b725a.lean.js
@@ -0,0 +1 @@
+import{_ as s,c as n,o as a,a as t}from"./app.850f5e05.js";const b='{"title":"Attributes","description":"","frontmatter":{},"headers":[{"level":2,"title":"Nesting","slug":"nesting"}],"relativePath":"guide/attributes.md"}',e={},p=t("",11),c=[p];function o(i,l,u,r,k,m){return a(),n("div",null,c)}var g=s(e,[["render",o]]);export{b as __pageData,g as default};
diff --git a/assets/guide_common-techniques.md.e2af46b9.js b/assets/guide_common-techniques.md.e2af46b9.js
new file mode 100644
index 00000000..dbd141c2
--- /dev/null
+++ b/assets/guide_common-techniques.md.e2af46b9.js
@@ -0,0 +1,216 @@
+import{_ as n,c as s,o as a,a as e}from"./app.850f5e05.js";const h='{"title":"Common techniques","description":"","frontmatter":{},"headers":[{"level":2,"title":"Annotation placement","slug":"annotation-placement"},{"level":2,"title":"Context awareness","slug":"context-awareness"},{"level":2,"title":"Response media type","slug":"response-media-type"},{"level":2,"title":"Using references - $ref","slug":"using-references-ref"},{"level":2,"title":"Array parameters in query","slug":"array-parameters-in-query"},{"level":2,"title":"Vendor extensions","slug":"vendor-extensions"},{"level":2,"title":"Enums","slug":"enums"},{"level":3,"title":"Enum cases as value","slug":"enum-cases-as-value"},{"level":2,"title":"Enum schemas","slug":"enum-schemas"}],"relativePath":"guide/common-techniques.md"}',t={},p=e(`<h1 id="common-techniques" tabindex="-1">Common techniques <a class="header-anchor" href="#common-techniques" aria-hidden="true">#</a></h1><h2 id="annotation-placement" tabindex="-1">Annotation placement <a class="header-anchor" href="#annotation-placement" aria-hidden="true">#</a></h2><p>You shouldn&#39;t place all annotations inside one big block, but scatter them throughout your codebase as close to the relevant source code as appropriate.</p><p><code>swagger-php</code> will scan your project and merge all meta-data into one<code> @OA\\OpenApi</code> annotation.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>As of <code>swagger-php</code> v4 all annotations or attributes must be associated with a structural element (<code>class</code>, <code>method</code>, <code>parameter</code> or <code>enum</code>)</p></div><h2 id="context-awareness" tabindex="-1">Context awareness <a class="header-anchor" href="#context-awareness" aria-hidden="true">#</a></h2><p><code>swagger-php</code> looks at the context of the annotation and will augment it with things like <code>property name</code>, <code>data type</code> (doctype and native type hints) as well as a couple other things.</p><p>This means in a lot of cases it is not necessary to explicitly document all details.</p><p><strong>Example</strong></p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token comment">/**
+ * @OA\\Schema()
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span> <span class="token punctuation">{</span>
+
+    <span class="token comment">/**
+     * The product name,
+     * @var string
+     * @OA\\Property()
+     */</span>
+    <span class="token keyword">public</span> <span class="token variable">$name</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><p><strong>Results in</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">name</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&quot;The product name&quot;</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><p><strong>As if you&#39;d written</strong></p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * The product name
+     * @var string
+     *
+     * @OA\\Property(
+     *   property=&quot;name&quot;,
+     *   type=&quot;string&quot;,
+     *   description=&quot;The product name&quot;
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token variable">$name</span><span class="token punctuation">;</span>
+</code></pre></div><h2 id="response-media-type" tabindex="-1">Response media type <a class="header-anchor" href="#response-media-type" aria-hidden="true">#</a></h2><p>The <code>@OA\\MediaType</code> is used to describe the content:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Response(
+ *     response=200,
+ *     description=&quot;successful operation&quot;,
+ *     @OA\\MediaType(
+ *         mediaType=&quot;application/json&quot;,
+ *         @OA\\Schema(ref=&quot;#/components/schemas/User&quot;),
+ *     )
+ * ),
+ */</span>
+</code></pre></div><p>But because most API requests and responses are JSON, the <code>@OA\\JsonContent</code> allows you to simplify this by writing:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Response(
+ *     response=200,
+ *     description=&quot;successful operation&quot;,
+ *     @OA\\JsonContent(ref=&quot;#/components/schemas/User&quot;),
+ * )
+ */</span>
+</code></pre></div><p>During processing the <code>@OA\\JsonContent</code> unfolds to <code>@OA\\MediaType( mediaType=&quot;application/json&quot;, @OA\\Schema(...)</code> and will generate the same output.</p><h2 id="using-references-ref" tabindex="-1">Using references - <code>$ref</code> <a class="header-anchor" href="#using-references-ref" aria-hidden="true">#</a></h2><p>It&#39;s quite common that endpoints have some overlap in either their request or response data. To keep things DRY (Don&#39;t Repeat Yourself) the specification allows reusing components using <code>$ref</code>&#39;s</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Schema(
+ *   schema=&quot;product_id&quot;,
+ *   type=&quot;integer&quot;,
+ *   format=&quot;int64&quot;,
+ *   description=&quot;The unique identifier of a product in our catalog&quot;
+ * )
+ */</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">product_id</span><span class="token punctuation">:</span>
+      <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&quot;The unique identifier of a product in our catalog&quot;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+      <span class="token key atrule">format</span><span class="token punctuation">:</span> int64
+</code></pre></div><p>This doesn&#39;t do anything by itself, but now you can reference this fragment by its path in the document tree <code>#/components/schemas/product_id</code></p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * @OA\\Property(ref=&quot;#/components/schemas/product_id&quot;)
+     */</span>
+    <span class="token keyword">public</span> <span class="token variable">$id</span><span class="token punctuation">;</span>
+</code></pre></div><div class="info custom-block"><p class="custom-block-title">Examples</p><p>There are more uses cases on how to use refs in the <a href="https://github.com/zircote/swagger-php/tree/master/Examples/using-refs" target="_blank" rel="noopener noreferrer">using-refs example</a>.</p></div><h2 id="array-parameters-in-query" tabindex="-1">Array parameters in query <a class="header-anchor" href="#array-parameters-in-query" aria-hidden="true">#</a></h2><p>Depending on <a href="https://swagger.io/specification/#style-values" target="_blank" rel="noopener noreferrer">style-values</a> <code>@OA\\Parameter(in=&quot;query&quot;, name=&quot;param&quot;, ...)</code> might create urls like this: <code>path?param=123&amp;param=abc</code> which do not work when reading the param values in PHP.</p><p>The solution is to change the name <code>param</code> into <code>param[]</code> which will create <code>path?param[]=123&amp;param[]=abc</code> and results in a PHP array.</p><h2 id="vendor-extensions" tabindex="-1">Vendor extensions <a class="header-anchor" href="#vendor-extensions" aria-hidden="true">#</a></h2><p>The specification allows for <a href="http://swagger.io/specification/#vendorExtensions" target="_blank" rel="noopener noreferrer">custom properties</a> as long as they start with &quot;x-&quot;. Therefore, all swagger-php annotations have an <code>x</code> property which accepts an array (map) and will unfold into &quot;x-&quot; properties.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Info(
+ *   title=&quot;Example&quot;,
+ *   version=&quot;1.0.0&quot;,
+ *   x={
+ *     &quot;some-name&quot;: &quot;a-value&quot;,
+ *     &quot;another&quot;: 2,
+ *     &quot;complex-type&quot;: {
+ *       &quot;supported&quot;:{
+ *         {&quot;version&quot;: &quot;1.0&quot;, &quot;level&quot;: &quot;baseapi&quot;},
+ *         {&quot;version&quot;: &quot;2.1&quot;, &quot;level&quot;: &quot;fullapi&quot;},
+ *       }
+ *     }
+ *   }
+ * )
+ */</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">info</span><span class="token punctuation">:</span>
+  <span class="token key atrule">title</span><span class="token punctuation">:</span> Example
+  <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token number">1</span>
+  <span class="token key atrule">x-some-name</span><span class="token punctuation">:</span> a<span class="token punctuation">-</span>value
+  <span class="token key atrule">x-another</span><span class="token punctuation">:</span> <span class="token number">2</span>
+  <span class="token key atrule">x-complex-type</span><span class="token punctuation">:</span>
+    <span class="token key atrule">supported</span><span class="token punctuation">:</span>
+      <span class="token punctuation">-</span> <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token string">&quot;1.0&quot;</span>
+        <span class="token key atrule">level</span><span class="token punctuation">:</span> baseapi
+      <span class="token punctuation">-</span> <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token string">&quot;2.1&quot;</span>
+        <span class="token key atrule">level</span><span class="token punctuation">:</span> fullapi
+</code></pre></div><h2 id="enums" tabindex="-1">Enums <a class="header-anchor" href="#enums" aria-hidden="true">#</a></h2><p><a href="https://www.php.net/manual/en/language.enumerations.basics.php" target="_blank" rel="noopener noreferrer">PHP 8.1 enums</a> are supported in two main use cases.</p><h3 id="enum-cases-as-value" tabindex="-1">Enum cases as value <a class="header-anchor" href="#enum-cases-as-value" aria-hidden="true">#</a></h3><p>Enum cases can be used as value in an <code>enum</code> list just like a <code>string</code>, <code>integer</code> or any other primitive type.</p><p><strong>Basic enum:</strong></p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Suit</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">Hearts</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">Diamonds</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">Clubs</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">Spades</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Model</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">enum</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token attribute-class-name class-name">Suit</span><span class="token operator">::</span><span class="token constant">Hearts</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">Suit</span><span class="token operator">::</span><span class="token constant">Diamonds</span><span class="token punctuation">]</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">protected</span> <span class="token keyword type-declaration">array</span> <span class="token variable">$someSuits</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Model</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">someSuits</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+          <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+            <span class="token punctuation">-</span> Hearts
+            <span class="token punctuation">-</span> Diamonds
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+
+</code></pre></div><p><strong>Backed enums</strong></p><p>If the enum is a backed enum, the case backing value is used instead of the name.</p><h2 id="enum-schemas" tabindex="-1">Enum schemas <a class="header-anchor" href="#enum-schemas" aria-hidden="true">#</a></h2><p>The simples way of using enums is to annotate them as <code>Schema</code>. This allows you to reference them like any other schema in your spec.</p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Colour</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">GREEN</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">BLUE</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">RED</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token class-name type-declaration">Colour</span> <span class="token variable">$colour</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Colour</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> GREEN
+        <span class="token punctuation">-</span> BLUE
+        <span class="token punctuation">-</span> RED
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">colour</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Colour&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><p><strong>Backed enums</strong></p><p>For backed enums there exist two rules that determine whether the name or backing value is used:</p><ol><li>If no schema type is given, the enum name is used.</li><li>If a schema type is given, and it matches the backing type, the enum backing value is used.</li></ol><p><strong>Using the name of a backed enum:</strong></p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Colour</span><span class="token punctuation">:</span> <span class="token keyword type-declaration">int</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">GREEN</span> <span class="token operator">=</span> <span class="token number">1</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">BLUE</span> <span class="token operator">=</span> <span class="token number">2</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">RED</span> <span class="token operator">=</span> <span class="token number">3</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token class-name type-declaration">Colour</span> <span class="token variable">$colour</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Colour</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> GREEN
+        <span class="token punctuation">-</span> BLUE
+        <span class="token punctuation">-</span> RED
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">colour</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Colour&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><p><strong>Using the backing value:</strong></p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;integer&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Colour</span><span class="token punctuation">:</span> <span class="token keyword type-declaration">int</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">GREEN</span> <span class="token operator">=</span> <span class="token number">1</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">BLUE</span> <span class="token operator">=</span> <span class="token number">2</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">RED</span> <span class="token operator">=</span> <span class="token number">3</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token class-name type-declaration">Colour</span> <span class="token variable">$colour</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Colour</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> <span class="token number">1</span>
+        <span class="token punctuation">-</span> <span class="token number">2</span>
+        <span class="token punctuation">-</span> <span class="token number">3</span>
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">colour</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Colour&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div>`,62),o=[p];function c(l,u,i,r,k,d){return a(),s("div",null,o)}var y=n(t,[["render",c]]);export{h as __pageData,y as default};
diff --git a/assets/guide_common-techniques.md.e2af46b9.lean.js b/assets/guide_common-techniques.md.e2af46b9.lean.js
new file mode 100644
index 00000000..a9637a72
--- /dev/null
+++ b/assets/guide_common-techniques.md.e2af46b9.lean.js
@@ -0,0 +1 @@
+import{_ as n,c as s,o as a,a as e}from"./app.850f5e05.js";const h='{"title":"Common techniques","description":"","frontmatter":{},"headers":[{"level":2,"title":"Annotation placement","slug":"annotation-placement"},{"level":2,"title":"Context awareness","slug":"context-awareness"},{"level":2,"title":"Response media type","slug":"response-media-type"},{"level":2,"title":"Using references - $ref","slug":"using-references-ref"},{"level":2,"title":"Array parameters in query","slug":"array-parameters-in-query"},{"level":2,"title":"Vendor extensions","slug":"vendor-extensions"},{"level":2,"title":"Enums","slug":"enums"},{"level":3,"title":"Enum cases as value","slug":"enum-cases-as-value"},{"level":2,"title":"Enum schemas","slug":"enum-schemas"}],"relativePath":"guide/common-techniques.md"}',t={},p=e("",62),o=[p];function c(l,u,i,r,k,d){return a(),s("div",null,o)}var y=n(t,[["render",c]]);export{h as __pageData,y as default};
diff --git a/assets/guide_cookbook.md.2d416869.js b/assets/guide_cookbook.md.2d416869.js
new file mode 100644
index 00000000..714900d7
--- /dev/null
+++ b/assets/guide_cookbook.md.2d416869.js
@@ -0,0 +1,496 @@
+import{_ as o,c as p,b as c,w as a,a as e,r as u,o as l,d as n,e as s}from"./app.850f5e05.js";const O='{"title":"Cookbook","description":"","frontmatter":{},"headers":[{"level":2,"title":"x-tagGroups","slug":"x-taggroups"},{"level":2,"title":"Adding examples to @OA\\\\Response","slug":"adding-examples-to-oa-response"},{"level":2,"title":"External documentation","slug":"external-documentation"},{"level":2,"title":"Properties with union types","slug":"properties-with-union-types"},{"level":2,"title":"Referencing a security scheme","slug":"referencing-a-security-scheme"},{"level":2,"title":"File upload with headers","slug":"file-upload-with-headers"},{"level":2,"title":"Set the XML root name","slug":"set-the-xml-root-name"},{"level":2,"title":"upload multipart/form-data","slug":"upload-multipart-form-data"},{"level":2,"title":"Default security scheme for all endpoints","slug":"default-security-scheme-for-all-endpoints"},{"level":2,"title":"Nested objects","slug":"nested-objects"},{"level":2,"title":"Documenting union type response data using oneOf","slug":"documenting-union-type-response-data-using-oneof"},{"level":2,"title":"Reusing responses","slug":"reusing-responses"},{"level":2,"title":"mediaType=\\"/\\"","slug":"mediatype"},{"level":2,"title":"Warning about Multiple response with same response=\\"200\\"","slug":"warning-about-multiple-response-with-same-response-200"},{"level":2,"title":"Callbacks","slug":"callbacks"},{"level":2,"title":"(Mostly) virtual models","slug":"mostly-virtual-models"},{"level":2,"title":"Using class name as type instead of references","slug":"using-class-name-as-type-instead-of-references"},{"level":2,"title":"Enums","slug":"enums"},{"level":2,"title":"Multi value query parameter: &q[]=1&q[]=1","slug":"multi-value-query-parameter-q-1-q-1"},{"level":2,"title":"Custom response classes","slug":"custom-response-classes"},{"level":2,"title":"Annotating class constants","slug":"annotating-class-constants"}],"relativePath":"guide/cookbook.md"}',i={},r=e(`<h1 id="cookbook" tabindex="-1">Cookbook <a class="header-anchor" href="#cookbook" aria-hidden="true">#</a></h1><h2 id="x-taggroups" tabindex="-1"><code>x-tagGroups</code> <a class="header-anchor" href="#x-taggroups" aria-hidden="true">#</a></h2><p>OpenApi has the concept of grouping endpoints using tags. On top of that, some tools (<a href="https://redoc.ly/docs/api-reference-docs/specification-extensions/x-tag-groups/" target="_blank" rel="noopener noreferrer">redocly</a>, for example) support further grouping via the vendor extension <code>x-tagGroups</code>.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\OpenApi(
+ *   x={
+ *       &quot;tagGroups&quot;=
+ *           {{&quot;name&quot;=&quot;User Management&quot;, &quot;tags&quot;={&quot;Users&quot;, &quot;API keys&quot;, &quot;Admin&quot;}}
+ *       }
+ *   }
+ * )
+ */</span>
+</code></pre></div><h2 id="adding-examples-to-oa-response" tabindex="-1">Adding examples to <code>@OA\\Response</code> <a class="header-anchor" href="#adding-examples-to-oa-response" aria-hidden="true">#</a></h2><div class="language-php"><pre><code><span class="token comment">/*
+ * @OA\\Response(
+ *     response=200,
+ *     description=&quot;OK&quot;,
+ *     @OA\\JsonContent(
+ *         oneOf={
+ *             @OA\\Schema(ref=&quot;#/components/schemas/Result&quot;),
+ *             @OA\\Schema(type=&quot;boolean&quot;)
+ *         },
+ *         @OA\\Examples(example=&quot;result&quot;, value={&quot;success&quot;: true}, summary=&quot;An result object.&quot;),
+ *         @OA\\Examples(example=&quot;bool&quot;, value=false, summary=&quot;A boolean value.&quot;),
+ *     )
+ * )
+ */</span>
+</code></pre></div><h2 id="external-documentation" tabindex="-1">External documentation <a class="header-anchor" href="#external-documentation" aria-hidden="true">#</a></h2><p>OpenApi allows a single reference to external documentation. This is a part of the top level <code>@OA\\OpenApi</code>.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\OpenApi(
+ *   @OA\\ExternalDocumentation(
+ *     description=&quot;More documentation here...&quot;,
+ *     url=&quot;https://example.com/externaldoc1/&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If no <code>@OA\\OpenApi</code> is configured, <code>swagger-php</code> will create one automatically.</p><p>That means the above example would also work with just the <code>OA\\ExternalDocumentation</code> annotation.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\ExternalDocumentation(
+ *   description=&quot;More documentation here...&quot;,
+ *   url=&quot;https://example.com/externaldoc1/&quot;
+ * )
+ */</span>
+</code></pre></div></div><h2 id="properties-with-union-types" tabindex="-1">Properties with union types <a class="header-anchor" href="#properties-with-union-types" aria-hidden="true">#</a></h2><p>Sometimes properties or even lists (arrays) may contain data of different types. This can be expressed using <code>oneOf</code>.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Schema(
+ *      schema=&quot;StringList&quot;,
+ *      @OA\\Property(property=&quot;value&quot;, type=&quot;array&quot;, @OA\\Items(anyOf={@OA\\Schema(type=&quot;string&quot;)}))
+ * )
+ * @OA\\Schema(
+ *      schema=&quot;String&quot;,
+ *      @OA\\Property(property=&quot;value&quot;, type=&quot;string&quot;)
+ * )
+ * @OA\\Schema(
+ *      schema=&quot;Object&quot;,
+ *      @OA\\Property(property=&quot;value&quot;, type=&quot;object&quot;)
+ * )
+ * @OA\\Schema(
+ *     schema=&quot;mixedList&quot;,
+ *     @OA\\Property(property=&quot;fields&quot;, type=&quot;array&quot;, @OA\\Items(oneOf={
+ *         @OA\\Schema(ref=&quot;#/components/schemas/StringList&quot;),
+ *         @OA\\Schema(ref=&quot;#/components/schemas/String&quot;),
+ *         @OA\\Schema(ref=&quot;#/components/schemas/Object&quot;)
+ *     }))
+ * )
+ */</span>
+</code></pre></div><p>This will resolve into this YAML</p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">StringList</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">value</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+          <span class="token key atrule">items</span><span class="token punctuation">:</span>
+            <span class="token key atrule">anyOf</span><span class="token punctuation">:</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">String</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">value</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">Object</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">value</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">mixedList</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">fields</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+          <span class="token key atrule">items</span><span class="token punctuation">:</span>
+            <span class="token key atrule">oneOf</span><span class="token punctuation">:</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/StringList&#39;</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/String&#39;</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Object&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><h2 id="referencing-a-security-scheme" tabindex="-1">Referencing a security scheme <a class="header-anchor" href="#referencing-a-security-scheme" aria-hidden="true">#</a></h2><p>An API might have zero or more security schemes. These are defined at the top level and vary from simple to complex:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\SecurityScheme(
+ *     type=&quot;apiKey&quot;,
+ *     name=&quot;api_key&quot;,
+ *     in=&quot;header&quot;,
+ *     securityScheme=&quot;api_key&quot;
+ * )
+ *
+ * @OA\\SecurityScheme(
+ *   type=&quot;oauth2&quot;,
+ *   securityScheme=&quot;petstore_auth&quot;,
+ *   @OA\\Flow(
+ *      authorizationUrl=&quot;http://petstore.swagger.io/oauth/dialog&quot;,
+ *      flow=&quot;implicit&quot;,
+ *      scopes={
+ *         &quot;read:pets&quot;: &quot;read your pets&quot;,
+ *         &quot;write:pets&quot;: &quot;modify pets in your account&quot;
+ *      }
+ *   )
+ * )
+ */</span>
+</code></pre></div><p>To declare an endpoint as secure and define what security schemes are available to authenticate a client it needs to be added to the operation, for example:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Get(
+ *      path=&quot;/api/secure/&quot;,
+ *      summary=&quot;Requires authentication&quot;
+ *    ),
+ *    security={ {&quot;api_key&quot;: {}} }
+ * )
+ */</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">Endpoints can support multiple security schemes and have custom options too:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Get(
+ *      path=&quot;/api/secure/&quot;,
+ *      summary=&quot;Requires authentication&quot;
+ *    ),
+ *    security={
+ *      { &quot;api_key&quot;: {} },
+ *      { &quot;petstore_auth&quot;: {&quot;write:pets&quot;, &quot;read:pets&quot;} }
+ *    }
+ * )
+ */</span>
+</code></pre></div></div><h2 id="file-upload-with-headers" tabindex="-1">File upload with headers <a class="header-anchor" href="#file-upload-with-headers" aria-hidden="true">#</a></h2><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Post(
+ *   path=&quot;/v1/media/upload&quot;,
+ *   summary=&quot;Upload document&quot;,
+ *   description=&quot;&quot;,
+ *   tags={&quot;Media&quot;},
+ *   @OA\\RequestBody(
+ *     required=true,
+ *     @OA\\MediaType(
+ *       mediaType=&quot;application/octet-stream&quot;,
+ *       @OA\\Schema(
+ *         required={&quot;content&quot;},
+ *         @OA\\Property(
+ *           description=&quot;Binary content of file&quot;,
+ *           property=&quot;content&quot;,
+ *           type=&quot;string&quot;,
+ *           format=&quot;binary&quot;
+ *         )
+ *       )
+ *     )
+ *   ),
+ *   @OA\\Response(
+ *     response=200, description=&quot;Success&quot;,
+ *     @OA\\Schema(type=&quot;string&quot;)
+ *   ),
+ *   @OA\\Response(
+ *     response=400, description=&quot;Bad Request&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div><h2 id="set-the-xml-root-name" tabindex="-1">Set the XML root name <a class="header-anchor" href="#set-the-xml-root-name" aria-hidden="true">#</a></h2><p>The <code>OA\\Xml</code> annotation may be used to set the XML root element for a given <code>@OA\\XmlContent</code> response body</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Schema(
+ *     schema=&quot;Error&quot;,
+ *     @OA\\Property(property=&quot;message&quot;),
+ *     @OA\\Xml(name=&quot;details&quot;)
+ * )
+ */</span>
+
+<span class="token comment">/**
+ * @OA\\Post(
+ *     path=&quot;/foobar&quot;,
+ *     @OA\\Response(
+ *         response=400,
+ *         description=&quot;Request error&quot;,
+ *         @OA\\XmlContent(ref=&quot;#/components/schemas/Error&quot;,
+ *           @OA\\Xml(name=&quot;error&quot;)
+ *        )
+ *     )
+ * )
+ */</span>
+</code></pre></div><h2 id="upload-multipart-form-data" tabindex="-1">upload multipart/form-data <a class="header-anchor" href="#upload-multipart-form-data" aria-hidden="true">#</a></h2><p>Form posts are <code>@OA\\Post</code> requests with a <code>multipart/form-data</code> <code>@OA\\RequestBody</code>. The relevant bit looks something like this</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Post(
+ *   path=&quot;/v1/user/update&quot;,
+ *   summary=&quot;Form post&quot;,
+ *   @OA\\RequestBody(
+ *     @OA\\MediaType(
+ *       mediaType=&quot;multipart/form-data&quot;,
+ *       @OA\\Schema(
+ *         @OA\\Property(property=&quot;name&quot;),
+ *         @OA\\Property(
+ *           description=&quot;file to upload&quot;,
+ *           property=&quot;avatar&quot;,
+ *           type=&quot;string&quot;,
+ *           format=&quot;binary&quot;,
+ *         ),
+ *       )
+ *     )
+ *   ),
+ *   @OA\\Response(response=200, description=&quot;Success&quot;)
+ * )
+ */</span>
+</code></pre></div><h2 id="default-security-scheme-for-all-endpoints" tabindex="-1">Default security scheme for all endpoints <a class="header-anchor" href="#default-security-scheme-for-all-endpoints" aria-hidden="true">#</a></h2><p>Unless specified each endpoint needs to declare what security schemes it supports. However, there is a way to also configure security schemes globally for the whole API.</p><p>This is done on the <code>@OA\\OpenApi</code> annotation:</p>`,32),d=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Attributes")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OAT"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OAT"),n("span",{class:"token punctuation"},"\\"),s("OpenApi")]),n("span",{class:"token punctuation"},"("),s(`
+    `),n("span",{class:"token attribute-class-name class-name"},"security"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'bearerAuth'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},"]"),s(`
+`),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OAT"),n("span",{class:"token punctuation"},"\\"),s("Components")]),n("span",{class:"token punctuation"},"("),s(`
+    `),n("span",{class:"token attribute-class-name class-name"},"securitySchemes"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token punctuation"},"["),s(`
+        `),n("span",{class:"token attribute-class-name class-name"},"new"),s(),n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OAT"),n("span",{class:"token punctuation"},"\\"),s("SecurityScheme")]),n("span",{class:"token punctuation"},"("),s(`
+            `),n("span",{class:"token attribute-class-name class-name"},"securityScheme"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'bearerAuth'"),n("span",{class:"token punctuation"},","),s(`
+            `),n("span",{class:"token attribute-class-name class-name"},"type"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'http'"),n("span",{class:"token punctuation"},","),s(`
+            `),n("span",{class:"token attribute-class-name class-name"},"scheme"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'bearer'"),s(`
+        `),n("span",{class:"token punctuation"},")"),s(`
+    `),n("span",{class:"token punctuation"},"]"),s(`
+`),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApiSpec"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),k=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Annotations")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token comment"},`/**
+ * @OA\\OpenApi(
+ *   security={{"bearerAuth": {}}}
+ * )
+ *
+ * @OA\\SecurityScheme(
+ *   securityScheme="bearerAuth",
+ *   type="http",
+ *   scheme="bearer"
+ * )
+ */`),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApiSpec"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),m=e(`<h2 id="nested-objects" tabindex="-1">Nested objects <a class="header-anchor" href="#nested-objects" aria-hidden="true">#</a></h2><p>Complex, nested data structures are defined by nesting <code>@OA\\Property</code> annotations inside others (with <code>type=&quot;object&quot;</code>).</p><div class="language-php"><pre><code><span class="token comment">/**
+ *  @OA\\Schema(
+ *    schema=&quot;Profile&quot;,
+ *    type=&quot;object&quot;,
+*
+ *    @OA\\Property(
+ *      property=&quot;Status&quot;,
+ *      type=&quot;string&quot;,
+ *      example=&quot;0&quot;
+ *    ),
+ *
+ *    @OA\\Property(
+ *      property=&quot;Group&quot;,
+ *      type=&quot;object&quot;,
+ *
+ *      @OA\\Property(
+ *        property=&quot;ID&quot;,
+ *        description=&quot;ID de grupo&quot;,
+ *        type=&quot;number&quot;,
+ *        example=-1
+ *      ),
+ *
+ *      @OA\\Property(
+ *        property=&quot;Name&quot;,
+ *        description=&quot;Nombre de grupo&quot;,
+ *        type=&quot;string&quot;,
+ *        example=&quot;Superadmin&quot;
+ *      )
+ *    )
+ *  )
+ */</span>
+
+</code></pre></div><h2 id="documenting-union-type-response-data-using-oneof" tabindex="-1">Documenting union type response data using <code>oneOf</code> <a class="header-anchor" href="#documenting-union-type-response-data-using-oneof" aria-hidden="true">#</a></h2><p>A response with either a single or a list of <code>QualificationHolder</code>&#39;s.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Response(
+ *     response=200,
+ *     @OA\\JsonContent(
+ *         oneOf={
+ *             @OA\\Schema(ref=&quot;#/components/schemas/QualificationHolder&quot;),
+ *             @OA\\Schema(
+ *                 type=&quot;array&quot;,
+ *                 @OA\\Items(ref=&quot;#/components/schemas/QualificationHolder&quot;)
+ *             )
+ *         }
+ *     )
+ * )
+ */</span>
+</code></pre></div><h2 id="reusing-responses" tabindex="-1">Reusing responses <a class="header-anchor" href="#reusing-responses" aria-hidden="true">#</a></h2><p>Global responses are found under <code>/components/responses</code> and can be referenced/shared just like schema definitions (models)</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Response(
+ *   response=&quot;product&quot;,
+ *   description=&quot;All information about a product&quot;,
+ *   @OA\\JsonContent(ref=&quot;#/components/schemas/Product&quot;)
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">ProductResponse</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
+
+ <span class="token comment">// ...</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">ProductController</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * @OA\\Get(
+     *   tags={&quot;Products&quot;},
+     *   path=&quot;/products/{product_id}&quot;,
+     *   @OA\\Response(
+     *       response=&quot;default&quot;,
+     *       ref=&quot;#/components/responses/product&quot;
+     *   )
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getProduct</span><span class="token punctuation">(</span><span class="token variable">$id</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">\`response\` parameter is always required</p><p>Even if referencing a shared response definition, the <code>response</code> parameter is still required.</p></div><h2 id="mediatype" tabindex="-1">mediaType=&quot;<em>/</em>&quot; <a class="header-anchor" href="#mediatype" aria-hidden="true">#</a></h2><p>Using <code>*/*</code> as <code>mediaType</code> is not possible using annotations.</p><p><strong>Example:</strong></p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\MediaType(
+ *     mediaType=&quot;*/</span><span class="token operator">*</span><span class="token string double-quoted-string">&quot;,
+ *     @OA\\Schema(type=&quot;</span><span class="token keyword type-declaration">string</span><span class="token string double-quoted-string">&quot;,format=&quot;</span>binary&quot;<span class="token punctuation">)</span>
+ <span class="token operator">*</span> <span class="token punctuation">)</span>
+ <span class="token operator">*</span><span class="token operator">/</span>
+</code></pre></div><p>The doctrine annotations library used for parsing annotations does not handle this and will interpret the <code>*/</code> bit as the end of the comment.</p><p>Using just <code>*</code> or <code>application/octet-stream</code> might be usable workarounds.</p><h2 id="warning-about-multiple-response-with-same-response-200" tabindex="-1">Warning about <code>Multiple response with same response=&quot;200&quot;</code> <a class="header-anchor" href="#warning-about-multiple-response-with-same-response-200" aria-hidden="true">#</a></h2><p>There are two scenarios where this can happen</p><ol><li>A single endpoint contains two responses with the same <code>response</code> value.</li><li>There are multiple global response declared, again more than one with the same <code>response</code> value.</li></ol><h2 id="callbacks" tabindex="-1">Callbacks <a class="header-anchor" href="#callbacks" aria-hidden="true">#</a></h2><p>The API does include basic support for callbacks. However, this needs to be set up mostly manually.</p><p><strong>Example</strong></p><div class="language-php"><pre><code><span class="token comment">/**
+ *     ...
+ *
+ *     callbacks={
+ *         &quot;onChange&quot;={
+ *              &quot;{$request.query.callbackUrl}&quot;={
+ *                  &quot;post&quot;: {
+ *                      &quot;requestBody&quot;: @OA\\RequestBody(
+ *                          description=&quot;subscription payload&quot;,
+ *                          @OA\\MediaType(mediaType=&quot;application/json&quot;, @OA\\Schema(
+ *                              @OA\\Property(property=&quot;timestamp&quot;, type=&quot;string&quot;, format=&quot;date-time&quot;, description=&quot;time of change&quot;)
+ *                          ))
+ *                      )
+ *                  },
+ *                  &quot;responses&quot;: {
+ *                      &quot;202&quot;: {
+ *                          &quot;description&quot;: &quot;Your server implementation should return this HTTP status code if the data was received successfully&quot;
+ *                      }
+ *                  }
+ *              }
+ *         }
+ *     }
+ *
+ *     ...
+ *
+ */</span>
+</code></pre></div><h2 id="mostly-virtual-models" tabindex="-1">(Mostly) virtual models <a class="header-anchor" href="#mostly-virtual-models" aria-hidden="true">#</a></h2><p>Typically, a model is annotated by adding a <code>@OA\\Schema</code> annotation to the class and then individual <code>@OA\\Property</code> annotations to the individually declared class properties.</p><p>It is possible, however, to nest <code>O@\\Property</code> annotations inside a schema even without properties. In fact, all that is needed is a code anchor - e.g. an empty class.</p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span>
+    <span class="token attribute-class-name class-name">properties</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
+        <span class="token string single-quoted-string">&#39;name&#39;</span> <span class="token operator">=&gt;</span> <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">property</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;name&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;string&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+        <span class="token string single-quoted-string">&#39;email&#39;</span> <span class="token operator">=&gt;</span> <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">property</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;email&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;string&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+    <span class="token punctuation">]</span>
+<span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">User</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
+</code></pre></div><h2 id="using-class-name-as-type-instead-of-references" tabindex="-1">Using class name as type instead of references <a class="header-anchor" href="#using-class-name-as-type-instead-of-references" aria-hidden="true">#</a></h2><p>Typically, when referencing schemas this is done using <code>$ref</code>&#39;s</p><div class="language-php"><pre><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">schema</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;user&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">User</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Book</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * @var User
+     */</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">ref</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;#/components/schemas/user&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token variable">$author</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>This works, but is not very convenient.</p><p>First, when using custom schema names (<code>schema: &#39;user&#39;</code>), this needs to be taken into account everywhere. Secondly, having to write <code>ref: &#39;#/components/schemas/user&#39;</code> is tedious and error-prone.</p><p>Using attributes all this changes as we can take advantage of PHP itself by referring to a schema by its (fully qualified) class name.</p><p>With the same <code>User</code> schema as before, the <code>Book::author</code> property could be written in a few different ways</p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> User author<span class="token punctuation">;</span>
+</code></pre></div><p><strong>or</strong></p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * @var User
+     */</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> author<span class="token punctuation">;</span>
+</code></pre></div><p><strong>or</strong></p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token attribute-class-name class-name">User</span><span class="token operator">::</span><span class="token constant">class</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> author<span class="token punctuation">;</span>
+</code></pre></div><h2 id="enums" tabindex="-1">Enums <a class="header-anchor" href="#enums" aria-hidden="true">#</a></h2><p>As of PHP 8.1 there is native support for <code>enum</code>&#39;s.</p><p><code>swagger-php</code> supports enums in much the same way as class names can be used to reference schemas.</p><p><strong>Example</strong></p><div class="language-php"><pre><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">State</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">OPEN</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">MERGED</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">DECLINED</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">PullRequest</span>
+   <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+   <span class="token keyword">public</span> <span class="token class-name type-declaration">State</span> <span class="token variable">$state</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>However, in this case the schema generated for <code>State</code> will be an enum:</p><div class="language-yaml"><pre><code><span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">PullRequest</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">state</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/State&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">State</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> OPEN
+        <span class="token punctuation">-</span> MERGED
+        <span class="token punctuation">-</span> DECLINED
+</code></pre></div><h2 id="multi-value-query-parameter-q-1-q-1" tabindex="-1">Multi value query parameter: <code>&amp;q[]=1&amp;q[]=1</code> <a class="header-anchor" href="#multi-value-query-parameter-q-1-q-1" aria-hidden="true">#</a></h2><p>PHP allows to have query parameters multiple times in the url and will combine the values to an array if the parameter name uses trailing <code>[]</code>. In fact, it is possible to create nested arrays too by using more than one pair of <code>[]</code>.</p><p>In terms of OpenAPI, the parameters can be considered a single parameter with a list of values.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Get(
+ *     path=&quot;/api/endpoint&quot;,
+ *     description=&quot;The endpoint&quot;,
+ *     operationId=&quot;endpoint&quot;,
+ *     tags={&quot;endpoints&quot;},
+ *     @OA\\Parameter(
+ *         name=&quot;things[]&quot;,
+ *         in=&quot;query&quot;,
+ *         description=&quot;A list of things.&quot;,
+ *         required=false,
+ *         @OA\\Schema(
+ *             type=&quot;array&quot;,
+ *             @OA\\Items(type=&quot;integer&quot;)
+ *         )
+ *     ),
+ *     @OA\\Response(response=&quot;200&quot;, description=&quot;All good&quot;)
+ * )
+ */</span>
+</code></pre></div><p>The corresponding bit of the spec will look like this:</p><div class="language-yaml"><pre><code>      <span class="token key atrule">parameters</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span>
+          <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">&#39;things[]&#39;</span>
+          <span class="token key atrule">in</span><span class="token punctuation">:</span> query
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;A list of things.&#39;</span>
+          <span class="token key atrule">required</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>
+          <span class="token key atrule">schema</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+            <span class="token key atrule">items</span><span class="token punctuation">:</span>
+              <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+</code></pre></div><p><code>swagger-ui</code> will show a form that allows to add/remove items (<code>integer</code> values in this case) to/from a list and post those values as something like <code>?things[]=1&amp;things[]=2&amp;things[]=0</code></p><h2 id="custom-response-classes" tabindex="-1">Custom response classes <a class="header-anchor" href="#custom-response-classes" aria-hidden="true">#</a></h2><p>Even with using refs there is a bit of overhead in sharing responses. One way around that is to write your own response classes. The beauty is that in your custom <code>__construct()</code> method you can prefill as much as you need.</p><p>Best of all, this works for both annotations and attributes.</p><p>Example:</p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @Annotation
+ */</span>
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content">\\<span class="token attribute-class-name class-name">Attribute</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name class-name-fully-qualified"><span class="token punctuation">\\</span>Attribute</span><span class="token operator">::</span><span class="token constant">TARGET_CLASS</span> <span class="token operator">|</span> <span class="token attribute-class-name class-name class-name-fully-qualified"><span class="token punctuation">\\</span>Attribute</span><span class="token operator">::</span><span class="token constant">TARGET_METHOD</span> <span class="token operator">|</span> <span class="token attribute-class-name class-name class-name-fully-qualified"><span class="token punctuation">\\</span>Attribute</span><span class="token operator">::</span><span class="token constant">IS_REPEATABLE</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">BadRequest</span> <span class="token keyword">extends</span> <span class="token class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Response</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">__construct</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+        <span class="token keyword static-context">parent</span><span class="token operator">::</span><span class="token function">__construct</span><span class="token punctuation">(</span><span class="token argument-name">response</span><span class="token punctuation">:</span> <span class="token number">400</span><span class="token punctuation">,</span> <span class="token argument-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;Bad request&#39;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Controller</span>
+<span class="token punctuation">{</span>
+
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/foo&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">responses</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name">BadRequest</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">]</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Post</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/foo&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BadRequest</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">post</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+
+    <span class="token comment">/**
+     * @OA\\Delete(
+     *     path=&quot;/foo&quot;,
+     *     @BadRequest()
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">delete</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">Annotations only?</p><p>If you are only interested in annotations you canleave out the attribute setup line (<code>#[\\Attribute...</code>) for <code>BadRequest</code>.</p><p>Furthermore, your custom annotations should extend from the <code>OpenApi\\Annotations</code> namespace.</p></div><h2 id="annotating-class-constants" tabindex="-1">Annotating class constants <a class="header-anchor" href="#annotating-class-constants" aria-hidden="true">#</a></h2><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Airport</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">property</span><span class="token operator">=</span><span class="token string single-quoted-string">&#39;kind&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">const</span> <span class="token constant">KIND</span> <span class="token operator">=</span> <span class="token string single-quoted-string">&#39;Airport&#39;</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>The <code>const</code> property is supported in OpenApi 3.1.0.</p><div class="language-yaml"><pre><code><span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Airport</span><span class="token punctuation">:</span>
+        <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+          <span class="token key atrule">kind</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+            <span class="token key atrule">const</span><span class="token punctuation">:</span> Airport
+</code></pre></div><p>For 3.0.0 this is serialized into a single value <code>enum</code>.</p><div class="language-yaml"><pre><code><span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Airport</span><span class="token punctuation">:</span>
+        <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+          <span class="token key atrule">kind</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+            <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+              <span class="token punctuation">-</span> Airport
+</code></pre></div>`,65);function h(y,q,g,f,b,A){const t=u("codeblock");return l(),p("div",null,[r,c(t,{id:"minimal"},{at:a(()=>[d]),an:a(()=>[k]),_:1}),m])}var w=o(i,[["render",h]]);export{O as __pageData,w as default};
diff --git a/assets/guide_cookbook.md.2d416869.lean.js b/assets/guide_cookbook.md.2d416869.lean.js
new file mode 100644
index 00000000..96dc2d0d
--- /dev/null
+++ b/assets/guide_cookbook.md.2d416869.lean.js
@@ -0,0 +1,38 @@
+import{_ as o,c as p,b as c,w as a,a as e,r as u,o as l,d as n,e as s}from"./app.850f5e05.js";const O='{"title":"Cookbook","description":"","frontmatter":{},"headers":[{"level":2,"title":"x-tagGroups","slug":"x-taggroups"},{"level":2,"title":"Adding examples to @OA\\\\Response","slug":"adding-examples-to-oa-response"},{"level":2,"title":"External documentation","slug":"external-documentation"},{"level":2,"title":"Properties with union types","slug":"properties-with-union-types"},{"level":2,"title":"Referencing a security scheme","slug":"referencing-a-security-scheme"},{"level":2,"title":"File upload with headers","slug":"file-upload-with-headers"},{"level":2,"title":"Set the XML root name","slug":"set-the-xml-root-name"},{"level":2,"title":"upload multipart/form-data","slug":"upload-multipart-form-data"},{"level":2,"title":"Default security scheme for all endpoints","slug":"default-security-scheme-for-all-endpoints"},{"level":2,"title":"Nested objects","slug":"nested-objects"},{"level":2,"title":"Documenting union type response data using oneOf","slug":"documenting-union-type-response-data-using-oneof"},{"level":2,"title":"Reusing responses","slug":"reusing-responses"},{"level":2,"title":"mediaType=\\"/\\"","slug":"mediatype"},{"level":2,"title":"Warning about Multiple response with same response=\\"200\\"","slug":"warning-about-multiple-response-with-same-response-200"},{"level":2,"title":"Callbacks","slug":"callbacks"},{"level":2,"title":"(Mostly) virtual models","slug":"mostly-virtual-models"},{"level":2,"title":"Using class name as type instead of references","slug":"using-class-name-as-type-instead-of-references"},{"level":2,"title":"Enums","slug":"enums"},{"level":2,"title":"Multi value query parameter: &q[]=1&q[]=1","slug":"multi-value-query-parameter-q-1-q-1"},{"level":2,"title":"Custom response classes","slug":"custom-response-classes"},{"level":2,"title":"Annotating class constants","slug":"annotating-class-constants"}],"relativePath":"guide/cookbook.md"}',i={},r=e("",32),d=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Attributes")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OAT"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OAT"),n("span",{class:"token punctuation"},"\\"),s("OpenApi")]),n("span",{class:"token punctuation"},"("),s(`
+    `),n("span",{class:"token attribute-class-name class-name"},"security"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"["),n("span",{class:"token string single-quoted-string"},"'bearerAuth'"),s(),n("span",{class:"token operator"},"=>"),s(),n("span",{class:"token punctuation"},"["),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},"]"),n("span",{class:"token punctuation"},"]"),s(`
+`),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OAT"),n("span",{class:"token punctuation"},"\\"),s("Components")]),n("span",{class:"token punctuation"},"("),s(`
+    `),n("span",{class:"token attribute-class-name class-name"},"securitySchemes"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token punctuation"},"["),s(`
+        `),n("span",{class:"token attribute-class-name class-name"},"new"),s(),n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OAT"),n("span",{class:"token punctuation"},"\\"),s("SecurityScheme")]),n("span",{class:"token punctuation"},"("),s(`
+            `),n("span",{class:"token attribute-class-name class-name"},"securityScheme"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'bearerAuth'"),n("span",{class:"token punctuation"},","),s(`
+            `),n("span",{class:"token attribute-class-name class-name"},"type"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'http'"),n("span",{class:"token punctuation"},","),s(`
+            `),n("span",{class:"token attribute-class-name class-name"},"scheme"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'bearer'"),s(`
+        `),n("span",{class:"token punctuation"},")"),s(`
+    `),n("span",{class:"token punctuation"},"]"),s(`
+`),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApiSpec"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),k=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Annotations")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token comment"},`/**
+ * @OA\\OpenApi(
+ *   security={{"bearerAuth": {}}}
+ * )
+ *
+ * @OA\\SecurityScheme(
+ *   securityScheme="bearerAuth",
+ *   type="http",
+ *   scheme="bearer"
+ * )
+ */`),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApiSpec"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),m=e("",65);function h(y,q,g,f,b,A){const t=u("codeblock");return l(),p("div",null,[r,c(t,{id:"minimal"},{at:a(()=>[d]),an:a(()=>[k]),_:1}),m])}var w=o(i,[["render",h]]);export{O as __pageData,w as default};
diff --git a/assets/guide_faq.md.b1f45c64.js b/assets/guide_faq.md.b1f45c64.js
new file mode 100644
index 00000000..e148b439
--- /dev/null
+++ b/assets/guide_faq.md.b1f45c64.js
@@ -0,0 +1,88 @@
+import{_ as n,c as e,o as a,a as s}from"./app.850f5e05.js";const k='{"title":"FAQ","description":"","frontmatter":{},"headers":[{"level":2,"title":"Warning: Required @OA\\\\Info() not found","slug":"warning-required-oa-info-not-found"},{"level":2,"title":"Annotations missing","slug":"annotations-missing"},{"level":2,"title":"Skipping unknown \\\\SomeClass","slug":"skipping-unknown-someclass"},{"level":3,"title":"Using the -b --bootstrap option","slug":"using-the-b-bootstrap-option"},{"level":3,"title":"Namespace mismatch","slug":"namespace-mismatch"},{"level":2,"title":"No output from openapi command line tool","slug":"no-output-from-openapi-command-line-tool"}],"relativePath":"guide/faq.md"}',t={},o=s(`<h1 id="faq" tabindex="-1">FAQ <a class="header-anchor" href="#faq" aria-hidden="true">#</a></h1><h2 id="warning-required-oa-info-not-found" tabindex="-1">Warning: Required <code>@OA\\Info()</code> not found <a class="header-anchor" href="#warning-required-oa-info-not-found" aria-hidden="true">#</a></h2><p>With adding support for <a href="https://www.php.net/manual/en/language.attributes.php" target="_blank" rel="noopener noreferrer">PHP attributes</a> in version 4, some architectural changes had to be made.</p><p>One of those changes is that placing annotations in your source files is now subject to the same limitations as attributes. These limits are dictated by the PHP reflection API, specifically where it provides access to attributes and doc comments.</p><p>This means stand-alone annotations are no longer supported and ignored as <code>swagger-php</code> cannot <em>&quot;see&quot;</em> them any more.</p><p>Supported locations:</p><ul><li>class</li><li>interface</li><li>trait</li><li>method</li><li>property</li><li>class/interface const</li></ul><p>Most commonly this manifests with a warning about the required <code>@OA\\Info</code> not being found. While most annotations have specific related code, the info annotation (and a few more) is kind of global.</p><p>The simplest solution to avoid this issue is to add a &#39;dummy&#39; class to the docblock and add all &#39;global&#39; annotations (e.g. <code>Tag</code>, <code>Server</code>, <code>SecurityScheme</code>, etc.) <strong>in a single docblock</strong> to that class.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\\Tag(
+ *     name=&quot;user&quot;,
+ *     description=&quot;User related operations&quot;
+ * )
+ * @OA\\Info(
+ *     version=&quot;1.0&quot;,
+ *     title=&quot;Example API&quot;,
+ *     description=&quot;Example info&quot;,
+ *     @OA\\Contact(name=&quot;Swagger API Team&quot;)
+ * )
+ * @OA\\Server(
+ *     url=&quot;https://example.localhost&quot;,
+ *     description=&quot;API server&quot;
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>As of version 4.8 the <code>doctrine/annotations</code> library is optional and might cause the same message.</strong></p><p>If this is the case, <code>doctrine annotations</code> must be installed separately:</p><div class="language-shell"><pre><code><span class="token function">composer</span> require doctrine/annotations
+</code></pre></div><h2 id="annotations-missing" tabindex="-1">Annotations missing <a class="header-anchor" href="#annotations-missing" aria-hidden="true">#</a></h2><p>Another side effect of using reflection is that <code>swagger-php</code> <em>&quot;can&#39;t see&quot;</em> multiple consecutive docblocks any more as the PHP reflection API only provides access to the docblock closest to a given structural element.</p><div class="language-php"><pre><code><span class="token keyword">class</span> <span class="token class-name-definition class-name">Controller</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * @OA\\Delete(
+     *      path=&quot;/api/v0.0.2/notifications/{id}&quot;,
+     *      operationId=&quot;deleteNotificationById&quot;,
+     *      summary=&quot;Delete notification by ID&quot;,
+     *      @OA\\Parameter(name=&quot;id&quot;, in=&quot;path&quot;, @OA\\Schema(type=&quot;integer&quot;)),
+     *      @OA\\Response(response=200, description=&quot;OK&quot;),
+     *      @OA\\Response(response=400, description=&quot;Bad Request&quot;)
+     * )
+     */</span>
+    <span class="token comment">/**
+     * Delete notification by ID.
+     *
+     * @param Request $request
+     * @param AppNotification $notification
+     *
+     * @return Response
+     * @throws Exception
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">destroy</span><span class="token punctuation">(</span><span class="token class-name type-declaration">Request</span> <span class="token variable">$request</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">AppNotification</span> <span class="token variable">$notification</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token comment">//</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>In this case the simplest solution is to merge both docblocks. As an additional benefit the duplication of the summary can be avoided.</p><p>In this improved version <code>swagger-php</code> will automatically use the docblock summary just as explicitly done above.</p><div class="language-php"><pre><code><span class="token keyword">class</span> <span class="token class-name-definition class-name">Controller</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * Delete notification by ID.
+     *
+     * @OA\\Delete(
+     *      path=&quot;/api/v0.0.2/notifications/{id}&quot;,
+     *      operationId=&quot;deleteNotificationById&quot;,
+     *      @OA\\Parameter(name=&quot;id&quot;, in=&quot;path&quot;, @OA\\Schema(type=&quot;integer&quot;)),
+     *      @OA\\Response(response=200, description=&quot;OK&quot;),
+     *      @OA\\Response(response=400, description=&quot;Bad Request&quot;)
+     * )
+     *
+     * @param Request $request
+     * @param AppNotification $notification
+     *
+     * @return Response
+     * @throws Exception
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">destroy</span><span class="token punctuation">(</span><span class="token class-name type-declaration">Request</span> <span class="token variable">$request</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">AppNotification</span> <span class="token variable">$notification</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token comment">//</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Resulting spec:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">paths</span><span class="token punctuation">:</span>
+  <span class="token key atrule">&#39;/api/v0.0.2/notifications/{id}&#39;</span><span class="token punctuation">:</span>
+    <span class="token key atrule">delete</span><span class="token punctuation">:</span>
+      <span class="token key atrule">summary</span><span class="token punctuation">:</span> <span class="token string">&#39;XDelete notification by ID.&#39;</span>
+      <span class="token key atrule">operationId</span><span class="token punctuation">:</span> deleteNotificationById
+      <span class="token key atrule">parameters</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span>
+          <span class="token key atrule">name</span><span class="token punctuation">:</span> id
+          <span class="token key atrule">in</span><span class="token punctuation">:</span> path
+          <span class="token key atrule">schema</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+      <span class="token key atrule">responses</span><span class="token punctuation">:</span>
+        <span class="token key atrule">&#39;200&#39;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> OK
+        <span class="token key atrule">&#39;400&#39;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;Bad Request&#39;</span>
+
+</code></pre></div><h2 id="skipping-unknown-someclass" tabindex="-1">Skipping unknown <code>\\SomeClass</code> <a class="header-anchor" href="#skipping-unknown-someclass" aria-hidden="true">#</a></h2><p>This message means that <code>swagger-php</code> has tried to use reflection to inspect <code>\\SomeClass</code> and that PHP could not find/load that class. Effectively, this means that <code>class_exists(&quot;\\SomeClass&quot;)</code> returns <code>false</code>.</p><h3 id="using-the-b-bootstrap-option" tabindex="-1">Using the <code>-b</code> <code>--bootstrap</code> option <a class="header-anchor" href="#using-the-b-bootstrap-option" aria-hidden="true">#</a></h3><p>There are a number of reasons why this could happen. If you are using the <code>openapi</code> command line tool from a global installation typically the application classloader (composer) is not active. With you application root being <code>myapp</code> you could try:</p><div class="language-shell"><pre><code>openapi <span class="token parameter variable">-b</span> myapp/vendor/autoload.php myapp/src
+</code></pre></div><p>The <code>-b</code> allows to execute some extra PHP code to load whatever is needed to register your apps classloader with PHP.</p><h3 id="namespace-mismatch" tabindex="-1">Namespace mismatch <a class="header-anchor" href="#namespace-mismatch" aria-hidden="true">#</a></h3><p>Another reason for this error could be that your class actually has the wrong namespace (or no namespace at all!).</p><p>Depending on your framework this might still work in the context of your app, but the composer autoloader alone might not be able to load your class (assuming you are using composer).</p><h2 id="no-output-from-openapi-command-line-tool" tabindex="-1">No output from <code>openapi</code> command line tool <a class="header-anchor" href="#no-output-from-openapi-command-line-tool" aria-hidden="true">#</a></h2><p>Depending on your PHP configuration, running the <code>openapi</code> command line tool might result in no output at all.</p><p>The reason for this is that <code>openapi</code> currently uses the <a href="https://www.php.net/manual/en/function.error-log.php" target="_blank" rel="noopener noreferrer"><code>error_log</code></a> function for all output.</p><p>So if this is configured to write to a file, then it will seem like the command is broken.</p>`,34),i=[o];function p(c,l,r,u,d,h){return a(),e("div",null,i)}var f=n(t,[["render",p]]);export{k as __pageData,f as default};
diff --git a/assets/guide_faq.md.b1f45c64.lean.js b/assets/guide_faq.md.b1f45c64.lean.js
new file mode 100644
index 00000000..bd3ee232
--- /dev/null
+++ b/assets/guide_faq.md.b1f45c64.lean.js
@@ -0,0 +1 @@
+import{_ as n,c as e,o as a,a as s}from"./app.850f5e05.js";const k='{"title":"FAQ","description":"","frontmatter":{},"headers":[{"level":2,"title":"Warning: Required @OA\\\\Info() not found","slug":"warning-required-oa-info-not-found"},{"level":2,"title":"Annotations missing","slug":"annotations-missing"},{"level":2,"title":"Skipping unknown \\\\SomeClass","slug":"skipping-unknown-someclass"},{"level":3,"title":"Using the -b --bootstrap option","slug":"using-the-b-bootstrap-option"},{"level":3,"title":"Namespace mismatch","slug":"namespace-mismatch"},{"level":2,"title":"No output from openapi command line tool","slug":"no-output-from-openapi-command-line-tool"}],"relativePath":"guide/faq.md"}',t={},o=s("",34),i=[o];function p(c,l,r,u,d,h){return a(),e("div",null,i)}var f=n(t,[["render",p]]);export{k as __pageData,f as default};
diff --git a/assets/guide_generating-openapi-documents.md.9bb1fdd6.js b/assets/guide_generating-openapi-documents.md.9bb1fdd6.js
new file mode 100644
index 00000000..2ae51bc6
--- /dev/null
+++ b/assets/guide_generating-openapi-documents.md.9bb1fdd6.js
@@ -0,0 +1,30 @@
+import{_ as a,c as n,o as s,a as e}from"./app.850f5e05.js";const m='{"title":"Generating OpenAPI documents","description":"","frontmatter":{},"headers":[{"level":2,"title":"./bin/openapi","slug":"bin-openapi"},{"level":2,"title":"Using PHP","slug":"using-php"}],"relativePath":"guide/generating-openapi-documents.md"}',t={},p=e(`<h1 id="generating-openapi-documents" tabindex="-1">Generating OpenAPI documents <a class="header-anchor" href="#generating-openapi-documents" aria-hidden="true">#</a></h1><h2 id="bin-openapi" tabindex="-1"><code>./bin/openapi</code> <a class="header-anchor" href="#bin-openapi" aria-hidden="true">#</a></h2><p><code>swagger-php</code> includes a command line tool <code>./bin/openapi</code>. This can be used to generate OpenAPI documents.</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./vendor/bin/openapi app <span class="token parameter variable">-o</span> openapi.yaml
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">Output Format</p><p>By default the output format is YAML. If a filename is given (via <code>--output</code> or <code>-o</code>) the tool will use the file extension to determine the format.</p><p>The <code>--format</code> option can be used to force a specific format.</p></div><p>For a list of all available options use the <code>-h</code> option</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./bin/openapi <span class="token parameter variable">-h</span>
+
+Usage: openapi <span class="token punctuation">[</span>--option value<span class="token punctuation">]</span> <span class="token punctuation">[</span>/path/to/project <span class="token punctuation">..</span>.<span class="token punctuation">]</span>
+
+Options:
+  <span class="token parameter variable">--config</span> <span class="token punctuation">(</span>-c<span class="token punctuation">)</span>     Generator config
+                    ex: <span class="token parameter variable">-c</span> <span class="token assign-left variable">operationId.hash</span><span class="token operator">=</span>false
+  <span class="token parameter variable">--legacy</span> <span class="token punctuation">(</span>-l<span class="token punctuation">)</span>     Use legacy TokenAnalyser<span class="token punctuation">;</span> default is the new ReflectionAnalyser
+  <span class="token parameter variable">--output</span> <span class="token punctuation">(</span>-o<span class="token punctuation">)</span>     Path to store the generated documentation.
+                    ex: <span class="token parameter variable">--output</span> openapi.yaml
+  <span class="token parameter variable">--exclude</span> <span class="token punctuation">(</span>-e<span class="token punctuation">)</span>    Exclude path<span class="token punctuation">(</span>s<span class="token punctuation">)</span>.
+                    ex: <span class="token parameter variable">--exclude</span> vendor,library/Zend
+  <span class="token parameter variable">--pattern</span> <span class="token punctuation">(</span>-n<span class="token punctuation">)</span>    Pattern of files to scan.
+                    ex: <span class="token parameter variable">--pattern</span> <span class="token string">&quot;*.php&quot;</span> or <span class="token parameter variable">--pattern</span> <span class="token string">&quot;/\\.(phps|php)$/&quot;</span>
+  <span class="token parameter variable">--bootstrap</span> <span class="token punctuation">(</span>-b<span class="token punctuation">)</span>  Bootstrap a php <span class="token function">file</span> <span class="token keyword">for</span> defining constants, etc.
+                    ex: <span class="token parameter variable">--bootstrap</span> config/constants.php
+  <span class="token parameter variable">--processor</span> <span class="token punctuation">(</span>-p<span class="token punctuation">)</span>  Register an additional processor.
+  <span class="token parameter variable">--format</span> <span class="token punctuation">(</span>-f<span class="token punctuation">)</span>     Force yaml or json.
+  <span class="token parameter variable">--debug</span> <span class="token punctuation">(</span>-d<span class="token punctuation">)</span>      Show additional error information.
+  <span class="token parameter variable">--version</span>         The OpenAPI version<span class="token punctuation">;</span> defaults to <span class="token number">3.0</span>.0.
+  <span class="token parameter variable">--help</span> <span class="token punctuation">(</span>-h<span class="token punctuation">)</span>       Display this <span class="token builtin class-name">help</span> message.
+</code></pre></div><h2 id="using-php" tabindex="-1">Using PHP <a class="header-anchor" href="#using-php" aria-hidden="true">#</a></h2><p>Depending on your use case PHP code can also be used to generate OpenAPI documents in a more dynamic way.</p><p>In its simplest form this may look something like</p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+<span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Generator</span><span class="token operator">::</span><span class="token function">scan</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path/to/project&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token function">header</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;Content-Type: application/x-yaml&#39;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+<span class="token keyword">echo</span> <span class="token variable">$openapi</span><span class="token operator">-&gt;</span><span class="token function">toYaml</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</span></code></pre></div><div class="tip custom-block"><p class="custom-block-title">Programming API</p><p>Details about the <code>swagger-php</code> API can be found in the <a href="./../reference/">reference</a>.</p></div>`,12),o=[p];function c(i,l,r,u,d,k){return s(),n("div",null,o)}var g=a(t,[["render",c]]);export{m as __pageData,g as default};
diff --git a/assets/guide_generating-openapi-documents.md.9bb1fdd6.lean.js b/assets/guide_generating-openapi-documents.md.9bb1fdd6.lean.js
new file mode 100644
index 00000000..888f4a9c
--- /dev/null
+++ b/assets/guide_generating-openapi-documents.md.9bb1fdd6.lean.js
@@ -0,0 +1 @@
+import{_ as a,c as n,o as s,a as e}from"./app.850f5e05.js";const m='{"title":"Generating OpenAPI documents","description":"","frontmatter":{},"headers":[{"level":2,"title":"./bin/openapi","slug":"bin-openapi"},{"level":2,"title":"Using PHP","slug":"using-php"}],"relativePath":"guide/generating-openapi-documents.md"}',t={},p=e("",12),o=[p];function c(i,l,r,u,d,k){return s(),n("div",null,o)}var g=a(t,[["render",c]]);export{m as __pageData,g as default};
diff --git a/assets/guide_index.md.29bf901a.js b/assets/guide_index.md.29bf901a.js
new file mode 100644
index 00000000..a107b24b
--- /dev/null
+++ b/assets/guide_index.md.29bf901a.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o as a,a as o}from"./app.850f5e05.js";const m='{"title":"What is Swagger-PHP?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/index.md"}',n={},s=o('<h1 id="what-is-swagger-php" tabindex="-1">What is Swagger-PHP? <a class="header-anchor" href="#what-is-swagger-php" aria-hidden="true">#</a></h1><p><code>swagger-php</code> is a library that extracts API metadata from your PHP source code files.</p><p>The idea is to add <code>swagger-php</code> <a href="./annotations.html">annotations</a> or <a href="./attributes.html">attributes</a> next to the relevant PHP code in your application. These will contain the details about your API and <code>swagger-php</code> will convert those into machine-readable <a href="https://spec.openapis.org/oas/v3.1.0.html" target="_blank" rel="noopener noreferrer">OpenAPI documentation</a>.</p><p>By adding your API documentation next to the corresponding source code (same file!) makes it easy to keep it up-to-date as all details can be modified in one place.</p><div class="tip custom-block"><p class="custom-block-title">Annotating vs. Annotations</p><p>When talking about annotating your code we mean the act of adding meta-data to your codebase. This can be done by either adding <a href="./annotations.html"><code>Annotations</code></a> or <a href="./attributes.html"><code>Attributes</code></a>.</p></div><div class="warning custom-block"><p class="custom-block-title">Requirements</p><p>Using <code>swagger-php</code> requires a minimum of <strong>PHP\xA07.2</strong> for using annotations and at least <strong>PHP\xA08.1</strong> to use attributes.</p></div>',6),i=[s];function r(c,d,p,h,l,g){return a(),t("div",null,i)}var _=e(n,[["render",r]]);export{m as __pageData,_ as default};
diff --git a/assets/guide_index.md.29bf901a.lean.js b/assets/guide_index.md.29bf901a.lean.js
new file mode 100644
index 00000000..04b522b3
--- /dev/null
+++ b/assets/guide_index.md.29bf901a.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o as a,a as o}from"./app.850f5e05.js";const m='{"title":"What is Swagger-PHP?","description":"","frontmatter":{},"headers":[],"relativePath":"guide/index.md"}',n={},s=o("",6),i=[s];function r(c,d,p,h,l,g){return a(),t("div",null,i)}var _=e(n,[["render",r]]);export{m as __pageData,_ as default};
diff --git a/assets/guide_installation.md.34074778.js b/assets/guide_installation.md.34074778.js
new file mode 100644
index 00000000..4392067d
--- /dev/null
+++ b/assets/guide_installation.md.34074778.js
@@ -0,0 +1,3 @@
+import{_ as e,c as a,o,a as t}from"./app.850f5e05.js";const u='{"title":"Installation","description":"","frontmatter":{},"headers":[{"level":2,"title":"Per project","slug":"per-project"},{"level":2,"title":"Globally","slug":"globally"}],"relativePath":"guide/installation.md"}',r={},l=t(`<h1 id="installation" tabindex="-1">Installation <a class="header-anchor" href="#installation" aria-hidden="true">#</a></h1><h2 id="per-project" tabindex="-1">Per project <a class="header-anchor" href="#per-project" aria-hidden="true">#</a></h2><p>We recommend adding <code>swagger-php</code> to your project using <a href="https://getcomposer.org" target="_blank" rel="noopener noreferrer">Composer</a></p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> <span class="token function">composer</span> require zircote/swagger-php
+</code></pre></div><h2 id="globally" tabindex="-1">Globally <a class="header-anchor" href="#globally" aria-hidden="true">#</a></h2><p>Alternatively, use the composer <code>global</code> argument to install <code>swagger-php</code> globally.</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> <span class="token function">composer</span> global require zircote/swagger-php
+</code></pre></div><div class="warning custom-block"><p class="custom-block-title">PATH variables</p><p>Remember to add the <code>~/.composer/vendor/bin</code> directory to the PATH in your environment.</p></div>`,8),s=[l];function n(c,i,p,d,h,g){return o(),a("div",null,s)}var m=e(r,[["render",n]]);export{u as __pageData,m as default};
diff --git a/assets/guide_installation.md.34074778.lean.js b/assets/guide_installation.md.34074778.lean.js
new file mode 100644
index 00000000..d7ffffb5
--- /dev/null
+++ b/assets/guide_installation.md.34074778.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as a,o,a as t}from"./app.850f5e05.js";const u='{"title":"Installation","description":"","frontmatter":{},"headers":[{"level":2,"title":"Per project","slug":"per-project"},{"level":2,"title":"Globally","slug":"globally"}],"relativePath":"guide/installation.md"}',r={},l=t("",8),s=[l];function n(c,i,p,d,h,g){return o(),a("div",null,s)}var m=e(r,[["render",n]]);export{u as __pageData,m as default};
diff --git a/assets/guide_migrating-to-v3.md.549bb338.js b/assets/guide_migrating-to-v3.md.549bb338.js
new file mode 100644
index 00000000..a9fe0188
--- /dev/null
+++ b/assets/guide_migrating-to-v3.md.549bb338.js
@@ -0,0 +1 @@
+import{_ as e,c as a,o as t,a as o}from"./app.850f5e05.js";const u='{"title":"Migrating to v3","description":"","frontmatter":{},"headers":[{"level":2,"title":"The default output changed from json to yaml","slug":"the-default-output-changed-from-json-to-yaml"},{"level":2,"title":"Updated CLI","slug":"updated-cli"},{"level":2,"title":"Changed annotations","slug":"changed-annotations"},{"level":3,"title":"SWG is renamed to OA","slug":"swg-is-renamed-to-oa"},{"level":3,"title":"@SWG\\\\Swagger() is renamed to @OA\\\\OpenApi()","slug":"swg-swagger-is-renamed-to-oa-openapi"},{"level":3,"title":"@SWG\\\\Path() is renamed to @OA\\\\PathItem()","slug":"swg-path-is-renamed-to-oa-pathitem"},{"level":3,"title":"@SWG\\\\Definition() is removed","slug":"swg-definition-is-removed"},{"level":3,"title":"@SWG\\\\Path is removed","slug":"swg-path-is-removed"},{"level":3,"title":"Consumes, produces field is removed from OpenAPI specification","slug":"consumes-produces-field-is-removed-from-openapi-specification"},{"level":3,"title":"Rename parameter references","slug":"rename-parameter-references"},{"level":3,"title":"Rename response references","slug":"rename-response-references"},{"level":3,"title":"Renamed cli","slug":"renamed-cli"},{"level":3,"title":"More details about differences:","slug":"more-details-about-differences"}],"relativePath":"guide/migrating-to-v3.md"}',r={},i=o('<h1 id="migrating-to-v3" tabindex="-1">Migrating to v3 <a class="header-anchor" href="#migrating-to-v3" aria-hidden="true">#</a></h1><p>Swagger-PHP 3.x generates an openapi.json file that follows the <a href="https://github.com/OAI/OpenAPI-Specification" target="_blank" rel="noopener noreferrer">OpenAPI Version 3.0.x Specification</a>.</p><p>If you need to output the older 2.x specification use OpenApi-php 2.x</p><h2 id="the-default-output-changed-from-json-to-yaml" tabindex="-1">The default output changed from json to yaml <a class="header-anchor" href="#the-default-output-changed-from-json-to-yaml" aria-hidden="true">#</a></h2><p>This aligns better with the direction of the swagger documentation and examples. Annotations can&#39;t be used as string anymore, you&#39;ll need to call <code>toYaml()</code> or <code>toJson()</code> if you prefer the json format.</p><h2 id="updated-cli" tabindex="-1">Updated CLI <a class="header-anchor" href="#updated-cli" aria-hidden="true">#</a></h2><ul><li>Added colors</li><li>No output for successful execution (Removed summary)</li><li>non-zero exit when an error occurred.</li><li>Defaults to yaml</li><li>Defaults to stdout. To save to openapi.yaml use <code>-o</code> or <code>&gt;</code></li></ul><h2 id="changed-annotations" tabindex="-1">Changed annotations <a class="header-anchor" href="#changed-annotations" aria-hidden="true">#</a></h2><h3 id="swg-is-renamed-to-oa" tabindex="-1">SWG is renamed to OA <a class="header-anchor" href="#swg-is-renamed-to-oa" aria-hidden="true">#</a></h3><p>The namespace is renamed from SWG (Swagger) to OA (OpenApi)</p><h3 id="swg-swagger-is-renamed-to-oa-openapi" tabindex="-1">@SWG\\Swagger() is renamed to @OA\\OpenApi() <a class="header-anchor" href="#swg-swagger-is-renamed-to-oa-openapi" aria-hidden="true">#</a></h3><h3 id="swg-path-is-renamed-to-oa-pathitem" tabindex="-1">@SWG\\Path() is renamed to @OA\\PathItem() <a class="header-anchor" href="#swg-path-is-renamed-to-oa-pathitem" aria-hidden="true">#</a></h3><p>The specification uses the term &quot;Path Item Object&quot;, updated the annotation to reflect that.</p><h3 id="swg-definition-is-removed" tabindex="-1">@SWG\\Definition() is removed <a class="header-anchor" href="#swg-definition-is-removed" aria-hidden="true">#</a></h3><p>Use @OA\\Schema() instead of @OA\\Definition() and update the references from &quot;#/definitions/something&quot; to &quot;#/components/schemas/something&quot;.</p><h3 id="swg-path-is-removed" tabindex="-1">@SWG\\Path is removed <a class="header-anchor" href="#swg-path-is-removed" aria-hidden="true">#</a></h3><p>Use @OA\\PathItem instead of @SWG\\Path and update references.</p><h3 id="consumes-produces-field-is-removed-from-openapi-specification" tabindex="-1">Consumes, produces field is removed from OpenAPI specification <a class="header-anchor" href="#consumes-produces-field-is-removed-from-openapi-specification" aria-hidden="true">#</a></h3><p>Use @OA\\MediaType to set data format.</p><h3 id="rename-parameter-references" tabindex="-1">Rename parameter references <a class="header-anchor" href="#rename-parameter-references" aria-hidden="true">#</a></h3><p>Rename <code>#/parameters/{parameter_name}</code> to <code>#/components/parameters/{parameter_name}</code></p><h3 id="rename-response-references" tabindex="-1">Rename response references <a class="header-anchor" href="#rename-response-references" aria-hidden="true">#</a></h3><p>Rename <code>#/responses/{response}</code> to <code>#/components/responses/{response}</code></p><h3 id="renamed-cli" tabindex="-1">Renamed cli <a class="header-anchor" href="#renamed-cli" aria-hidden="true">#</a></h3><p>Renamed swagger to openapi</p><h3 id="more-details-about-differences" tabindex="-1">More details about differences: <a class="header-anchor" href="#more-details-about-differences" aria-hidden="true">#</a></h3><p><a href="https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/" target="_blank" rel="noopener noreferrer">A Visual Guide to What&#39;s New in Swagger 3.0</a></p>',27),n=[i];function s(d,h,l,c,p,m){return t(),a("div",null,n)}var g=e(r,[["render",s]]);export{u as __pageData,g as default};
diff --git a/assets/guide_migrating-to-v3.md.549bb338.lean.js b/assets/guide_migrating-to-v3.md.549bb338.lean.js
new file mode 100644
index 00000000..811c6f3e
--- /dev/null
+++ b/assets/guide_migrating-to-v3.md.549bb338.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as a,o as t,a as o}from"./app.850f5e05.js";const u='{"title":"Migrating to v3","description":"","frontmatter":{},"headers":[{"level":2,"title":"The default output changed from json to yaml","slug":"the-default-output-changed-from-json-to-yaml"},{"level":2,"title":"Updated CLI","slug":"updated-cli"},{"level":2,"title":"Changed annotations","slug":"changed-annotations"},{"level":3,"title":"SWG is renamed to OA","slug":"swg-is-renamed-to-oa"},{"level":3,"title":"@SWG\\\\Swagger() is renamed to @OA\\\\OpenApi()","slug":"swg-swagger-is-renamed-to-oa-openapi"},{"level":3,"title":"@SWG\\\\Path() is renamed to @OA\\\\PathItem()","slug":"swg-path-is-renamed-to-oa-pathitem"},{"level":3,"title":"@SWG\\\\Definition() is removed","slug":"swg-definition-is-removed"},{"level":3,"title":"@SWG\\\\Path is removed","slug":"swg-path-is-removed"},{"level":3,"title":"Consumes, produces field is removed from OpenAPI specification","slug":"consumes-produces-field-is-removed-from-openapi-specification"},{"level":3,"title":"Rename parameter references","slug":"rename-parameter-references"},{"level":3,"title":"Rename response references","slug":"rename-response-references"},{"level":3,"title":"Renamed cli","slug":"renamed-cli"},{"level":3,"title":"More details about differences:","slug":"more-details-about-differences"}],"relativePath":"guide/migrating-to-v3.md"}',r={},i=o("",27),n=[i];function s(d,h,l,c,p,m){return t(),a("div",null,n)}var g=e(r,[["render",s]]);export{u as __pageData,g as default};
diff --git a/assets/guide_migrating-to-v4.md.714a0f1b.js b/assets/guide_migrating-to-v4.md.714a0f1b.js
new file mode 100644
index 00000000..85b879be
--- /dev/null
+++ b/assets/guide_migrating-to-v4.md.714a0f1b.js
@@ -0,0 +1,48 @@
+import{_ as a,c as n,o as s,a as e}from"./app.850f5e05.js";const m='{"title":"Migrating to v4","description":"","frontmatter":{},"headers":[{"level":2,"title":"Overview","slug":"overview"},{"level":2,"title":"Annotations as PHP attributes","slug":"annotations-as-php-attributes"},{"level":3,"title":"Using annotations","slug":"using-annotations"},{"level":3,"title":"Using attributes","slug":"using-attributes"},{"level":2,"title":"Optional nesting","slug":"optional-nesting"},{"level":2,"title":"Annotations must be associated with a structural element","slug":"annotations-must-be-associated-with-a-structural-element"},{"level":2,"title":"The PathParameter annotation","slug":"the-pathparameter-annotation"},{"level":2,"title":"The Attachable annotation","slug":"the-attachable-annotation"},{"level":2,"title":"Removed deprecated elements","slug":"removed-deprecated-elements"},{"level":3,"title":"\\\\Openapi\\\\Analysis::processors()","slug":"openapi-analysis-processors"},{"level":3,"title":"\\\\Openapi\\\\Analyser::$whitelist","slug":"openapi-analyser-whitelist"},{"level":3,"title":"\\\\Openapi\\\\Analyser::$defaultImports","slug":"openapi-analyser-defaultimports"},{"level":3,"title":"\\\\Openapi\\\\Logger","slug":"openapi-logger"},{"level":2,"title":"Improvements to the Generator class","slug":"improvements-to-the-generator-class"}],"relativePath":"guide/migrating-to-v4.md"}',t={},o=e(`<h1 id="migrating-to-v4" tabindex="-1">Migrating to v4 <a class="header-anchor" href="#migrating-to-v4" aria-hidden="true">#</a></h1><h2 id="overview" tabindex="-1">Overview <a class="header-anchor" href="#overview" aria-hidden="true">#</a></h2><ul><li>As of PHP 8.1 annotations may be used as <a href="https://www.php.net/manual/en/language.attributes.overview.php" target="_blank" rel="noopener noreferrer">PHP attributes</a> instead. That means all references to annotations in this document also apply to attributes.</li><li>If you haven&#39;t switched to attributes yet, the Doctrine annotations library must be installed manually: <code>composer require doctrine/annotations</code></li><li>Annotations now <strong>must be</strong> associated with a structural element (class, trait, interface), a method, property or const.</li><li>A new annotation <code>PathParameter</code> was added for improved framework support.</li><li>A new annotation <code>Attachable</code> was added to simplify custom processing. <code>Attachable</code> can be used to attach arbitrary data to any given annotation.</li><li>Deprecated elements have been removed <ul><li><code>\\Openapi\\Analysis::processors()</code></li><li><code>\\Openapi\\Analyser::$whitelist</code></li><li><code>\\Openapi\\Analyser::$defaultImports</code></li><li><code>\\Openapi\\Logger</code></li></ul></li><li>Legacy support is available via the previous <code>TokenAnalyser</code></li><li>Improvements to the <code>Generator</code> class</li></ul><h2 id="annotations-as-php-attributes" tabindex="-1">Annotations as PHP attributes <a class="header-anchor" href="#annotations-as-php-attributes" aria-hidden="true">#</a></h2><p>While PHP attributes have been around since PHP 8.0 they were lacking the ability to be nested. This changes with PHP 8.1 which allows to use <code>new</code> in initializers.</p><p>Swagger-php attributes also make use of named arguments, so attribute parameters can be (mostly) typed. There are some limitations to type hints which can only be resolved once support for PHP 7.x is dropped.</p><h3 id="using-annotations" tabindex="-1">Using annotations <a class="header-anchor" href="#using-annotations" aria-hidden="true">#</a></h3><div class="language-php"><pre><code>
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Annotations</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @OA\\Info(
+ *   version=&quot;1.0.0&quot;,
+ *   title=&quot;My API&quot;,
+ *   @OA\\License(name=&quot;MIT&quot;),
+ *   @OA\\Attachable()
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</code></pre></div><h3 id="using-attributes" tabindex="-1">Using attributes <a class="header-anchor" href="#using-attributes" aria-hidden="true">#</a></h3><div class="language-php"><pre><code>
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Info</span><span class="token punctuation">(</span>
+    <span class="token attribute-class-name class-name">version</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;1.0.0&#39;</span><span class="token punctuation">,</span>
+    <span class="token attribute-class-name class-name">title</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;My API&#39;</span><span class="token punctuation">,</span>
+    <span class="token attribute-class-name class-name">attachables</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Attachable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">]</span>
+<span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>License</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">name</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;MIT&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</code></pre></div><h2 id="optional-nesting" tabindex="-1">Optional nesting <a class="header-anchor" href="#optional-nesting" aria-hidden="true">#</a></h2><p>One of the few differences between annotations and attributes visible in the above example is that the <code>OA\\License</code> attribute is not nested within <code>OA\\Info</code>. Nesting of attributes is possible and required in certain cases however, <strong>in cases where there is no ambiguity attributes may be all written on the top level</strong> and swagger-php will do the rest.</p><h2 id="annotations-must-be-associated-with-a-structural-element" tabindex="-1">Annotations must be associated with a structural element <a class="header-anchor" href="#annotations-must-be-associated-with-a-structural-element" aria-hidden="true">#</a></h2><p>The (now legacy) way of parsing PHP files meant that docblocks could live in a file without a single line of actual PHP code.</p><p>PHP Attributes cannot exist in isolation; they need code to be associated with and then are available via reflection on the associated structural element. In order to allow to keep supporting annotations and the code simple it made sense to treat annotations and attributes the same in this respect.</p><h2 id="the-pathparameter-annotation" tabindex="-1">The <code>PathParameter</code> annotation <a class="header-anchor" href="#the-pathparameter-annotation" aria-hidden="true">#</a></h2><p>As annotation this is just a short form for</p><div class="language-php"><pre><code>   @<span class="token constant">OA</span><span class="token function"><span class="token punctuation">\\</span>Parameter</span><span class="token punctuation">(</span>in<span class="token operator">=</span><span class="token string single-quoted-string">&#39;body&#39;</span><span class="token punctuation">)</span>
+</code></pre></div><p>Things get more interesting when it comes to using it as attribute, though. In the context of a controller you can now do something like</p><div class="language-php"><pre><code><span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/products/{product_id}&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getProduct</span><span class="token punctuation">(</span>
+        <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\\</span>PathParameter</span></span><span class="token delimiter punctuation">]</span></span> <span class="token keyword type-declaration">string</span> <span class="token variable">$product_id</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>Here it avoids having to duplicate details about the <code>$product_id</code> parameter and the simple use of the attribute will pick up typehints automatically.</p><h2 id="the-attachable-annotation" tabindex="-1">The <code>Attachable</code> annotation <a class="header-anchor" href="#the-attachable-annotation" aria-hidden="true">#</a></h2><p>Technically these were added in version 3.3.0, however they become really useful only with version 4.</p><p>The attachable annotation is similar to the OpenApi vendor extension <code>x=</code>. The main difference are that</p><ol><li>Attachables allow complex structures and strong typing</li><li><strong>Attachables are not added to the generated spec.</strong></li></ol><p>Their main purpose is to make customizing swagger-php easier by allowing to add arbitrary data to any annotation.</p><p>One possible use case could be custom annotations. Classes extending <code>Attachable</code> are allowed to limit the allowed parent annotations. This means it would be easy to create a new attribute to flag certain endpoints as private and exclude them under certain conditions from the spec (via a custom processor).</p><h2 id="removed-deprecated-elements" tabindex="-1">Removed deprecated elements <a class="header-anchor" href="#removed-deprecated-elements" aria-hidden="true">#</a></h2><h3 id="openapi-analysis-processors" tabindex="-1"><code>\\Openapi\\Analysis::processors()</code> <a class="header-anchor" href="#openapi-analysis-processors" aria-hidden="true">#</a></h3><p>Processors have been moved into the <code>Generator</code> class incl. some new convenience methods.</p><h3 id="openapi-analyser-whitelist" tabindex="-1"><code>\\Openapi\\Analyser::$whitelist</code> <a class="header-anchor" href="#openapi-analyser-whitelist" aria-hidden="true">#</a></h3><p>This has been replaced with the <code>Generator</code> <code>namespaces</code> property.</p><h3 id="openapi-analyser-defaultimports" tabindex="-1"><code>\\Openapi\\Analyser::$defaultImports</code> <a class="header-anchor" href="#openapi-analyser-defaultimports" aria-hidden="true">#</a></h3><p>This has been replaced with the <code>Generator</code> <code>aliases</code> property.</p><h3 id="openapi-logger" tabindex="-1"><code>\\Openapi\\Logger</code> <a class="header-anchor" href="#openapi-logger" aria-hidden="true">#</a></h3><p>This class has been removed completely. Instead, you may configure a <a href="https://www.php-fig.org/psr/psr-3/" target="_blank" rel="noopener noreferrer">PSR-3 logger</a>.</p><h2 id="improvements-to-the-generator-class" tabindex="-1">Improvements to the <code>Generator</code> class <a class="header-anchor" href="#improvements-to-the-generator-class" aria-hidden="true">#</a></h2><p>The removal of deprecated static config options means that the <code>Generator</code> class now is the main entry point into swagger-php when used programmatically.</p><p>To make the migration as simple as possible a new <code>Generator::withContext(callable)</code> has been added. This allows to use parts of the library (an <code>Analyser</code> instance, for example) within the context of a <code>Generator</code> instance.</p><p>Example:</p><div class="language-php"><pre><code><span class="token variable">$analyser</span> <span class="token operator">=</span> <span class="token function">createMyAnalyser</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$analysis</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">Generator</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">addAlias</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;fo&#39;</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">&#39;My\\\\Attribute\\\\Namespace&#39;</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">addNamespace</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;Other\\\\Annotations\\\\&#39;</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">withContext</span><span class="token punctuation">(</span><span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token class-name type-declaration">Generator</span> <span class="token variable">$generator</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">Analysis</span> <span class="token variable">$analysis</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">Context</span> <span class="token variable">$context</span><span class="token punctuation">)</span> <span class="token keyword">use</span> <span class="token punctuation">(</span><span class="token variable">$analyser</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token variable">$analyser</span><span class="token operator">-&gt;</span><span class="token function">setGenerator</span><span class="token punctuation">(</span><span class="token variable">$generator</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+        <span class="token variable">$analysis</span> <span class="token operator">=</span> <span class="token variable">$analyser</span><span class="token operator">-&gt;</span><span class="token function">fromFile</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;my_code.php&#39;</span><span class="token punctuation">,</span> <span class="token variable">$context</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+        <span class="token variable">$analysis</span><span class="token operator">-&gt;</span><span class="token function">process</span><span class="token punctuation">(</span><span class="token variable">$generator</span><span class="token operator">-&gt;</span><span class="token function">getProcessors</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+        <span class="token keyword">return</span> <span class="token variable">$analysis</span><span class="token punctuation">;</span>
+    <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div>`,41),p=[o];function i(c,l,r,u,d,h){return s(),n("div",null,p)}var g=a(t,[["render",i]]);export{m as __pageData,g as default};
diff --git a/assets/guide_migrating-to-v4.md.714a0f1b.lean.js b/assets/guide_migrating-to-v4.md.714a0f1b.lean.js
new file mode 100644
index 00000000..63e4e9f4
--- /dev/null
+++ b/assets/guide_migrating-to-v4.md.714a0f1b.lean.js
@@ -0,0 +1 @@
+import{_ as a,c as n,o as s,a as e}from"./app.850f5e05.js";const m='{"title":"Migrating to v4","description":"","frontmatter":{},"headers":[{"level":2,"title":"Overview","slug":"overview"},{"level":2,"title":"Annotations as PHP attributes","slug":"annotations-as-php-attributes"},{"level":3,"title":"Using annotations","slug":"using-annotations"},{"level":3,"title":"Using attributes","slug":"using-attributes"},{"level":2,"title":"Optional nesting","slug":"optional-nesting"},{"level":2,"title":"Annotations must be associated with a structural element","slug":"annotations-must-be-associated-with-a-structural-element"},{"level":2,"title":"The PathParameter annotation","slug":"the-pathparameter-annotation"},{"level":2,"title":"The Attachable annotation","slug":"the-attachable-annotation"},{"level":2,"title":"Removed deprecated elements","slug":"removed-deprecated-elements"},{"level":3,"title":"\\\\Openapi\\\\Analysis::processors()","slug":"openapi-analysis-processors"},{"level":3,"title":"\\\\Openapi\\\\Analyser::$whitelist","slug":"openapi-analyser-whitelist"},{"level":3,"title":"\\\\Openapi\\\\Analyser::$defaultImports","slug":"openapi-analyser-defaultimports"},{"level":3,"title":"\\\\Openapi\\\\Logger","slug":"openapi-logger"},{"level":2,"title":"Improvements to the Generator class","slug":"improvements-to-the-generator-class"}],"relativePath":"guide/migrating-to-v4.md"}',t={},o=e("",41),p=[o];function i(c,l,r,u,d,h){return s(),n("div",null,p)}var g=a(t,[["render",i]]);export{m as __pageData,g as default};
diff --git a/assets/guide_required-elements.md.ef909293.js b/assets/guide_required-elements.md.ef909293.js
new file mode 100644
index 00000000..97433d03
--- /dev/null
+++ b/assets/guide_required-elements.md.ef909293.js
@@ -0,0 +1,62 @@
+import{_ as o,c,b as p,w as a,a as t,r as i,o as l,d as n,e as s}from"./app.850f5e05.js";const O='{"title":"Required elements","description":"","frontmatter":{},"headers":[{"level":2,"title":"Minimum required annotations","slug":"minimum-required-annotations"},{"level":2,"title":"Optional elements","slug":"optional-elements"}],"relativePath":"guide/required-elements.md"}',u={},r=t('<h1 id="required-elements" tabindex="-1">Required elements <a class="header-anchor" href="#required-elements" aria-hidden="true">#</a></h1><p>The OpenAPI specification defines a minimum set of information for a valid document.</p><p>For the most part that consists of some general information about the API like <code>name</code>, <code>version</code> and at least one endpoint.</p><p>The endpoint, in turn, needs to have a path and at least one response.</p><h2 id="minimum-required-annotations" tabindex="-1">Minimum required annotations <a class="header-anchor" href="#minimum-required-annotations" aria-hidden="true">#</a></h2><p>With the above in mind a minimal API with a single endpoint could look like this:</p>',6),k=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Attributes")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OA"),n("span",{class:"token punctuation"},"\\"),s("Info")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"title"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string double-quoted-string"},'"My First API"'),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token attribute-class-name class-name"},"version"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string double-quoted-string"},'"0.1"'),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"MyController"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OA"),n("span",{class:"token punctuation"},"\\"),s("Get")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"path"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'/api/data.json'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OA"),n("span",{class:"token punctuation"},"\\"),s("Response")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"response"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'200'"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token attribute-class-name class-name"},"description"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'The data'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+    `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"function"),s(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(`
+    `),n("span",{class:"token punctuation"},"{"),s(`
+        `),n("span",{class:"token comment"},"// ..."),s(`
+    `),n("span",{class:"token punctuation"},"}"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),d=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Annotations")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token comment"},`/**
+ * @OA\\Info(
+ *     title="My First API",
+ *     version="0.1"
+ * )
+ */`),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"MyController"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+
+    `),n("span",{class:"token comment"},`/**
+     * @OA\\Get(
+     *     path="/api/data.json",
+     *     @OA\\Response(
+     *         response="200",
+     *         description="The data"
+     *     )
+     * )
+     */`),s(`
+    `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"function"),s(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(`
+    `),n("span",{class:"token punctuation"},"{"),s(`
+        `),n("span",{class:"token comment"},"// ..."),s(`
+    `),n("span",{class:"token punctuation"},"}"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),m=t(`<p>with the resulting OpenAPI document like this</p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">info</span><span class="token punctuation">:</span>
+  <span class="token key atrule">title</span><span class="token punctuation">:</span> <span class="token string">&#39;My First API&#39;</span>
+  <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token string">&#39;0.1&#39;</span>
+<span class="token key atrule">paths</span><span class="token punctuation">:</span>
+  <span class="token key atrule">/api/data.json</span><span class="token punctuation">:</span>
+    <span class="token key atrule">get</span><span class="token punctuation">:</span>
+      <span class="token key atrule">operationId</span><span class="token punctuation">:</span> 236f26ae21b015a60adbce41f8f316e3
+      <span class="token key atrule">responses</span><span class="token punctuation">:</span>
+        <span class="token key atrule">&#39;200&#39;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;The data&#39;</span>
+</code></pre></div><div class="warning custom-block"><p class="custom-block-title">Code locations</p><p>Attributes and annotations can be added anywhere on declarations in code as defined by the PHP docs. These are limited to the extent of what the PHP Reflection APIs supports.</p></div><h2 id="optional-elements" tabindex="-1">Optional elements <a class="header-anchor" href="#optional-elements" aria-hidden="true">#</a></h2><p>Looking at the generated document you will notice that there are some elements that <code>swagger-php</code> adds automatically when they are missing.</p><p>For the most part those are <code>@OA\\OpenApi</code>, <code>@OA\\Components</code> and <code>@OA\\PathItem</code>.</p>`,6);function h(_,f,g,y,b,A){const e=i("codeblock");return l(),c("div",null,[r,p(e,{id:"minimal"},{at:a(()=>[k]),an:a(()=>[d]),_:1}),m])}var q=o(u,[["render",h]]);export{O as __pageData,q as default};
diff --git a/assets/guide_required-elements.md.ef909293.lean.js b/assets/guide_required-elements.md.ef909293.lean.js
new file mode 100644
index 00000000..d691c060
--- /dev/null
+++ b/assets/guide_required-elements.md.ef909293.lean.js
@@ -0,0 +1,51 @@
+import{_ as o,c,b as p,w as a,a as t,r as i,o as l,d as n,e as s}from"./app.850f5e05.js";const O='{"title":"Required elements","description":"","frontmatter":{},"headers":[{"level":2,"title":"Minimum required annotations","slug":"minimum-required-annotations"},{"level":2,"title":"Optional elements","slug":"optional-elements"}],"relativePath":"guide/required-elements.md"}',u={},r=t("",6),k=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Attributes")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OA"),n("span",{class:"token punctuation"},"\\"),s("Info")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"title"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string double-quoted-string"},'"My First API"'),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token attribute-class-name class-name"},"version"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string double-quoted-string"},'"0.1"'),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"MyController"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OA"),n("span",{class:"token punctuation"},"\\"),s("Get")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"path"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'/api/data.json'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[s("OA"),n("span",{class:"token punctuation"},"\\"),s("Response")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"response"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'200'"),n("span",{class:"token punctuation"},","),s(),n("span",{class:"token attribute-class-name class-name"},"description"),n("span",{class:"token punctuation"},":"),s(),n("span",{class:"token string single-quoted-string"},"'The data'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),s(`
+    `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"function"),s(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(`
+    `),n("span",{class:"token punctuation"},"{"),s(`
+        `),n("span",{class:"token comment"},"// ..."),s(`
+    `),n("span",{class:"token punctuation"},"}"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),d=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),s(`
+
+`),n("span",{class:"token keyword"},"use"),s(),n("span",{class:"token package"},[s("OpenApi"),n("span",{class:"token punctuation"},"\\"),s("Annotations")]),s(),n("span",{class:"token keyword"},"as"),s(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),s(`
+
+`),n("span",{class:"token comment"},`/**
+ * @OA\\Info(
+ *     title="My First API",
+ *     version="0.1"
+ * )
+ */`),s(`
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+
+`),n("span",{class:"token keyword"},"class"),s(),n("span",{class:"token class-name-definition class-name"},"MyController"),s(`
+`),n("span",{class:"token punctuation"},"{"),s(`
+
+    `),n("span",{class:"token comment"},`/**
+     * @OA\\Get(
+     *     path="/api/data.json",
+     *     @OA\\Response(
+     *         response="200",
+     *         description="The data"
+     *     )
+     * )
+     */`),s(`
+    `),n("span",{class:"token keyword"},"public"),s(),n("span",{class:"token keyword"},"function"),s(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),s(`
+    `),n("span",{class:"token punctuation"},"{"),s(`
+        `),n("span",{class:"token comment"},"// ..."),s(`
+    `),n("span",{class:"token punctuation"},"}"),s(`
+`),n("span",{class:"token punctuation"},"}"),s(`
+`)])])])],-1),m=t("",6);function h(_,f,g,y,b,A){const e=i("codeblock");return l(),c("div",null,[r,p(e,{id:"minimal"},{at:a(()=>[k]),an:a(()=>[d]),_:1}),m])}var q=o(u,[["render",h]]);export{O as __pageData,q as default};
diff --git a/assets/guide_under-the-hood.md.58a1fa15.js b/assets/guide_under-the-hood.md.58a1fa15.js
new file mode 100644
index 00000000..d7ce63e9
--- /dev/null
+++ b/assets/guide_under-the-hood.md.58a1fa15.js
@@ -0,0 +1,3 @@
+import{_ as e,c as t,o as a,a as o}from"./app.850f5e05.js";const g='{"title":"Under the hood","description":"","frontmatter":{},"headers":[{"level":2,"title":"Processing flow","slug":"processing-flow"},{"level":2,"title":"Context","slug":"context"},{"level":2,"title":"Analysis","slug":"analysis"},{"level":2,"title":"Documentation","slug":"documentation"},{"level":3,"title":"Installation","slug":"installation"},{"level":3,"title":"Workflow","slug":"workflow"}],"relativePath":"guide/under-the-hood.md"}',n={},i=o(`<h1 id="under-the-hood" tabindex="-1">Under the hood <a class="header-anchor" href="#under-the-hood" aria-hidden="true">#</a></h1><h2 id="processing-flow" tabindex="-1">Processing flow <a class="header-anchor" href="#processing-flow" aria-hidden="true">#</a></h2><ul><li>The <code>Generator</code> iterates over the given sources (Symfony <code>Finder</code>, file/directory list, etc)</li><li>The configured analyser (<code>AnalyserInterface</code>) reads the files and builds an <code>Analysis</code> object. Default (as of v4) is the <code>ReflectionAnalyser</code>. Alternatively, there is the <code>TokenAnalyser</code> which was the default in v3.</li><li>The <code>Analysis</code> object and its annotations are then processed by the configured processors.</li><li>If enabled, the analysis/annotations are validated.</li><li>The root <code>OpenApi</code> annotation then contains all annotations and is serialized into YAML/JSON.</li></ul><h2 id="context" tabindex="-1"><code>Context</code> <a class="header-anchor" href="#context" aria-hidden="true">#</a></h2><p>Each annotation is associated with a unique <code>Context</code> instance. This contains details, collected by the parser/analyser, about the PHP context where the annotation was found.</p><p>Typically, there will be a processor that uses the data to augment/enrich the annotation.</p><p><strong>Examples of the data collected:</strong></p><ul><li>class/interface/trait/enum names</li><li>property names</li><li>doctype or native type hints</li><li>file name and line number</li></ul><h2 id="analysis" tabindex="-1">Analysis <a class="header-anchor" href="#analysis" aria-hidden="true">#</a></h2><p>Contains all detected annotations and other relevant meta-data.</p><p>It uses a <code>SplObjectStorage</code> instance to store the parsed annotations.</p><h2 id="documentation" tabindex="-1">Documentation <a class="header-anchor" href="#documentation" aria-hidden="true">#</a></h2><p>This documentation is generated with <a href="https://vitepress.vuejs.org/" target="_blank" rel="noopener noreferrer">VitePress</a></p><h3 id="installation" tabindex="-1">Installation <a class="header-anchor" href="#installation" aria-hidden="true">#</a></h3><div class="language-shell"><pre><code><span class="token builtin class-name">cd</span> docs
+<span class="token function">npm</span> <span class="token function">install</span> vitepress 
+</code></pre></div><h3 id="workflow" tabindex="-1">Workflow <a class="header-anchor" href="#workflow" aria-hidden="true">#</a></h3><ul><li>Edit <code>.md</code> files in the <code>docs</code> folder</li><li>Update annotation / attribute PHP docblocks.<br>These will be extracted during publishing into the <a href="./../reference/">reference</a> section.</li><li>Run &#39;composer docs:build&#39; to check for any errors</li><li>Run &#39;composer docs:dev&#39; to test the generated documentation locally (<code>localhost:3000</code>)</li><li>Create PR and update <code>master</code></li><li>Manually trigger the <code>gh-pages</code> workflow to update the online docs.</li></ul><p>The last step requires commit rights on <code>zircote/swagger-php</code>.</p>`,18),s=[i];function l(r,d,c,h,u,p){return a(),t("div",null,s)}var m=e(n,[["render",l]]);export{g as __pageData,m as default};
diff --git a/assets/guide_under-the-hood.md.58a1fa15.lean.js b/assets/guide_under-the-hood.md.58a1fa15.lean.js
new file mode 100644
index 00000000..26d2b721
--- /dev/null
+++ b/assets/guide_under-the-hood.md.58a1fa15.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o as a,a as o}from"./app.850f5e05.js";const g='{"title":"Under the hood","description":"","frontmatter":{},"headers":[{"level":2,"title":"Processing flow","slug":"processing-flow"},{"level":2,"title":"Context","slug":"context"},{"level":2,"title":"Analysis","slug":"analysis"},{"level":2,"title":"Documentation","slug":"documentation"},{"level":3,"title":"Installation","slug":"installation"},{"level":3,"title":"Workflow","slug":"workflow"}],"relativePath":"guide/under-the-hood.md"}',n={},i=o("",18),s=[i];function l(r,d,c,h,u,p){return a(),t("div",null,s)}var m=e(n,[["render",l]]);export{g as __pageData,m as default};
diff --git a/assets/index.md.56757007.js b/assets/index.md.56757007.js
new file mode 100644
index 00000000..baf2605e
--- /dev/null
+++ b/assets/index.md.56757007.js
@@ -0,0 +1,53 @@
+import{_ as o,c,b as i,w as a,a as s,r as l,o as p,d as n,e}from"./app.850f5e05.js";const x='{"title":"Home","description":"","frontmatter":{"home":true,"actionText":"User Guide \u2192","actionLink":"/guide/","features":[{"title":"OpenAPI conformant","details":"Generate OpenAPI documents in version 3.0 or 3.1."},{"title":"Document your API inside PHP source code","details":"Using swagger-php lets you write the API documentation inside the PHP source files which helps keeping the documentation up-to-date."},{"title":"Annotation and Attribute support","details":"Annotations can be either docblocks or PHP 8.1 attributes."}]},"headers":[{"level":3,"title":"1. Install with composer:","slug":"_1-install-with-composer"},{"level":3,"title":"2. Update your code","slug":"_2-update-your-code"},{"level":3,"title":"3. Generate OpenAPI documentation","slug":"_3-generate-openapi-documentation"},{"level":3,"title":"4. Explore and interact with your API","slug":"_4-explore-and-interact-with-your-api"},{"level":2,"title":"Links","slug":"links"}],"relativePath":"index.md"}',r={},u=s(`<h3 id="_1-install-with-composer" tabindex="-1">1. Install with composer: <a class="header-anchor" href="#_1-install-with-composer" aria-hidden="true">#</a></h3><div class="language-shell"><pre><code><span class="token operator">&gt;</span> <span class="token function">composer</span> require zircote/swagger-php
+</code></pre></div><h3 id="_2-update-your-code" tabindex="-1">2. Update your code <a class="header-anchor" href="#_2-update-your-code" aria-hidden="true">#</a></h3><p>Add <code>swagger-php</code> attributes or annotations to your source code.</p>`,4),d=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),e(`
+
+`),n("span",{class:"token keyword"},"use"),e(),n("span",{class:"token package"},[e("OpenApi"),n("span",{class:"token punctuation"},"\\"),e("Attributes")]),e(),n("span",{class:"token keyword"},"as"),e(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),e(`
+
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[e("OA"),n("span",{class:"token punctuation"},"\\"),e("Info")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"title"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string double-quoted-string"},'"My First API"'),n("span",{class:"token punctuation"},","),e(),n("span",{class:"token attribute-class-name class-name"},"version"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string double-quoted-string"},'"0.1"'),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),e(`
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"MyController"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[e("OA"),n("span",{class:"token punctuation"},"\\"),e("Get")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"path"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string single-quoted-string"},"'/api/data.json'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),e(`
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[e("OA"),n("span",{class:"token punctuation"},"\\"),e("Response")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"response"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string single-quoted-string"},"'200'"),n("span",{class:"token punctuation"},","),e(),n("span",{class:"token attribute-class-name class-name"},"description"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string single-quoted-string"},"'The data'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),e(`
+    `),n("span",{class:"token keyword"},"public"),e(),n("span",{class:"token keyword"},"function"),e(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),e(`
+    `),n("span",{class:"token punctuation"},"{"),e(`
+        `),n("span",{class:"token comment"},"// ..."),e(`
+    `),n("span",{class:"token punctuation"},"}"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+`)])])])],-1),k=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),e(`
+
+`),n("span",{class:"token keyword"},"use"),e(),n("span",{class:"token package"},[e("OpenApi"),n("span",{class:"token punctuation"},"\\"),e("Annotations")]),e(),n("span",{class:"token keyword"},"as"),e(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),e(`
+
+`),n("span",{class:"token comment"},`/**
+ * @OA\\Info(
+ *     title="My First API",
+ *     version="0.1"
+ * )
+ */`),e(`
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"MyController"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+
+    `),n("span",{class:"token comment"},`/**
+     * @OA\\Get(
+     *     path="/api/data.json",
+     *     @OA\\Response(
+     *         response="200",
+     *         description="The data"
+     *     )
+     * )
+     */`),e(`
+    `),n("span",{class:"token keyword"},"public"),e(),n("span",{class:"token keyword"},"function"),e(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),e(`
+    `),n("span",{class:"token punctuation"},"{"),e(`
+        `),n("span",{class:"token comment"},"// ..."),e(`
+    `),n("span",{class:"token punctuation"},"}"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+`)])])])],-1),h=s(`<h3 id="_3-generate-openapi-documentation" tabindex="-1">3. Generate OpenAPI documentation <a class="header-anchor" href="#_3-generate-openapi-documentation" aria-hidden="true">#</a></h3><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./bin/openapi src <span class="token parameter variable">-o</span> openapi.yaml
+</code></pre></div><h3 id="_4-explore-and-interact-with-your-api" tabindex="-1">4. Explore and interact with your API <a class="header-anchor" href="#_4-explore-and-interact-with-your-api" aria-hidden="true">#</a></h3><p>Use an OpenAPI tool like <a href="https://swagger.io/tools/swagger-ui/" target="_blank" rel="noopener noreferrer">Swagger UI </a> to explore and interact with your API.</p><h2 id="links" tabindex="-1">Links <a class="header-anchor" href="#links" aria-hidden="true">#</a></h2><ul><li><a href="./guide/">User Guide</a></li><li><a href="./reference/">Reference</a></li><li><a href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer">OpenApi Documentation</a></li><li><a href="https://spec.openapis.org/oas/v3.1.0.html" target="_blank" rel="noopener noreferrer">OpenApi Specification</a></li><li><a href="https://github.com/zircote/swagger-php/tree/master/Examples" target="_blank" rel="noopener noreferrer">Learn by example</a></li><li><a href="./related-projects.html">Related projects</a></li><li><a href="https://github.com/zircote/swagger-php/tree/2.x/docs" target="_blank" rel="noopener noreferrer">Swagger-php 2.x documentation</a></li></ul>`,6);function m(g,_,f,b,A,w){const t=l("codeblock");return p(),c("div",null,[u,i(t,{id:"minimal"},{at:a(()=>[d]),an:a(()=>[k]),_:1}),h])}var P=o(r,[["render",m]]);export{x as __pageData,P as default};
diff --git a/assets/index.md.56757007.lean.js b/assets/index.md.56757007.lean.js
new file mode 100644
index 00000000..d41e3f83
--- /dev/null
+++ b/assets/index.md.56757007.lean.js
@@ -0,0 +1,51 @@
+import{_ as o,c,b as i,w as a,a as s,r as l,o as p,d as n,e}from"./app.850f5e05.js";const x='{"title":"Home","description":"","frontmatter":{"home":true,"actionText":"User Guide \u2192","actionLink":"/guide/","features":[{"title":"OpenAPI conformant","details":"Generate OpenAPI documents in version 3.0 or 3.1."},{"title":"Document your API inside PHP source code","details":"Using swagger-php lets you write the API documentation inside the PHP source files which helps keeping the documentation up-to-date."},{"title":"Annotation and Attribute support","details":"Annotations can be either docblocks or PHP 8.1 attributes."}]},"headers":[{"level":3,"title":"1. Install with composer:","slug":"_1-install-with-composer"},{"level":3,"title":"2. Update your code","slug":"_2-update-your-code"},{"level":3,"title":"3. Generate OpenAPI documentation","slug":"_3-generate-openapi-documentation"},{"level":3,"title":"4. Explore and interact with your API","slug":"_4-explore-and-interact-with-your-api"},{"level":2,"title":"Links","slug":"links"}],"relativePath":"index.md"}',r={},u=s("",4),d=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),e(`
+
+`),n("span",{class:"token keyword"},"use"),e(),n("span",{class:"token package"},[e("OpenApi"),n("span",{class:"token punctuation"},"\\"),e("Attributes")]),e(),n("span",{class:"token keyword"},"as"),e(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),e(`
+
+`),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[e("OA"),n("span",{class:"token punctuation"},"\\"),e("Info")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"title"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string double-quoted-string"},'"My First API"'),n("span",{class:"token punctuation"},","),e(),n("span",{class:"token attribute-class-name class-name"},"version"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string double-quoted-string"},'"0.1"'),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),e(`
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"MyController"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[e("OA"),n("span",{class:"token punctuation"},"\\"),e("Get")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"path"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string single-quoted-string"},"'/api/data.json'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),e(`
+    `),n("span",{class:"token attribute"},[n("span",{class:"token delimiter punctuation"},"#["),n("span",{class:"token attribute-content"},[n("span",{class:"token attribute-class-name class-name class-name-fully-qualified"},[e("OA"),n("span",{class:"token punctuation"},"\\"),e("Response")]),n("span",{class:"token punctuation"},"("),n("span",{class:"token attribute-class-name class-name"},"response"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string single-quoted-string"},"'200'"),n("span",{class:"token punctuation"},","),e(),n("span",{class:"token attribute-class-name class-name"},"description"),n("span",{class:"token punctuation"},":"),e(),n("span",{class:"token string single-quoted-string"},"'The data'"),n("span",{class:"token punctuation"},")")]),n("span",{class:"token delimiter punctuation"},"]")]),e(`
+    `),n("span",{class:"token keyword"},"public"),e(),n("span",{class:"token keyword"},"function"),e(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),e(`
+    `),n("span",{class:"token punctuation"},"{"),e(`
+        `),n("span",{class:"token comment"},"// ..."),e(`
+    `),n("span",{class:"token punctuation"},"}"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+`)])])])],-1),k=n("div",{class:"language-php"},[n("pre",null,[n("code",null,[n("span",{class:"token php language-php"},[n("span",{class:"token delimiter important"},"<?php"),e(`
+
+`),n("span",{class:"token keyword"},"use"),e(),n("span",{class:"token package"},[e("OpenApi"),n("span",{class:"token punctuation"},"\\"),e("Annotations")]),e(),n("span",{class:"token keyword"},"as"),e(),n("span",{class:"token constant"},"OA"),n("span",{class:"token punctuation"},";"),e(`
+
+`),n("span",{class:"token comment"},`/**
+ * @OA\\Info(
+ *     title="My First API",
+ *     version="0.1"
+ * )
+ */`),e(`
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"OpenApi"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+
+`),n("span",{class:"token keyword"},"class"),e(),n("span",{class:"token class-name-definition class-name"},"MyController"),e(`
+`),n("span",{class:"token punctuation"},"{"),e(`
+
+    `),n("span",{class:"token comment"},`/**
+     * @OA\\Get(
+     *     path="/api/data.json",
+     *     @OA\\Response(
+     *         response="200",
+     *         description="The data"
+     *     )
+     * )
+     */`),e(`
+    `),n("span",{class:"token keyword"},"public"),e(),n("span",{class:"token keyword"},"function"),e(),n("span",{class:"token function-definition function"},"getResource"),n("span",{class:"token punctuation"},"("),n("span",{class:"token punctuation"},")"),e(`
+    `),n("span",{class:"token punctuation"},"{"),e(`
+        `),n("span",{class:"token comment"},"// ..."),e(`
+    `),n("span",{class:"token punctuation"},"}"),e(`
+`),n("span",{class:"token punctuation"},"}"),e(`
+`)])])])],-1),h=s("",6);function m(g,_,f,b,A,w){const t=l("codeblock");return p(),c("div",null,[u,i(t,{id:"minimal"},{at:a(()=>[d]),an:a(()=>[k]),_:1}),h])}var P=o(r,[["render",m]]);export{x as __pageData,P as default};
diff --git a/assets/reference_annotations.md.93df9735.js b/assets/reference_annotations.md.93df9735.js
new file mode 100644
index 00000000..d8a7758b
--- /dev/null
+++ b/assets/reference_annotations.md.93df9735.js
@@ -0,0 +1 @@
+import{_ as e,c as a,o as t,a as r}from"./app.850f5e05.js";const b='{"title":"Annotation Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Annotations","slug":"annotations"},{"level":3,"title":"AdditionalProperties","slug":"additionalproperties"},{"level":3,"title":"Attachable","slug":"attachable"},{"level":3,"title":"Components","slug":"components"},{"level":3,"title":"Contact","slug":"contact"},{"level":3,"title":"CookieParameter","slug":"cookieparameter"},{"level":3,"title":"Delete","slug":"delete"},{"level":3,"title":"Discriminator","slug":"discriminator"},{"level":3,"title":"Examples","slug":"examples"},{"level":3,"title":"ExternalDocumentation","slug":"externaldocumentation"},{"level":3,"title":"Flow","slug":"flow"},{"level":3,"title":"Get","slug":"get"},{"level":3,"title":"Head","slug":"head"},{"level":3,"title":"Header","slug":"header"},{"level":3,"title":"HeaderParameter","slug":"headerparameter"},{"level":3,"title":"Info","slug":"info"},{"level":3,"title":"Items","slug":"items"},{"level":3,"title":"JsonContent","slug":"jsoncontent"},{"level":3,"title":"License","slug":"license"},{"level":3,"title":"Link","slug":"link"},{"level":3,"title":"MediaType","slug":"mediatype"},{"level":3,"title":"OpenApi","slug":"openapi"},{"level":3,"title":"Options","slug":"options"},{"level":3,"title":"Parameter","slug":"parameter"},{"level":3,"title":"Patch","slug":"patch"},{"level":3,"title":"PathItem","slug":"pathitem"},{"level":3,"title":"PathParameter","slug":"pathparameter"},{"level":3,"title":"Post","slug":"post"},{"level":3,"title":"Property","slug":"property"},{"level":3,"title":"Put","slug":"put"},{"level":3,"title":"QueryParameter","slug":"queryparameter"},{"level":3,"title":"RequestBody","slug":"requestbody"},{"level":3,"title":"Response","slug":"response"},{"level":3,"title":"Schema","slug":"schema"},{"level":3,"title":"SecurityScheme","slug":"securityscheme"},{"level":3,"title":"Server","slug":"server"},{"level":3,"title":"ServerVariable","slug":"servervariable"},{"level":3,"title":"Tag","slug":"tag"},{"level":3,"title":"Trace","slug":"trace"},{"level":3,"title":"Webhook","slug":"webhook"},{"level":3,"title":"Xml","slug":"xml"},{"level":3,"title":"XmlContent","slug":"xmlcontent"}],"relativePath":"reference/annotations.md"}',n={},s=r('<h1 id="annotation-reference" tabindex="-1">Annotation Reference <a class="header-anchor" href="#annotation-reference" aria-hidden="true">#</a></h1><p>This page is generated automatically from the <code>swagger-php</code> sources.</p><p>For improvements head over to <a href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer">GitHub</a> and create a PR \u{1F609}</p><p>In addition to this page, there are also a number of <a href="https://github.com/zircote/swagger-php/tree/master/Examples#readme" target="_blank" rel="noopener noreferrer">examples</a> which might help you out.</p><h2 id="annotations" tabindex="-1">Annotations <a class="header-anchor" href="#annotations" aria-hidden="true">#</a></h2><h3 id="additionalproperties" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/AdditionalProperties.php" target="_blank" rel="noopener noreferrer">AdditionalProperties</a> <a class="header-anchor" href="#additionalproperties" aria-hidden="true">#</a></h3><h4 id="allowed-in" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#additionalproperties">AdditionalProperties</a></p><h4 id="nested-elements" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h3 id="attachable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Attachable.php" target="_blank" rel="noopener noreferrer">Attachable</a> <a class="header-anchor" href="#attachable" aria-hidden="true">#</a></h3><p>A container for custom data to be attached to an annotation.</p><p>These will be ignored by <code>swagger-php</code> but can be used for custom processing.</p><h4 id="allowed-in-1" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-1" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#components">Components</a>, <a href="#contact">Contact</a>, <a href="#delete">Delete</a>, <a href="#discriminator">Discriminator</a>, <a href="#examples">Examples</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#flow">Flow</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#header">Header</a>, <a href="#info">Info</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#license">License</a>, <a href="#link">Link</a>, <a href="#mediatype">MediaType</a>, <a href="#openapi">OpenApi</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#patch">Patch</a>, <a href="#pathitem">PathItem</a>, <a href="#pathparameter">PathParameter</a>, <a href="#post">Post</a>, <a href="#property">Property</a>, <a href="#put">Put</a>, <a href="#requestbody">RequestBody</a>, <a href="#response">Response</a>, <a href="#schema">Schema</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#server">Server</a>, <a href="#servervariable">ServerVariable</a>, <a href="#tag">Tag</a>, <a href="#trace">Trace</a>, <a href="#webhook">Webhook</a>, <a href="#xml">Xml</a>, <a href="#xmlcontent">XmlContent</a></p><h3 id="components" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Components.php" target="_blank" rel="noopener noreferrer">Components</a> <a class="header-anchor" href="#components" aria-hidden="true">#</a></h3><p>Holds a set of reusable objects for different aspects of the OA.</p><p>All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.</p><h4 id="allowed-in-2" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-2" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-1" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-1" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#requestbody">RequestBody</a>, <a href="#examples">Examples</a>, <a href="#header">Header</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#link">Link</a>, <a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h4><hr><dl><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Reusable Callbacks.</p></dd></dl><h4 id="reference" tabindex="-1">Reference <a class="header-anchor" href="#reference" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object" target="_blank" rel="noopener noreferrer">OAI Components Object</a></li></ul><h3 id="contact" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Contact.php" target="_blank" rel="noopener noreferrer">Contact</a> <a class="header-anchor" href="#contact" aria-hidden="true">#</a></h3><p>Contact information for the exposed API.</p><h4 id="allowed-in-3" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-3" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-2" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-2" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-1" tabindex="-1">Properties <a class="header-anchor" href="#properties-1" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The identifying name of the contact person/organization.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL pointing to the contact information.</p></dd><dt><strong>email</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The email address of the contact person/organization.</p></dd></dl><h4 id="reference-1" tabindex="-1">Reference <a class="header-anchor" href="#reference-1" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object" target="_blank" rel="noopener noreferrer">OAI Contact Object</a></li></ul><h3 id="cookieparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/CookieParameter.php" target="_blank" rel="noopener noreferrer">CookieParameter</a> <a class="header-anchor" href="#cookieparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\\Request</code> cookie parameter.</p><h4 id="allowed-in-4" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-4" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-3" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-3" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-2" tabindex="-1">Properties <a class="header-anchor" href="#properties-2" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;cookie&#39; as the default location.</p></dd></dl><h3 id="delete" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Delete.php" target="_blank" rel="noopener noreferrer">Delete</a> <a class="header-anchor" href="#delete" aria-hidden="true">#</a></h3><h4 id="allowed-in-5" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-5" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-4" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-4" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-3" tabindex="-1">Properties <a class="header-anchor" href="#properties-3" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="discriminator" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Discriminator.php" target="_blank" rel="noopener noreferrer">Discriminator</a> <a class="header-anchor" href="#discriminator" aria-hidden="true">#</a></h3><p>The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.</p><p>This object is based on the <a href="http://json-schema.org" target="_blank" rel="noopener noreferrer">JSON Schema Specification</a> and uses a predefined subset of it. On top of this subset, there are extensions provided by this specification to allow for more complete documentation.</p><h4 id="allowed-in-6" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-6" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-5" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-5" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-4" tabindex="-1">Properties <a class="header-anchor" href="#properties-4" aria-hidden="true">#</a></h4><hr><dl><dt><strong>propertyName</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the property in the payload that will hold the discriminator value.</p></dd><dt><strong>mapping</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object to hold mappings between payload values and schema names or references.</p></dd></dl><h4 id="reference-2" tabindex="-1">Reference <a class="header-anchor" href="#reference-2" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminatorObject" target="_blank" rel="noopener noreferrer">OAI Discriminator Object</a></li><li><a href="http://json-schema.org/" target="_blank" rel="noopener noreferrer">JSON Schema</a></li></ul><h3 id="examples" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Examples.php" target="_blank" rel="noopener noreferrer">Examples</a> <a class="header-anchor" href="#examples" aria-hidden="true">#</a></h3><h4 id="allowed-in-7" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-7" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#schema">Schema</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-6" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-6" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-5" tabindex="-1">Properties <a class="header-anchor" href="#properties-5" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to an example.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into `#/components/examples`.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Short description for the example.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>value</strong> : <span style="font-family:monospace;">int|string|array</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>externalValue</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL that points to the literal example.<br><br> This provides the capability to reference examples that cannot easily be included<br> in JSON or YAML documents.<br><br> The value field and externalValue field are mutually exclusive.</p></dd></dl><h3 id="externaldocumentation" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/ExternalDocumentation.php" target="_blank" rel="noopener noreferrer">ExternalDocumentation</a> <a class="header-anchor" href="#externaldocumentation" aria-hidden="true">#</a></h3><p>Allows referencing an external resource for extended documentation.</p><h4 id="allowed-in-8" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-8" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#tag">Tag</a>, <a href="#schema">Schema</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#property">Property</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-7" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-7" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-6" tabindex="-1">Properties <a class="header-anchor" href="#properties-6" aria-hidden="true">#</a></h4><hr><dl><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description of the target documentation. GFM syntax can be used for rich text representation.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL for the target documentation.</p></dd></dl><h4 id="reference-3" tabindex="-1">Reference <a class="header-anchor" href="#reference-3" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#external-documentation-object" target="_blank" rel="noopener noreferrer">OAI External Documentation Object</a></li></ul><h3 id="flow" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Flow.php" target="_blank" rel="noopener noreferrer">Flow</a> <a class="header-anchor" href="#flow" aria-hidden="true">#</a></h3><p>Configuration details for a supported OAuth Flow.</p><h4 id="allowed-in-9" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-9" aria-hidden="true">#</a></h4><hr><p><a href="#securityscheme">SecurityScheme</a></p><h4 id="nested-elements-8" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-8" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-7" tabindex="-1">Properties <a class="header-anchor" href="#properties-7" aria-hidden="true">#</a></h4><hr><dl><dt><strong>authorizationUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The authorization url to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>tokenUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The token URL to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>refreshUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL to be used for obtaining refresh tokens.<br><br> This must be in the form of an url.</p></dd><dt><strong>flow</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Flow name.<br><br> One of [&#39;implicit&#39;, &#39;password&#39;, &#39;authorizationCode&#39;, &#39;clientCredentials&#39;].</p></dd><dt><strong>scopes</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>The available scopes for the OAuth2 security scheme.<br><br> A map between the scope name and a short description for it.</p></dd></dl><h4 id="reference-4" tabindex="-1">Reference <a class="header-anchor" href="#reference-4" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://swagger.io/specification/#oauthFlowObject" target="_blank" rel="noopener noreferrer">OAI OAuth Flow Object</a></li></ul><h3 id="get" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Get.php" target="_blank" rel="noopener noreferrer">Get</a> <a class="header-anchor" href="#get" aria-hidden="true">#</a></h3><h4 id="allowed-in-10" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-10" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-9" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-9" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-8" tabindex="-1">Properties <a class="header-anchor" href="#properties-8" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="head" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Head.php" target="_blank" rel="noopener noreferrer">Head</a> <a class="header-anchor" href="#head" aria-hidden="true">#</a></h3><h4 id="allowed-in-11" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-11" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-10" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-10" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-9" tabindex="-1">Properties <a class="header-anchor" href="#properties-9" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="header" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Header.php" target="_blank" rel="noopener noreferrer">Header</a> <a class="header-anchor" href="#header" aria-hidden="true">#</a></h3><h4 id="allowed-in-12" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-12" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-11" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-11" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-10" tabindex="-1">Properties <a class="header-anchor" href="#properties-10" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>header</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>No details available.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>No details available.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.</p></dd></dl><h4 id="reference-5" tabindex="-1">Reference <a class="header-anchor" href="#reference-5" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject" target="_blank" rel="noopener noreferrer">OAI Header Object</a>.</li></ul><h3 id="headerparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/HeaderParameter.php" target="_blank" rel="noopener noreferrer">HeaderParameter</a> <a class="header-anchor" href="#headerparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\\Request</code> header parameter.</p><h4 id="allowed-in-13" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-13" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-12" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-12" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-11" tabindex="-1">Properties <a class="header-anchor" href="#properties-11" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;header&#39; as the default location.</p></dd></dl><h3 id="info" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Info.php" target="_blank" rel="noopener noreferrer">Info</a> <a class="header-anchor" href="#info" aria-hidden="true">#</a></h3><p>The object provides metadata about the API.</p><p>The metadata may be used by the clients if needed and may be presented in editing or documentation generation tools for convenience.</p><h4 id="allowed-in-14" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-14" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-13" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-13" aria-hidden="true">#</a></h4><hr><p><a href="#contact">Contact</a>, <a href="#license">License</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-12" tabindex="-1">Properties <a class="header-anchor" href="#properties-12" aria-hidden="true">#</a></h4><hr><dl><dt><strong>title</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The title of the application.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description of the application.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>termsOfService</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL to the Terms of Service for the API.<br><br> Must be in the format of an url.</p></dd><dt><strong>version</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).</p></dd></dl><h4 id="reference-6" tabindex="-1">Reference <a class="header-anchor" href="#reference-6" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object" target="_blank" rel="noopener noreferrer">OAI Info Object</a></li></ul><h3 id="items" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Items.php" target="_blank" rel="noopener noreferrer">Items</a> <a class="header-anchor" href="#items" aria-hidden="true">#</a></h3><p>The description of an item in a Schema with type <code>array</code>.</p><h4 id="allowed-in-15" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-15" aria-hidden="true">#</a></h4><hr><p><a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#items">Items</a></p><h4 id="nested-elements-14" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-14" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h3 id="jsoncontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/JsonContent.php" target="_blank" rel="noopener noreferrer">JsonContent</a> <a class="header-anchor" href="#jsoncontent" aria-hidden="true">#</a></h3><p>Shorthand for a json response.</p><p>Use as <code>@OA\\Schema</code> inside a <code>Response</code> and <code>MediaType</code>-&gt;<code>&#39;application/json&#39;</code> will be generated.</p><h4 id="nested-elements-15" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-15" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h3 id="license" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/License.php" target="_blank" rel="noopener noreferrer">License</a> <a class="header-anchor" href="#license" aria-hidden="true">#</a></h3><p>License information for the exposed API.</p><h4 id="allowed-in-16" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-16" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-16" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-16" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-13" tabindex="-1">Properties <a class="header-anchor" href="#properties-13" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The license name used for the API.</p></dd><dt><strong>identifier</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL to the license used for the API. This MUST be in the form of a URL.<br><br> The `url` field is mutually exclusive of the `identifier` field.</p></dd></dl><h4 id="reference-7" tabindex="-1">Reference <a class="header-anchor" href="#reference-7" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object" target="_blank" rel="noopener noreferrer">OAI License Object</a></li></ul><h3 id="link" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Link.php" target="_blank" rel="noopener noreferrer">Link</a> <a class="header-anchor" href="#link" aria-hidden="true">#</a></h3><p>The Link object represents a possible design-time link for a response.</p><p>The presence of a link does not guarantee the caller&#39;s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.</p><p>Unlike dynamic links (i.e. links provided in the response payload), the OA linking mechanism does not require link information in the runtime response.</p><p>For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.</p><h4 id="allowed-in-17" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-17" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-17" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-17" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-14" tabindex="-1">Properties <a class="header-anchor" href="#properties-14" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>link</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into MediaType-&gt;links array.</p></dd><dt><strong>operationRef</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A relative or absolute reference to an OA operation.<br><br> This field is mutually exclusive of the <code>operationId</code> field, and must point to an Operation object.<br><br> Relative values may be used to locate an existing Operation object in the OpenAPI definition.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of an existing, resolvable OA operation, as defined with a unique <code>operationId</code>.<br><br> This field is mutually exclusive of the <code>operationRef</code> field.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map representing parameters to pass to an operation as specified with operationId or identified via<br> operationRef.<br><br> The key is the parameter name to be used, whereas the value can be a constant or an expression to<br> be evaluated and passed to the linked operation.<br> The parameter name can be qualified using the parameter location [{in}.]{name} for operations<br> that use the same parameter name in different locations (e.g. path.id).</p></dd><dt><strong>requestBody</strong></dt><dd><p>A literal value or {expression} to use as a request body when calling the target operation.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A description of the link.<br><br> CommonMark syntax may be used for rich text representation.</p></dd></dl><h4 id="reference-8" tabindex="-1">Reference <a class="header-anchor" href="#reference-8" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object" target="_blank" rel="noopener noreferrer">OAI Link Object</a></li></ul><h3 id="mediatype" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/MediaType.php" target="_blank" rel="noopener noreferrer">MediaType</a> <a class="header-anchor" href="#mediatype" aria-hidden="true">#</a></h3><p>Each Media Type object provides schema and examples for the media type identified by its key.</p><h4 id="allowed-in-18" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-18" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#requestbody">RequestBody</a></p><h4 id="nested-elements-18" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-18" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-15" tabindex="-1">Properties <a class="header-anchor" href="#properties-15" aria-hidden="true">#</a></h4><hr><dl><dt><strong>mediaType</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Operation-&gt;content array.</p></dd><dt><strong>example</strong></dt><dd><p>Example of the media type.<br><br> The example object should be in the correct format as specified by the media type.<br> The example object is mutually exclusive of the examples object.<br><br> Furthermore, if referencing a schema which contains an example,<br> the example value shall override the example provided by the schema.</p></dd><dt><strong>encoding</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map between a property name and its encoding information.<br><br> The key, being the property name, must exist in the schema as a property.<br><br> The encoding object shall only apply to requestBody objects when the media type is multipart or<br> application/x-www-form-urlencoded.</p></dd></dl><h4 id="reference-9" tabindex="-1">Reference <a class="header-anchor" href="#reference-9" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object" target="_blank" rel="noopener noreferrer">OAI Media Type Object</a></li></ul><h3 id="openapi" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/OpenApi.php" target="_blank" rel="noopener noreferrer">OpenApi</a> <a class="header-anchor" href="#openapi" aria-hidden="true">#</a></h3><p>This is the root document object for the API specification.</p><h4 id="nested-elements-19" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-19" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a>, <a href="#server">Server</a>, <a href="#pathitem">PathItem</a>, <a href="#components">Components</a>, <a href="#tag">Tag</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#webhook">Webhook</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-16" tabindex="-1">Properties <a class="header-anchor" href="#properties-16" aria-hidden="true">#</a></h4><hr><dl><dt><strong>openapi</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The semantic version number of the OpenAPI Specification version that the OpenAPI document uses.<br><br> The openapi field should be used by tooling specifications and clients to interpret the OpenAPI document.<br><br> A version specified via `Generator::setVersion()` will overwrite this value.<br><br> This is not related to the API info::version string.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>A declaration of which security mechanisms can be used across the API.<br><br> The list of values includes alternative security requirement objects that can be used.<br> Only one of the security requirement objects need to be satisfied to authorize a request.<br> Individual operations can override this definition.<br> To make security optional, an empty security requirement `({})` can be included in the array.</p></dd></dl><h4 id="reference-10" tabindex="-1">Reference <a class="header-anchor" href="#reference-10" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#openapi-object" target="_blank" rel="noopener noreferrer">OAI OpenApi Object</a></li></ul><h3 id="options" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Options.php" target="_blank" rel="noopener noreferrer">Options</a> <a class="header-anchor" href="#options" aria-hidden="true">#</a></h3><h4 id="allowed-in-19" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-19" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-20" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-20" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-17" tabindex="-1">Properties <a class="header-anchor" href="#properties-17" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="parameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Parameter.php" target="_blank" rel="noopener noreferrer">Parameter</a> <a class="header-anchor" href="#parameter" aria-hidden="true">#</a></h3><p>Describes a single operation parameter.</p><p>A unique parameter is defined by a combination of a name and location.</p><h4 id="allowed-in-20" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-20" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-21" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-21" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-18" tabindex="-1">Properties <a class="header-anchor" href="#properties-18" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>parameter</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The location of the parameter.<br><br> Possible values are &quot;query&quot;, &quot;header&quot;, &quot;path&quot; or &quot;cookie&quot;.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>example</strong></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>matrix</strong></dt><dd><p>Path-style parameters defined by RFC6570.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.7">RFC6570</a></p></dd><dt><strong>label</strong></dt><dd><p>Label style parameters defined by RFC6570.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.5">RFC6570</a></p></dd><dt><strong>form</strong></dt><dd><p>Form style parameters defined by RFC6570.<br><br> This option replaces collectionFormat with a csv (when explode is false) or multi (when explode is true) value from OpenAPI 2.0.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.8">RFC6570</a></p></dd><dt><strong>simple</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Simple style parameters defined by RFC6570.<br><br> This option replaces collectionFormat with a csv value from OpenAPI 2.0.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.2">RFC6570</a></p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>deepObject</strong></dt><dd><p>Provides a simple way of rendering nested objects using form parameters.</p></dd></dl><h4 id="reference-11" tabindex="-1">Reference <a class="header-anchor" href="#reference-11" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object" target="_blank" rel="noopener noreferrer">OAA Parameter Object</a></li></ul><h3 id="patch" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Patch.php" target="_blank" rel="noopener noreferrer">Patch</a> <a class="header-anchor" href="#patch" aria-hidden="true">#</a></h3><h4 id="allowed-in-21" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-21" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-22" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-22" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-19" tabindex="-1">Properties <a class="header-anchor" href="#properties-19" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="pathitem" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/PathItem.php" target="_blank" rel="noopener noreferrer">PathItem</a> <a class="header-anchor" href="#pathitem" aria-hidden="true">#</a></h3><p>Describes the operations available on a single path.</p><p>A Path Item may be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer, but they will not know which operations and parameters are available.</p><h4 id="allowed-in-22" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-22" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-23" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-23" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-20" tabindex="-1">Properties <a class="header-anchor" href="#properties-20" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional, string summary, intended to apply to all operations in this path.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional, string description, intended to apply to all operations in this path.</p></dd><dt><strong>path</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Key for the Path Object (OpenApi-&gt;paths array).</p></dd></dl><h4 id="reference-12" tabindex="-1">Reference <a class="header-anchor" href="#reference-12" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object" target="_blank" rel="noopener noreferrer">OAI Path Item Object</a></li></ul><h3 id="pathparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/PathParameter.php" target="_blank" rel="noopener noreferrer">PathParameter</a> <a class="header-anchor" href="#pathparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\\Request</code> path parameter.</p><h4 id="allowed-in-23" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-23" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-24" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-24" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-21" tabindex="-1">Properties <a class="header-anchor" href="#properties-21" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;path&#39; as the default location.</p></dd><dt><strong>required</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="post" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Post.php" target="_blank" rel="noopener noreferrer">Post</a> <a class="header-anchor" href="#post" aria-hidden="true">#</a></h3><h4 id="allowed-in-24" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-24" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-25" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-25" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-22" tabindex="-1">Properties <a class="header-anchor" href="#properties-22" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="property" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Property.php" target="_blank" rel="noopener noreferrer">Property</a> <a class="header-anchor" href="#property" aria-hidden="true">#</a></h3><h4 id="allowed-in-25" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-25" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#property">Property</a>, <a href="#items">Items</a></p><h4 id="nested-elements-26" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-26" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-23" tabindex="-1">Properties <a class="header-anchor" href="#properties-23" aria-hidden="true">#</a></h4><hr><dl><dt><strong>property</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Schema-&gt;properties array.</p></dd></dl><h3 id="put" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Put.php" target="_blank" rel="noopener noreferrer">Put</a> <a class="header-anchor" href="#put" aria-hidden="true">#</a></h3><h4 id="allowed-in-26" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-26" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-27" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-27" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-24" tabindex="-1">Properties <a class="header-anchor" href="#properties-24" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="queryparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/QueryParameter.php" target="_blank" rel="noopener noreferrer">QueryParameter</a> <a class="header-anchor" href="#queryparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\\Request</code> query parameter.</p><h4 id="allowed-in-27" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-27" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-28" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-28" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-25" tabindex="-1">Properties <a class="header-anchor" href="#properties-25" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;query&#39; as the default location.</p></dd></dl><h3 id="requestbody" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/RequestBody.php" target="_blank" rel="noopener noreferrer">RequestBody</a> <a class="header-anchor" href="#requestbody" aria-hidden="true">#</a></h3><p>Describes a single request body.</p><h4 id="allowed-in-28" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-28" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#delete">Delete</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#patch">Patch</a>, <a href="#post">Post</a>, <a href="#trace">Trace</a>, <a href="#put">Put</a></p><h4 id="nested-elements-29" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-29" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-26" tabindex="-1">Properties <a class="header-anchor" href="#properties-26" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to a request body.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>request</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Components-&gt;requestBodies array.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd></dl><h4 id="reference-13" tabindex="-1">Reference <a class="header-anchor" href="#reference-13" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#requestBodyObject" target="_blank" rel="noopener noreferrer">OAI Request Body Object</a></li></ul><h3 id="response" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Response.php" target="_blank" rel="noopener noreferrer">Response</a> <a class="header-anchor" href="#response" aria-hidden="true">#</a></h3><p>Describes a single response from an API Operation, including design-time, static links to operations based on the response.</p><h4 id="allowed-in-29" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-29" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#patch">Patch</a>, <a href="#delete">Delete</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-30" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-30" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#header">Header</a>, <a href="#link">Link</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-27" tabindex="-1">Properties <a class="header-anchor" href="#properties-27" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to a response.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>response</strong> : <span style="font-family:monospace;">string|int</span></dt><dd><p>The key into Operations-&gt;responses array.<br><br> A HTTP status code or <code>default</code>.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description of the response.<br><br> CommonMark syntax may be used for rich text representation.</p></dd></dl><h4 id="reference-14" tabindex="-1">Reference <a class="header-anchor" href="#reference-14" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object" target="_blank" rel="noopener noreferrer">OAI Response Object</a></li></ul><h3 id="schema" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Schema.php" target="_blank" rel="noopener noreferrer">Schema</a> <a class="header-anchor" href="#schema" aria-hidden="true">#</a></h3><p>The definition of input and output data types.</p><p>These types can be objects, but also primitives and arrays.</p><p>This object is based on the <a href="http://json-schema.org" target="_blank" rel="noopener noreferrer">JSON Schema Specification</a> and uses a predefined subset of it. On top of this subset, there are extensions provided by this specification to allow for more complete documentation.</p><h4 id="allowed-in-30" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-30" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#header">Header</a></p><h4 id="nested-elements-31" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-31" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#examples">Examples</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-28" tabindex="-1">Properties <a class="header-anchor" href="#properties-28" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">bool|int|float</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">bool|int|float</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum&gt;|class-string</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>multipleOf</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>A numeric instance is valid against &quot;multipleOf&quot; if the result of the division of the instance by this<br> property&#39;s value is an integer.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>example</strong></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Attributes\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Attributes\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Attributes\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>not</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.29.</p></dd><dt><strong>additionalItems</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.10.</p></dd><dt><strong>contains</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.14.</p></dd><dt><strong>patternProperties</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.19.</p></dd><dt><strong>dependencies</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.21.</p></dd><dt><strong>propertyNames</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.22.</p></dd><dt><strong>const</strong></dt><dd><p>http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.</p></dd></dl><h4 id="reference-15" tabindex="-1">Reference <a class="header-anchor" href="#reference-15" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject" target="_blank" rel="noopener noreferrer">OAI Schema Object</a></li><li><a href="http://json-schema.org/" target="_blank" rel="noopener noreferrer">JSON Schema</a></li></ul><h3 id="securityscheme" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/SecurityScheme.php" target="_blank" rel="noopener noreferrer">SecurityScheme</a> <a class="header-anchor" href="#securityscheme" aria-hidden="true">#</a></h3><h4 id="allowed-in-31" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-31" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a></p><h4 id="nested-elements-32" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-32" aria-hidden="true">#</a></h4><hr><p><a href="#flow">Flow</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-29" tabindex="-1">Properties <a class="header-anchor" href="#properties-29" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to a security scheme.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>securityScheme</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into OpenApi-&gt;security array.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;</span></dt><dd><p>The type of the security scheme.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description for security scheme.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the header or query parameter to be used.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Required The location of the API key.</p></dd><dt><strong>bearerFormat</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A hint to the client to identify how the bearer token is formatted.<br><br> Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.</p></dd><dt><strong>scheme</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the HTTP Authorization scheme.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc7235#section-5.1">RFC7235</a></p></dd><dt><strong>openIdConnectUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.</p></dd></dl><h4 id="reference-16" tabindex="-1">Reference <a class="header-anchor" href="#reference-16" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject" target="_blank" rel="noopener noreferrer">OAI Security Scheme Object</a>.</li></ul><h3 id="server" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Server.php" target="_blank" rel="noopener noreferrer">Server</a> <a class="header-anchor" href="#server" aria-hidden="true">#</a></h3><p>An object representing a server.</p><h4 id="allowed-in-32" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-32" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#link">Link</a></p><h4 id="nested-elements-33" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-33" aria-hidden="true">#</a></h4><hr><p><a href="#servervariable">ServerVariable</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-30" tabindex="-1">Properties <a class="header-anchor" href="#properties-30" aria-hidden="true">#</a></h4><hr><dl><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL to the target host.<br><br> This URL supports Server Variables and may be relative,<br> to indicate that the host location is relative to the location where the OpenAPI document is being served.<br> Variable substitutions will be made when a variable is named in {brackets}.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional string describing the host designated by the URL.<br><br> CommonMark syntax may be used for rich text representation.</p></dd></dl><h4 id="reference-17" tabindex="-1">Reference <a class="header-anchor" href="#reference-17" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object" target="_blank" rel="noopener noreferrer">OAI Server Object</a></li></ul><h3 id="servervariable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/ServerVariable.php" target="_blank" rel="noopener noreferrer">ServerVariable</a> <a class="header-anchor" href="#servervariable" aria-hidden="true">#</a></h3><p>An object representing a server variable for server URL template substitution.</p><h4 id="allowed-in-33" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-33" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a></p><h4 id="nested-elements-34" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-34" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-31" tabindex="-1">Properties <a class="header-anchor" href="#properties-31" aria-hidden="true">#</a></h4><hr><dl><dt><strong>serverVariable</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Server-&gt;variables array.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum&gt;|class-string</span></dt><dd><p>An enumeration of values to be used if the substitution options are from a limited set.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The default value to use for substitution, and to send, if an alternate value is not supplied.<br><br> Unlike the Schema Object&#39;s default, this value must be provided by the consumer.</p></dd><dt><strong>variables</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>A map between a variable name and its value.<br><br> The value is used for substitution in the server&#39;s URL template.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional description for the server variable.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd></dl><h4 id="reference-18" tabindex="-1">Reference <a class="header-anchor" href="#reference-18" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object" target="_blank" rel="noopener noreferrer">OAI Server Variable Object</a></li></ul><h3 id="tag" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Tag.php" target="_blank" rel="noopener noreferrer">Tag</a> <a class="header-anchor" href="#tag" aria-hidden="true">#</a></h3><h4 id="allowed-in-34" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-34" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-35" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-35" aria-hidden="true">#</a></h4><hr><p><a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-32" tabindex="-1">Properties <a class="header-anchor" href="#properties-32" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the tag.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description for the tag. GFM syntax can be used for rich text representation.</p></dd></dl><h4 id="reference-19" tabindex="-1">Reference <a class="header-anchor" href="#reference-19" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#tagObject" target="_blank" rel="noopener noreferrer">OAI Tag Object</a>.</li></ul><h3 id="trace" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Trace.php" target="_blank" rel="noopener noreferrer">Trace</a> <a class="header-anchor" href="#trace" aria-hidden="true">#</a></h3><h4 id="allowed-in-35" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-35" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-36" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-36" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-33" tabindex="-1">Properties <a class="header-anchor" href="#properties-33" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="webhook" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Webhook.php" target="_blank" rel="noopener noreferrer">Webhook</a> <a class="header-anchor" href="#webhook" aria-hidden="true">#</a></h3><p>Acts like a <code>PathItem</code> with the main difference being that it requires <code>webhook</code> instead of <code>path</code>.</p><h4 id="allowed-in-36" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-36" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-37" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-37" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-34" tabindex="-1">Properties <a class="header-anchor" href="#properties-34" aria-hidden="true">#</a></h4><hr><dl><dt><strong>webhook</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Key for the webhooks map.</p></dd></dl><h3 id="xml" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Xml.php" target="_blank" rel="noopener noreferrer">Xml</a> <a class="header-anchor" href="#xml" aria-hidden="true">#</a></h3><h4 id="allowed-in-37" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-37" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#schema">Schema</a>, <a href="#items">Items</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-38" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-38" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-35" tabindex="-1">Properties <a class="header-anchor" href="#properties-35" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Replaces the name of the element/attribute used for the described schema property.<br><br> When defined within the Items Object (items), it will affect the name of the individual XML elements within the list.<br> When defined alongside type being array (outside the items), it will affect the wrapping element<br> and only if wrapped is <code>true</code>.<br><br> If wrapped is <code>false</code>, it will be ignored.</p></dd><dt><strong>namespace</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL of the namespace definition. Value SHOULD be in the form of a URL.</p></dd><dt><strong>prefix</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The prefix to be used for the name.</p></dd><dt><strong>attribute</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Declares whether the property definition translates to an attribute instead of an element.<br><br> Default value is <code>false</code>.</p></dd><dt><strong>wrapped</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>MAY be used only for an array definition.<br><br> Signifies whether the array is wrapped (for example <code>&lt;books&gt;&lt;book/&gt;&lt;book/&gt;&lt;/books&gt;</code>)<br> or unwrapped (<code>&lt;book/&gt;&lt;book/&gt;</code>).<br><br> Default value is false. The definition takes effect only when defined alongside type being array (outside the items).</p></dd></dl><h4 id="reference-20" tabindex="-1">Reference <a class="header-anchor" href="#reference-20" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#xmlObject" target="_blank" rel="noopener noreferrer">OAI XML Object</a>.</li></ul><h3 id="xmlcontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/XmlContent.php" target="_blank" rel="noopener noreferrer">XmlContent</a> <a class="header-anchor" href="#xmlcontent" aria-hidden="true">#</a></h3><p>Shorthand for a xml response.</p><p>Use as <code>@OA\\Schema</code> inside a <code>Response</code> and <code>MediaType</code>-&gt;<code>&#39;application/xml&#39;</code> will be generated.</p><h4 id="nested-elements-39" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-39" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p>',490),o=[s];function i(d,h,p,l,c,f){return t(),a("div",null,o)}var u=e(n,[["render",i]]);export{b as __pageData,u as default};
diff --git a/assets/reference_annotations.md.93df9735.lean.js b/assets/reference_annotations.md.93df9735.lean.js
new file mode 100644
index 00000000..4fdafa78
--- /dev/null
+++ b/assets/reference_annotations.md.93df9735.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as a,o as t,a as r}from"./app.850f5e05.js";const b='{"title":"Annotation Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Annotations","slug":"annotations"},{"level":3,"title":"AdditionalProperties","slug":"additionalproperties"},{"level":3,"title":"Attachable","slug":"attachable"},{"level":3,"title":"Components","slug":"components"},{"level":3,"title":"Contact","slug":"contact"},{"level":3,"title":"CookieParameter","slug":"cookieparameter"},{"level":3,"title":"Delete","slug":"delete"},{"level":3,"title":"Discriminator","slug":"discriminator"},{"level":3,"title":"Examples","slug":"examples"},{"level":3,"title":"ExternalDocumentation","slug":"externaldocumentation"},{"level":3,"title":"Flow","slug":"flow"},{"level":3,"title":"Get","slug":"get"},{"level":3,"title":"Head","slug":"head"},{"level":3,"title":"Header","slug":"header"},{"level":3,"title":"HeaderParameter","slug":"headerparameter"},{"level":3,"title":"Info","slug":"info"},{"level":3,"title":"Items","slug":"items"},{"level":3,"title":"JsonContent","slug":"jsoncontent"},{"level":3,"title":"License","slug":"license"},{"level":3,"title":"Link","slug":"link"},{"level":3,"title":"MediaType","slug":"mediatype"},{"level":3,"title":"OpenApi","slug":"openapi"},{"level":3,"title":"Options","slug":"options"},{"level":3,"title":"Parameter","slug":"parameter"},{"level":3,"title":"Patch","slug":"patch"},{"level":3,"title":"PathItem","slug":"pathitem"},{"level":3,"title":"PathParameter","slug":"pathparameter"},{"level":3,"title":"Post","slug":"post"},{"level":3,"title":"Property","slug":"property"},{"level":3,"title":"Put","slug":"put"},{"level":3,"title":"QueryParameter","slug":"queryparameter"},{"level":3,"title":"RequestBody","slug":"requestbody"},{"level":3,"title":"Response","slug":"response"},{"level":3,"title":"Schema","slug":"schema"},{"level":3,"title":"SecurityScheme","slug":"securityscheme"},{"level":3,"title":"Server","slug":"server"},{"level":3,"title":"ServerVariable","slug":"servervariable"},{"level":3,"title":"Tag","slug":"tag"},{"level":3,"title":"Trace","slug":"trace"},{"level":3,"title":"Webhook","slug":"webhook"},{"level":3,"title":"Xml","slug":"xml"},{"level":3,"title":"XmlContent","slug":"xmlcontent"}],"relativePath":"reference/annotations.md"}',n={},s=r("",490),o=[s];function i(d,h,p,l,c,f){return t(),a("div",null,o)}var u=e(n,[["render",i]]);export{b as __pageData,u as default};
diff --git a/assets/reference_attributes.md.0f7b8389.js b/assets/reference_attributes.md.0f7b8389.js
new file mode 100644
index 00000000..fbd8bfea
--- /dev/null
+++ b/assets/reference_attributes.md.0f7b8389.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o as a,a as n}from"./app.850f5e05.js";const u='{"title":"Attribute Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Attributes","slug":"attributes"},{"level":3,"title":"AdditionalProperties","slug":"additionalproperties"},{"level":3,"title":"Attachable","slug":"attachable"},{"level":3,"title":"Components","slug":"components"},{"level":3,"title":"Contact","slug":"contact"},{"level":3,"title":"CookieParameter","slug":"cookieparameter"},{"level":3,"title":"Delete","slug":"delete"},{"level":3,"title":"Discriminator","slug":"discriminator"},{"level":3,"title":"Examples","slug":"examples"},{"level":3,"title":"ExternalDocumentation","slug":"externaldocumentation"},{"level":3,"title":"Flow","slug":"flow"},{"level":3,"title":"Get","slug":"get"},{"level":3,"title":"Head","slug":"head"},{"level":3,"title":"Header","slug":"header"},{"level":3,"title":"HeaderParameter","slug":"headerparameter"},{"level":3,"title":"Info","slug":"info"},{"level":3,"title":"Items","slug":"items"},{"level":3,"title":"JsonContent","slug":"jsoncontent"},{"level":3,"title":"License","slug":"license"},{"level":3,"title":"Link","slug":"link"},{"level":3,"title":"MediaType","slug":"mediatype"},{"level":3,"title":"OpenApi","slug":"openapi"},{"level":3,"title":"Options","slug":"options"},{"level":3,"title":"Parameter","slug":"parameter"},{"level":3,"title":"Patch","slug":"patch"},{"level":3,"title":"PathItem","slug":"pathitem"},{"level":3,"title":"PathParameter","slug":"pathparameter"},{"level":3,"title":"Post","slug":"post"},{"level":3,"title":"Property","slug":"property"},{"level":3,"title":"Put","slug":"put"},{"level":3,"title":"QueryParameter","slug":"queryparameter"},{"level":3,"title":"RequestBody","slug":"requestbody"},{"level":3,"title":"Response","slug":"response"},{"level":3,"title":"Schema","slug":"schema"},{"level":3,"title":"SecurityScheme","slug":"securityscheme"},{"level":3,"title":"Server","slug":"server"},{"level":3,"title":"ServerVariable","slug":"servervariable"},{"level":3,"title":"Tag","slug":"tag"},{"level":3,"title":"Trace","slug":"trace"},{"level":3,"title":"Webhook","slug":"webhook"},{"level":3,"title":"Xml","slug":"xml"},{"level":3,"title":"XmlContent","slug":"xmlcontent"}],"relativePath":"reference/attributes.md"}',s={},r=n('<h1 id="attribute-reference" tabindex="-1">Attribute Reference <a class="header-anchor" href="#attribute-reference" aria-hidden="true">#</a></h1><p>This page is generated automatically from the <code>swagger-php</code> sources.</p><p>For improvements head over to <a href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer">GitHub</a> and create a PR \u{1F609}</p><p>In addition to this page, there are also a number of <a href="https://github.com/zircote/swagger-php/tree/master/Examples#readme" target="_blank" rel="noopener noreferrer">examples</a> which might help you out.</p><h2 id="attributes" tabindex="-1">Attributes <a class="header-anchor" href="#attributes" aria-hidden="true">#</a></h2><h3 id="additionalproperties" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/AdditionalProperties.php" target="_blank" rel="noopener noreferrer">AdditionalProperties</a> <a class="header-anchor" href="#additionalproperties" aria-hidden="true">#</a></h3><h4 id="allowed-in" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#additionalproperties">AdditionalProperties</a></p><h4 id="nested-elements" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="attachable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Attachable.php" target="_blank" rel="noopener noreferrer">Attachable</a> <a class="header-anchor" href="#attachable" aria-hidden="true">#</a></h3><h4 id="allowed-in-1" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-1" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#components">Components</a>, <a href="#contact">Contact</a>, <a href="#delete">Delete</a>, <a href="#discriminator">Discriminator</a>, <a href="#examples">Examples</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#flow">Flow</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#header">Header</a>, <a href="#info">Info</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#license">License</a>, <a href="#link">Link</a>, <a href="#mediatype">MediaType</a>, <a href="#openapi">OpenApi</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#patch">Patch</a>, <a href="#pathitem">PathItem</a>, <a href="#pathparameter">PathParameter</a>, <a href="#post">Post</a>, <a href="#property">Property</a>, <a href="#put">Put</a>, <a href="#requestbody">RequestBody</a>, <a href="#response">Response</a>, <a href="#schema">Schema</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#server">Server</a>, <a href="#servervariable">ServerVariable</a>, <a href="#tag">Tag</a>, <a href="#trace">Trace</a>, <a href="#webhook">Webhook</a>, <a href="#xml">Xml</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-hidden="true">#</a></h4><hr><dl><dt><strong>properties</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>No details available.</p></dd></dl><h3 id="components" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Components.php" target="_blank" rel="noopener noreferrer">Components</a> <a class="header-anchor" href="#components" aria-hidden="true">#</a></h3><h4 id="allowed-in-2" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-2" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-1" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-1" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#requestbody">RequestBody</a>, <a href="#examples">Examples</a>, <a href="#header">Header</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#link">Link</a>, <a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-hidden="true">#</a></h4><hr><dl><dt><strong>schemas</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;|null</span></dt><dd><p>Reusable Schemas.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]|null</span></dt><dd><p>Reusable Responses.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]|null</span></dt><dd><p>Reusable Parameters.</p></dd><dt><strong>requestBodies</strong> : <span style="font-family:monospace;">RequestBody[]|null</span></dt><dd><p>Reusable Request Bodies.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;|null</span></dt><dd><p>Reusable Examples.</p></dd><dt><strong>headers</strong> : <span style="font-family:monospace;">Header[]|null</span></dt><dd><p>Reusable Headers.</p></dd><dt><strong>securitySchemes</strong> : <span style="font-family:monospace;">SecurityScheme[]|null</span></dt><dd><p>Reusable Security Schemes.</p></dd><dt><strong>links</strong> : <span style="font-family:monospace;">Link[]|null</span></dt><dd><p>Reusable Links.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Reusable Callbacks.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="contact" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Contact.php" target="_blank" rel="noopener noreferrer">Contact</a> <a class="header-anchor" href="#contact" aria-hidden="true">#</a></h3><h4 id="allowed-in-3" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-3" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-2" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-2" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-3" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-3" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The identifying name of the contact person/organization.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL pointing to the contact information.</p></dd><dt><strong>email</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The email address of the contact person/organization.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="cookieparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/CookieParameter.php" target="_blank" rel="noopener noreferrer">CookieParameter</a> <a class="header-anchor" href="#cookieparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-4" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-4" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-3" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-3" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-4" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-4" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;cookie&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="delete" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Delete.php" target="_blank" rel="noopener noreferrer">Delete</a> <a class="header-anchor" href="#delete" aria-hidden="true">#</a></h3><h4 id="allowed-in-5" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-5" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-4" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-4" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-5" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-5" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="discriminator" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Discriminator.php" target="_blank" rel="noopener noreferrer">Discriminator</a> <a class="header-anchor" href="#discriminator" aria-hidden="true">#</a></h3><h4 id="allowed-in-6" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-6" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-5" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-5" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-6" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-6" aria-hidden="true">#</a></h4><hr><dl><dt><strong>propertyName</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the property in the payload that will hold the discriminator value.</p></dd><dt><strong>mapping</strong> : <span style="font-family:monospace;">string[]|null</span></dt><dd><p>An object to hold mappings between payload values and schema names or references.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="examples" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Examples.php" target="_blank" rel="noopener noreferrer">Examples</a> <a class="header-anchor" href="#examples" aria-hidden="true">#</a></h3><h4 id="allowed-in-7" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-7" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#schema">Schema</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-6" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-6" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-7" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-7" aria-hidden="true">#</a></h4><hr><dl><dt><strong>example</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into `#/components/examples`.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Short description for the example.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>value</strong> : <span style="font-family:monospace;">array|string|int|null</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>externalValue</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL that points to the literal example.<br><br> This provides the capability to reference examples that cannot easily be included<br> in JSON or YAML documents.<br><br> The value field and externalValue field are mutually exclusive.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to an example.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="externaldocumentation" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/ExternalDocumentation.php" target="_blank" rel="noopener noreferrer">ExternalDocumentation</a> <a class="header-anchor" href="#externaldocumentation" aria-hidden="true">#</a></h3><h4 id="allowed-in-8" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-8" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#tag">Tag</a>, <a href="#schema">Schema</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#property">Property</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-7" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-7" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-8" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-8" aria-hidden="true">#</a></h4><hr><dl><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description of the target documentation. GFM syntax can be used for rich text representation.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL for the target documentation.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="flow" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Flow.php" target="_blank" rel="noopener noreferrer">Flow</a> <a class="header-anchor" href="#flow" aria-hidden="true">#</a></h3><h4 id="allowed-in-9" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-9" aria-hidden="true">#</a></h4><hr><p><a href="#securityscheme">SecurityScheme</a></p><h4 id="nested-elements-8" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-8" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-9" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-9" aria-hidden="true">#</a></h4><hr><dl><dt><strong>authorizationUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The authorization url to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>tokenUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The token URL to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>refreshUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL to be used for obtaining refresh tokens.<br><br> This must be in the form of an url.</p></dd><dt><strong>flow</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Flow name.<br><br> One of [&#39;implicit&#39;, &#39;password&#39;, &#39;authorizationCode&#39;, &#39;clientCredentials&#39;].</p></dd><dt><strong>scopes</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>The available scopes for the OAuth2 security scheme.<br><br> A map between the scope name and a short description for it.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="get" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Get.php" target="_blank" rel="noopener noreferrer">Get</a> <a class="header-anchor" href="#get" aria-hidden="true">#</a></h3><h4 id="allowed-in-10" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-10" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-9" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-9" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-10" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-10" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="head" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Head.php" target="_blank" rel="noopener noreferrer">Head</a> <a class="header-anchor" href="#head" aria-hidden="true">#</a></h3><h4 id="allowed-in-11" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-11" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-10" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-10" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-11" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-11" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="header" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Header.php" target="_blank" rel="noopener noreferrer">Header</a> <a class="header-anchor" href="#header" aria-hidden="true">#</a></h3><h4 id="allowed-in-12" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-12" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-11" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-11" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-12" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-12" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>header</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>No details available.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>No details available.</p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Schema|null</span></dt><dd><p>Schema object.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="headerparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/HeaderParameter.php" target="_blank" rel="noopener noreferrer">HeaderParameter</a> <a class="header-anchor" href="#headerparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-13" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-13" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-12" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-12" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-13" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-13" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;header&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="info" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Info.php" target="_blank" rel="noopener noreferrer">Info</a> <a class="header-anchor" href="#info" aria-hidden="true">#</a></h3><h4 id="allowed-in-14" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-14" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-13" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-13" aria-hidden="true">#</a></h4><hr><p><a href="#contact">Contact</a>, <a href="#license">License</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-14" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-14" aria-hidden="true">#</a></h4><hr><dl><dt><strong>version</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description of the application.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The title of the application.</p></dd><dt><strong>termsOfService</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL to the Terms of Service for the API.<br><br> Must be in the format of an url.</p></dd><dt><strong>contact</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Contact|null</span></dt><dd><p>The contact information for the exposed API.</p></dd><dt><strong>license</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\License|null</span></dt><dd><p>The license information for the exposed API.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="items" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Items.php" target="_blank" rel="noopener noreferrer">Items</a> <a class="header-anchor" href="#items" aria-hidden="true">#</a></h3><h4 id="allowed-in-15" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-15" aria-hidden="true">#</a></h4><hr><p><a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#items">Items</a></p><h4 id="nested-elements-14" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-14" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-15" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-15" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="jsoncontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/JsonContent.php" target="_blank" rel="noopener noreferrer">JsonContent</a> <a class="header-anchor" href="#jsoncontent" aria-hidden="true">#</a></h3><h4 id="nested-elements-15" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-15" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-16" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-16" aria-hidden="true">#</a></h4><hr><dl><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the schema.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="license" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/License.php" target="_blank" rel="noopener noreferrer">License</a> <a class="header-anchor" href="#license" aria-hidden="true">#</a></h3><h4 id="allowed-in-16" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-16" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-16" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-16" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-17" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-17" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The license name used for the API.</p></dd><dt><strong>identifier</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL to the license used for the API. This MUST be in the form of a URL.<br><br> The `url` field is mutually exclusive of the `identifier` field.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="link" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Link.php" target="_blank" rel="noopener noreferrer">Link</a> <a class="header-anchor" href="#link" aria-hidden="true">#</a></h3><h4 id="allowed-in-17" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-17" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-17" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-17" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-18" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-18" aria-hidden="true">#</a></h4><hr><dl><dt><strong>link</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into MediaType-&gt;links array.</p></dd><dt><strong>operationRef</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A relative or absolute reference to an OA operation.<br><br> This field is mutually exclusive of the <code>operationId</code> field, and must point to an Operation object.<br><br> Relative values may be used to locate an existing Operation object in the OpenAPI definition.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of an existing, resolvable OA operation, as defined with a unique <code>operationId</code>.<br><br> This field is mutually exclusive of the <code>operationRef</code> field.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map representing parameters to pass to an operation as specified with operationId or identified via<br> operationRef.<br><br> The key is the parameter name to be used, whereas the value can be a constant or an expression to<br> be evaluated and passed to the linked operation.<br> The parameter name can be qualified using the parameter location [{in}.]{name} for operations<br> that use the same parameter name in different locations (e.g. path.id).</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A literal value or {expression} to use as a request body when calling the target operation.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description of the link.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>server</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Server|null</span></dt><dd><p>A server object to be used by the target operation.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="mediatype" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/MediaType.php" target="_blank" rel="noopener noreferrer">MediaType</a> <a class="header-anchor" href="#mediatype" aria-hidden="true">#</a></h3><h4 id="allowed-in-18" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-18" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#requestbody">RequestBody</a></p><h4 id="nested-elements-18" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-18" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-19" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-19" aria-hidden="true">#</a></h4><hr><dl><dt><strong>mediaType</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Operation-&gt;content array.</p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Schema|null</span></dt><dd><p>The schema defining the type used for the request body.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example object should be in the correct format as specified by the media type.<br> The example object is mutually exclusive of the examples object.<br><br> Furthermore, if referencing a schema which contains an example,<br> the example value shall override the example provided by the schema.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the media type.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>encoding</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map between a property name and its encoding information.<br><br> The key, being the property name, must exist in the schema as a property.<br><br> The encoding object shall only apply to requestBody objects when the media type is multipart or<br> application/x-www-form-urlencoded.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="openapi" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/OpenApi.php" target="_blank" rel="noopener noreferrer">OpenApi</a> <a class="header-anchor" href="#openapi" aria-hidden="true">#</a></h3><h4 id="nested-elements-19" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-19" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a>, <a href="#server">Server</a>, <a href="#pathitem">PathItem</a>, <a href="#components">Components</a>, <a href="#tag">Tag</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#webhook">Webhook</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-20" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-20" aria-hidden="true">#</a></h4><hr><dl><dt><strong>openapi</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The semantic version number of the OpenAPI Specification version that the OpenAPI document uses.<br><br> The openapi field should be used by tooling specifications and clients to interpret the OpenAPI document.<br><br> A version specified via `Generator::setVersion()` will overwrite this value.<br><br> This is not related to the API info::version string.</p></dd><dt><strong>info</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Info|null</span></dt><dd><p>Provides metadata about the API. The metadata may be used by tooling as required.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]|null</span></dt><dd><p>An array of <code>@Server</code> objects, which provide connectivity information to a target server.<br><br> If not provided, or is an empty array, the default value would be a Server Object with an url value of <code>/</code>.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used across the API.<br><br> The list of values includes alternative security requirement objects that can be used.<br> Only one of the security requirement objects need to be satisfied to authorize a request.<br> Individual operations can override this definition.<br> To make security optional, an empty security requirement `({})` can be included in the array.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">Tag[]|null</span></dt><dd><p>A list of tags used by the specification with additional metadata.<br><br> The order of the tags can be used to reflect on their order by the parsing tools.<br> Not all tags that are used by the Operation Object must be declared.<br> The tags that are not declared may be organized randomly or based on the tools&#39; logic.<br> Each tag name in the list must be unique.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation.</p></dd><dt><strong>paths</strong> : <span style="font-family:monospace;">PathItem[]|null</span></dt><dd><p>The available paths and operations for the API.</p></dd><dt><strong>components</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Components|null</span></dt><dd><p>An element to hold various components for the specification.</p></dd><dt><strong>webhooks</strong> : <span style="font-family:monospace;">Webhook[]|null</span></dt><dd><p>The available webhooks for the API.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="options" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Options.php" target="_blank" rel="noopener noreferrer">Options</a> <a class="header-anchor" href="#options" aria-hidden="true">#</a></h3><h4 id="allowed-in-19" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-19" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-20" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-20" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-21" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-21" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="parameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Parameter.php" target="_blank" rel="noopener noreferrer">Parameter</a> <a class="header-anchor" href="#parameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-20" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-20" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-21" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-21" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-22" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-22" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The location of the parameter.<br><br> Possible values are &quot;query&quot;, &quot;header&quot;, &quot;path&quot; or &quot;cookie&quot;.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="patch" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Patch.php" target="_blank" rel="noopener noreferrer">Patch</a> <a class="header-anchor" href="#patch" aria-hidden="true">#</a></h3><h4 id="allowed-in-21" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-21" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-22" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-22" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-23" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-23" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="pathitem" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathItem.php" target="_blank" rel="noopener noreferrer">PathItem</a> <a class="header-anchor" href="#pathitem" aria-hidden="true">#</a></h3><h4 id="allowed-in-22" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-22" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-23" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-23" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-24" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-24" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key for the Path Object (OpenApi-&gt;paths array).</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string summary, intended to apply to all operations in this path.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string description, intended to apply to all operations in this path.</p></dd><dt><strong>get</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Get|null</span></dt><dd><p>A definition of a GET operation on this path.</p></dd><dt><strong>put</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Put|null</span></dt><dd><p>A definition of a PUT operation on this path.</p></dd><dt><strong>post</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Post|null</span></dt><dd><p>A definition of a POST operation on this path.</p></dd><dt><strong>delete</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Delete|null</span></dt><dd><p>A definition of a DELETE operation on this path.</p></dd><dt><strong>options</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Options|null</span></dt><dd><p>A definition of a OPTIONS operation on this path.</p></dd><dt><strong>head</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Head|null</span></dt><dd><p>A definition of a HEAD operation on this path.</p></dd><dt><strong>patch</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Patch|null</span></dt><dd><p>A definition of a PATCH operation on this path.</p></dd><dt><strong>trace</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Trace|null</span></dt><dd><p>A definition of a TRACE operation on this path.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]|null</span></dt><dd><p>An alternative server array to service all operations in this path.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]|null</span></dt><dd><p>A list of parameters that are applicable for all the operations described under this path.<br><br> These parameters can be overridden at the operation level, but cannot be removed there.<br> The list must not include duplicated parameters.<br> A unique parameter is defined by a combination of a name and location.<br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s components/parameters.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="pathparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathParameter.php" target="_blank" rel="noopener noreferrer">PathParameter</a> <a class="header-anchor" href="#pathparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-23" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-23" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-24" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-24" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-25" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-25" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;path&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>No details available.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="post" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Post.php" target="_blank" rel="noopener noreferrer">Post</a> <a class="header-anchor" href="#post" aria-hidden="true">#</a></h3><h4 id="allowed-in-24" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-24" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-25" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-25" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-26" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-26" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="property" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Property.php" target="_blank" rel="noopener noreferrer">Property</a> <a class="header-anchor" href="#property" aria-hidden="true">#</a></h3><h4 id="allowed-in-25" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-25" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#property">Property</a>, <a href="#items">Items</a></p><h4 id="nested-elements-26" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-26" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-27" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-27" aria-hidden="true">#</a></h4><hr><dl><dt><strong>property</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Schema-&gt;properties array.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="put" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Put.php" target="_blank" rel="noopener noreferrer">Put</a> <a class="header-anchor" href="#put" aria-hidden="true">#</a></h3><h4 id="allowed-in-26" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-26" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-27" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-27" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-28" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-28" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="queryparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/QueryParameter.php" target="_blank" rel="noopener noreferrer">QueryParameter</a> <a class="header-anchor" href="#queryparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-27" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-27" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-28" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-28" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-29" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-29" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;query&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="requestbody" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/RequestBody.php" target="_blank" rel="noopener noreferrer">RequestBody</a> <a class="header-anchor" href="#requestbody" aria-hidden="true">#</a></h3><h4 id="allowed-in-28" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-28" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#delete">Delete</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#patch">Patch</a>, <a href="#post">Post</a>, <a href="#trace">Trace</a>, <a href="#put">Put</a></p><h4 id="nested-elements-29" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-29" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-30" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-30" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to a request body.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>request</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;requestBodies array.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType|JsonContent|XmlContent&gt;|MediaType|XmlContent|Attachable|null</span></dt><dd><p>The content of the request body.<br><br> The key is a media type or media type range and the value describes it. For requests that match multiple keys,<br> only the most specific key is applicable. e.g. text/plain overrides text/*.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="response" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Response.php" target="_blank" rel="noopener noreferrer">Response</a> <a class="header-anchor" href="#response" aria-hidden="true">#</a></h3><h4 id="allowed-in-29" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-29" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#patch">Patch</a>, <a href="#delete">Delete</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-30" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-30" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#header">Header</a>, <a href="#link">Link</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-31" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-31" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to a response.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>response</strong> : <span style="font-family:monospace;">string|int|null</span></dt><dd><p>The key into Operations-&gt;responses array.<br><br> A HTTP status code or <code>default</code>.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description of the response.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>headers</strong> : <span style="font-family:monospace;">Header[]</span></dt><dd><p>Maps a header name to its definition.<br><br> RFC7230 states header names are case insensitive.<br><br> If a response header is defined with the name &quot;Content-Type&quot;, it shall be ignored.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc7230#page-22">RFC7230</a></p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">MediaType|JsonContent|XmlContent|Attachable|array&lt;MediaType|Attachable&gt;</span></dt><dd><p>A map containing descriptions of potential response payloads.<br><br> The key is a media type or media type range and the value describes it.<br><br> For responses that match multiple keys, only the most specific key is applicable;<br> e.g. <code>text/plain</code> overrides <code>text/*</code>.</p></dd><dt><strong>links</strong> : <span style="font-family:monospace;">Link[]</span></dt><dd><p>A map of operations links that can be followed from the response.<br><br> The key of the map is a short name for the link, following the naming constraints of the names for Component<br> Objects.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="schema" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Schema.php" target="_blank" rel="noopener noreferrer">Schema</a> <a class="header-anchor" href="#schema" aria-hidden="true">#</a></h3><h4 id="allowed-in-30" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-30" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#header">Header</a></p><h4 id="nested-elements-31" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-31" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#examples">Examples</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-32" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-32" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the schema.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>const</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="securityscheme" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/SecurityScheme.php" target="_blank" rel="noopener noreferrer">SecurityScheme</a> <a class="header-anchor" href="#securityscheme" aria-hidden="true">#</a></h3><h4 id="allowed-in-31" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-31" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a></p><h4 id="nested-elements-32" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-32" aria-hidden="true">#</a></h4><hr><p><a href="#flow">Flow</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-33" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-33" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to a security scheme.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>securityScheme</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into OpenApi-&gt;security array.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the security scheme.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description for security scheme.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the header or query parameter to be used.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Required The location of the API key.</p></dd><dt><strong>bearerFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A hint to the client to identify how the bearer token is formatted.<br><br> Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.</p></dd><dt><strong>scheme</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the HTTP Authorization scheme.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc7235#section-5.1">RFC7235</a></p></dd><dt><strong>openIdConnectUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.</p></dd><dt><strong>flows</strong> : <span style="font-family:monospace;">Flow[]</span></dt><dd><p>The flow used by the OAuth2 security scheme.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="server" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Server.php" target="_blank" rel="noopener noreferrer">Server</a> <a class="header-anchor" href="#server" aria-hidden="true">#</a></h3><h4 id="allowed-in-32" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-32" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#link">Link</a></p><h4 id="nested-elements-33" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-33" aria-hidden="true">#</a></h4><hr><p><a href="#servervariable">ServerVariable</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-34" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-34" aria-hidden="true">#</a></h4><hr><dl><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL to the target host.<br><br> This URL supports Server Variables and may be relative,<br> to indicate that the host location is relative to the location where the OpenAPI document is being served.<br> Variable substitutions will be made when a variable is named in {brackets}.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional string describing the host designated by the URL.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>variables</strong> : <span style="font-family:monospace;">ServerVariable[]</span></dt><dd><p>A map between a variable name and its value.<br><br> The value is used for substitution in the server&#39;s URL template.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="servervariable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/ServerVariable.php" target="_blank" rel="noopener noreferrer">ServerVariable</a> <a class="header-anchor" href="#servervariable" aria-hidden="true">#</a></h3><h4 id="allowed-in-33" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-33" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a></p><h4 id="nested-elements-34" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-34" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-35" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-35" aria-hidden="true">#</a></h4><hr><dl><dt><strong>serverVariable</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Server-&gt;variables array.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional description for the server variable.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The default value to use for substitution, and to send, if an alternate value is not supplied.<br><br> Unlike the Schema Object&#39;s default, this value must be provided by the consumer.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>An enumeration of values to be used if the substitution options are from a limited set.</p></dd><dt><strong>variables</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map between a variable name and its value.<br><br> The value is used for substitution in the server&#39;s URL template.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="tag" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Tag.php" target="_blank" rel="noopener noreferrer">Tag</a> <a class="header-anchor" href="#tag" aria-hidden="true">#</a></h3><h4 id="allowed-in-34" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-34" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-35" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-35" aria-hidden="true">#</a></h4><hr><p><a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-36" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-36" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the tag.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description for the tag. GFM syntax can be used for rich text representation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this tag.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="trace" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Trace.php" target="_blank" rel="noopener noreferrer">Trace</a> <a class="header-anchor" href="#trace" aria-hidden="true">#</a></h3><h4 id="allowed-in-35" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-35" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-36" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-36" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-37" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-37" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="webhook" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Webhook.php" target="_blank" rel="noopener noreferrer">Webhook</a> <a class="header-anchor" href="#webhook" aria-hidden="true">#</a></h3><h4 id="allowed-in-36" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-36" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-37" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-37" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-38" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-38" aria-hidden="true">#</a></h4><hr><dl><dt><strong>webhook</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key for the webhooks map.</p></dd><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key for the Path Object (OpenApi-&gt;paths array).</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string summary, intended to apply to all operations in this path.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string description, intended to apply to all operations in this path.</p></dd><dt><strong>get</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Get|null</span></dt><dd><p>A definition of a GET operation on this path.</p></dd><dt><strong>put</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Put|null</span></dt><dd><p>A definition of a PUT operation on this path.</p></dd><dt><strong>post</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Post|null</span></dt><dd><p>A definition of a POST operation on this path.</p></dd><dt><strong>delete</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Delete|null</span></dt><dd><p>A definition of a DELETE operation on this path.</p></dd><dt><strong>options</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Options|null</span></dt><dd><p>A definition of a OPTIONS operation on this path.</p></dd><dt><strong>head</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Head|null</span></dt><dd><p>A definition of a HEAD operation on this path.</p></dd><dt><strong>patch</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Patch|null</span></dt><dd><p>A definition of a PATCH operation on this path.</p></dd><dt><strong>trace</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Trace|null</span></dt><dd><p>A definition of a TRACE operation on this path.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]|null</span></dt><dd><p>An alternative server array to service all operations in this path.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]|null</span></dt><dd><p>A list of parameters that are applicable for all the operations described under this path.<br><br> These parameters can be overridden at the operation level, but cannot be removed there.<br> The list must not include duplicated parameters.<br> A unique parameter is defined by a combination of a name and location.<br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s components/parameters.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="xml" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Xml.php" target="_blank" rel="noopener noreferrer">Xml</a> <a class="header-anchor" href="#xml" aria-hidden="true">#</a></h3><h4 id="allowed-in-37" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-37" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#schema">Schema</a>, <a href="#items">Items</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-38" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-38" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-39" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-39" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Replaces the name of the element/attribute used for the described schema property.<br><br> When defined within the Items Object (items), it will affect the name of the individual XML elements within the list.<br> When defined alongside type being array (outside the items), it will affect the wrapping element<br> and only if wrapped is <code>true</code>.<br><br> If wrapped is <code>false</code>, it will be ignored.</p></dd><dt><strong>namespace</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL of the namespace definition. Value SHOULD be in the form of a URL.</p></dd><dt><strong>prefix</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The prefix to be used for the name.</p></dd><dt><strong>attribute</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares whether the property definition translates to an attribute instead of an element.<br><br> Default value is <code>false</code>.</p></dd><dt><strong>wrapped</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>MAY be used only for an array definition.<br><br> Signifies whether the array is wrapped (for example <code>&lt;books&gt;&lt;book/&gt;&lt;book/&gt;&lt;/books&gt;</code>)<br> or unwrapped (<code>&lt;book/&gt;&lt;book/&gt;</code>).<br><br> Default value is false. The definition takes effect only when defined alongside type being array (outside the items).</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="xmlcontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/XmlContent.php" target="_blank" rel="noopener noreferrer">XmlContent</a> <a class="header-anchor" href="#xmlcontent" aria-hidden="true">#</a></h3><h4 id="nested-elements-39" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-39" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-40" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-40" aria-hidden="true">#</a></h4><hr><dl><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the schema.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\\OpenApi\\Annotations\\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\\Attributes\\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl>',403),o=[r];function i(d,l,p,h,c,m){return a(),t("div",null,o)}var b=e(s,[["render",i]]);export{u as __pageData,b as default};
diff --git a/assets/reference_attributes.md.0f7b8389.lean.js b/assets/reference_attributes.md.0f7b8389.lean.js
new file mode 100644
index 00000000..e37181a7
--- /dev/null
+++ b/assets/reference_attributes.md.0f7b8389.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o as a,a as n}from"./app.850f5e05.js";const u='{"title":"Attribute Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Attributes","slug":"attributes"},{"level":3,"title":"AdditionalProperties","slug":"additionalproperties"},{"level":3,"title":"Attachable","slug":"attachable"},{"level":3,"title":"Components","slug":"components"},{"level":3,"title":"Contact","slug":"contact"},{"level":3,"title":"CookieParameter","slug":"cookieparameter"},{"level":3,"title":"Delete","slug":"delete"},{"level":3,"title":"Discriminator","slug":"discriminator"},{"level":3,"title":"Examples","slug":"examples"},{"level":3,"title":"ExternalDocumentation","slug":"externaldocumentation"},{"level":3,"title":"Flow","slug":"flow"},{"level":3,"title":"Get","slug":"get"},{"level":3,"title":"Head","slug":"head"},{"level":3,"title":"Header","slug":"header"},{"level":3,"title":"HeaderParameter","slug":"headerparameter"},{"level":3,"title":"Info","slug":"info"},{"level":3,"title":"Items","slug":"items"},{"level":3,"title":"JsonContent","slug":"jsoncontent"},{"level":3,"title":"License","slug":"license"},{"level":3,"title":"Link","slug":"link"},{"level":3,"title":"MediaType","slug":"mediatype"},{"level":3,"title":"OpenApi","slug":"openapi"},{"level":3,"title":"Options","slug":"options"},{"level":3,"title":"Parameter","slug":"parameter"},{"level":3,"title":"Patch","slug":"patch"},{"level":3,"title":"PathItem","slug":"pathitem"},{"level":3,"title":"PathParameter","slug":"pathparameter"},{"level":3,"title":"Post","slug":"post"},{"level":3,"title":"Property","slug":"property"},{"level":3,"title":"Put","slug":"put"},{"level":3,"title":"QueryParameter","slug":"queryparameter"},{"level":3,"title":"RequestBody","slug":"requestbody"},{"level":3,"title":"Response","slug":"response"},{"level":3,"title":"Schema","slug":"schema"},{"level":3,"title":"SecurityScheme","slug":"securityscheme"},{"level":3,"title":"Server","slug":"server"},{"level":3,"title":"ServerVariable","slug":"servervariable"},{"level":3,"title":"Tag","slug":"tag"},{"level":3,"title":"Trace","slug":"trace"},{"level":3,"title":"Webhook","slug":"webhook"},{"level":3,"title":"Xml","slug":"xml"},{"level":3,"title":"XmlContent","slug":"xmlcontent"}],"relativePath":"reference/attributes.md"}',s={},r=n("",403),o=[r];function i(d,l,p,h,c,m){return a(),t("div",null,o)}var b=e(s,[["render",i]]);export{u as __pageData,b as default};
diff --git a/assets/reference_generator.md.857d4ce7.js b/assets/reference_generator.md.857d4ce7.js
new file mode 100644
index 00000000..7c3297b2
--- /dev/null
+++ b/assets/reference_generator.md.857d4ce7.js
@@ -0,0 +1,81 @@
+import{_ as n,c as s,o as a,a as t}from"./app.850f5e05.js";const h='{"title":"Using the Generator","description":"","frontmatter":{},"headers":[{"level":2,"title":"Introduction","slug":"introduction"},{"level":2,"title":"The \\\\OpenApi\\\\scan() function","slug":"the-openapi-scan-function"},{"level":2,"title":"The \\\\OpenApi\\\\Generator class","slug":"the-openapi-generator-class"}],"relativePath":"reference/generator.md"}',e={},p=t(`<h1 id="using-the-generator" tabindex="-1">Using the <code>Generator</code> <a class="header-anchor" href="#using-the-generator" aria-hidden="true">#</a></h1><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-hidden="true">#</a></h2><p>The <code>Generator</code> class provides an object-oriented way to use <code>swagger-php</code> and all its aspects in a single place.</p><h2 id="the-openapi-scan-function" tabindex="-1">The <code>\\OpenApi\\scan()</code> function <a class="header-anchor" href="#the-openapi-scan-function" aria-hidden="true">#</a></h2><p>For a long time the <code>\\OpenApi\\scan()</code> function was the main entry point into using swagger-php from PHP code.</p><div class="language-php"><pre><code><span class="token comment">/**
+  * Scan the filesystem for OpenAPI annotations and build openapi-documentation.
+  *
+  * @param array|Finder|string $directory The directory(s) or filename(s)
+  * @param array               $options
+  *                                       exclude: string|array $exclude The directory(s) or filename(s) to exclude (as absolute or relative paths)
+  *                                       pattern: string       $pattern File pattern(s) to scan (default: *.php)
+  *                                       analyser: defaults to StaticAnalyser
+  *                                       analysis: defaults to a new Analysis
+  *                                       processors: defaults to the registered processors in Analysis
+  *
+  * @return OpenApi
+  */</span>
+  <span class="token keyword">function</span> <span class="token function-definition function">scan</span><span class="token punctuation">(</span><span class="token variable">$directory</span><span class="token punctuation">,</span> <span class="token variable">$options</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Using it looked typically something like this:</p><div class="language-php"><pre><code><span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token function"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>scan</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;exclude&#39;</span> <span class="token operator">=&gt;</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;tests&#39;</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">&#39;pattern&#39;</span> <span class="token operator">=&gt;</span> <span class="token string single-quoted-string">&#39;*.php&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><p>The two configuration options for the underlying Doctrine doc-block parser <code>aliases</code> and <code>namespaces</code> are not part of this function and need to be set separately.</p><p>Being static this means setting them back is the callers responsibility and there is also the fact that some Doctrine configuration currently can not be reverted easily.</p><p>Therefore, having a single side effect free way of using swagger-php seemed like a good idea...</p><h2 id="the-openapi-generator-class" tabindex="-1">The <code>\\OpenApi\\Generator</code> class <a class="header-anchor" href="#the-openapi-generator-class" aria-hidden="true">#</a></h2><p>The <code>Generator</code> class can be used in object-oriented (and fluent) style which allows for easy customization if needed.</p><p>In that case to actually process the given input files the <strong>non-static</strong> method <code>generate()</code> is to be used.</p><p>Full example of using the <code>Generator</code> class to generate OpenApi specs.</p><div class="language-php"><pre><code><span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$validate</span> <span class="token operator">=</span> <span class="token constant boolean">true</span><span class="token punctuation">;</span>
+<span class="token variable">$logger</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\\</span>Psr<span class="token punctuation">\\</span>Log<span class="token punctuation">\\</span>NullLogger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+<span class="token variable">$processors</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token comment">/* my processors */</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
+<span class="token variable">$finder</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\\</span>Symfony<span class="token punctuation">\\</span>Component<span class="token punctuation">\\</span>Finder<span class="token punctuation">\\</span>Finder</span><span class="token operator">::</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">files</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">name</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;*.php&#39;</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">in</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Generator</span><span class="token punctuation">(</span><span class="token variable">$logger</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setProcessorPipeline</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Pipeline</span><span class="token punctuation">(</span><span class="token variable">$processors</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setAliases</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;MY&#39;</span> <span class="token operator">=&gt;</span> <span class="token string single-quoted-string">&#39;My\\Annotations&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setNamespaces</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;My\\\\Annotations\\\\&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setAnalyser</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Analysers<span class="token punctuation">\\</span>TokenAnalyser</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setVersion</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Annotations<span class="token punctuation">\\</span>OpenApi</span><span class="token operator">::</span><span class="token constant">VERSION_3_0_0</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">generate</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path1/to/project&#39;</span><span class="token punctuation">,</span> <span class="token variable">$finder</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Analysis</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token variable">$validate</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><p><code>Aliases</code> and <code>namespaces</code> are additional options that allow to customize the parsing of docblocks.</p><p>Defaults:</p><ul><li><p><strong>aliases</strong>: <code>[&#39;oa&#39; =&gt; &#39;OpenApi\\\\Annotations&#39;]</code></p><p>Aliases help the underlying <code>doctrine annotations library</code> to parse annotations. Effectively they avoid having to write <code>use OpenApi\\Annotations as OA;</code> in your code and make <code>@OA\\property(..)</code> annotations still work.</p></li><li><p><strong>namespaces</strong>: <code>[&#39;OpenApi\\\\Annotations\\\\&#39;]</code></p><p>Namespaces control which annotation namespaces can be autoloaded automatically. Under the hood this is handled by registering a custom loader with the <code>doctrine annotation library</code>.</p></li></ul><p>Advantages:</p><ul><li>The <code>Generator</code> code will handle configuring things as before in a single place</li><li>Static settings will be reverted to the default once finished</li><li>The get/set methods allow for using type hints</li><li>Static configuration is deprecated and can be removed at some point without code changes</li><li>Build in support for PSR logger</li><li>Support for <a href="https://symfony.com/doc/current/components/finder.html" target="_blank" rel="noopener noreferrer">Symfony Finder</a>, <code>\\SplInfo</code> and file/directory names (\`string) as source.</li></ul><p>The minimum code required, using the <code>generate()</code> method, looks quite similar to the old <code>scan()</code> code:</p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * Generate OpenAPI spec by scanning the given source files.
+     *
+     * @param iterable      $sources  PHP source files to scan.
+     *                                Supported sources:
+     *                                * string - file / directory name
+     *                                * \\SplFileInfo
+     *                                * \\Symfony\\Component\\Finder\\Finder
+     * @param null|Analysis $analysis custom analysis instance
+     * @param bool          $validate flag to enable/disable validation of the returned spec
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">generate</span><span class="token punctuation">(</span><span class="token keyword type-hint">iterable</span> <span class="token variable">$sources</span><span class="token punctuation">,</span> <span class="token operator">?</span><span class="token class-name type-declaration">Analysis</span> <span class="token variable">$analysis</span> <span class="token operator">=</span> <span class="token constant">null</span><span class="token punctuation">,</span> <span class="token keyword type-hint">bool</span> <span class="token variable">$validate</span> <span class="token operator">=</span> <span class="token constant boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token class-name class-name-fully-qualified return-type"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>OpenApi</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><div class="language-php"><pre><code><span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Generator</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">generate</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path1/to/project&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><p>For those that want to type even less and keep using a plain array to configure <code>swagger-php</code> there is also a static version:</p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+<span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Generator</span><span class="token operator">::</span><span class="token function">scan</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path/to/project&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token function">header</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;Content-Type: application/x-yaml&#39;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+<span class="token keyword">echo</span> <span class="token variable">$openapi</span><span class="token operator">-&gt;</span><span class="token function">toYaml</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</span></code></pre></div><p><strong>Note:</strong> While using the same name as the old <code>scan()</code> function, the <code>Generator::scan</code> method is not 100% backwards compatible.</p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * Static  wrapper around \`Generator::generate()\`.
+     *
+     * @param iterable $sources PHP source files to scan.
+     *                          Supported sources:
+     *                          * string
+     *                          * \\SplFileInfo
+     *                          * \\Symfony\\Component\\Finder\\Finder
+     * @param array    $options
+     *                          aliases:    null|array                    Defaults to \`[&#39;oa&#39; =&gt; &#39;OpenApi\\\\Annotations&#39;]\`.
+     *                          namespaces: null|array                    Defaults to \`[&#39;OpenApi\\\\Annotations\\\\&#39;]\`.
+     *                          analyser:   null|AnalyserInterface        Defaults to a new \`ReflectionAnalyser\` supporting both docblocks and attributes.
+     *                          analysis:   null|Analysis                 Defaults to a new \`Analysis\`.
+     *                          processors: null|array                    Defaults to \`Analysis::processors()\`.
+     *                          logger:     null|\\Psr\\Log\\LoggerInterface If not set logging will use \\OpenApi\\Logger as before.
+     *                          validate:   bool                          Defaults to \`true\`.
+     *                          version:    string                        Defaults to \`\\OpenApi\\Annotations\\OpenApi::VERSION_3_0_0\`. Alternatives are: \`\\OpenApi\\Annotations\\OpenApi::VERSION_3_1_0\`.
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">static</span> <span class="token keyword">function</span> <span class="token function-definition function">scan</span><span class="token punctuation">(</span><span class="token keyword type-hint">iterable</span> <span class="token variable">$sources</span><span class="token punctuation">,</span> <span class="token keyword type-hint">array</span> <span class="token variable">$options</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token class-name return-type">OpenApi</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Most notably the <code>exclude</code> and <code>pattern</code> keys are no longer supported. Instead, a Symfony <code>Finder</code> instance can be passed in as source directly (same as with <code>Generator::generate()</code>).</p><p>If needed, the <code>\\OpenApi\\Util</code> class provides a builder method that allows to keep the status-quo</p><div class="language-php"><pre><code><span class="token variable">$exclude</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;tests&#39;</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
+<span class="token variable">$pattern</span> <span class="token operator">=</span> <span class="token string single-quoted-string">&#39;*.php&#39;</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Generator</span><span class="token operator">::</span><span class="token function">scan</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>Util</span><span class="token operator">::</span><span class="token function">finder</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">,</span> <span class="token variable">$exclude</span><span class="token punctuation">,</span> <span class="token variable">$pattern</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token comment">// same as</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token function"><span class="token punctuation">\\</span>OpenApi<span class="token punctuation">\\</span>scan</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;exclude&#39;</span> <span class="token operator">=&gt;</span> <span class="token variable">$exclude</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">&#39;pattern&#39;</span> <span class="token operator">=&gt;</span> <span class="token variable">$pattern</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div>`,31),o=[p];function c(l,i,u,r,k,d){return a(),s("div",null,o)}var f=n(e,[["render",c]]);export{h as __pageData,f as default};
diff --git a/assets/reference_generator.md.857d4ce7.lean.js b/assets/reference_generator.md.857d4ce7.lean.js
new file mode 100644
index 00000000..ae71e1ea
--- /dev/null
+++ b/assets/reference_generator.md.857d4ce7.lean.js
@@ -0,0 +1 @@
+import{_ as n,c as s,o as a,a as t}from"./app.850f5e05.js";const h='{"title":"Using the Generator","description":"","frontmatter":{},"headers":[{"level":2,"title":"Introduction","slug":"introduction"},{"level":2,"title":"The \\\\OpenApi\\\\scan() function","slug":"the-openapi-scan-function"},{"level":2,"title":"The \\\\OpenApi\\\\Generator class","slug":"the-openapi-generator-class"}],"relativePath":"reference/generator.md"}',e={},p=t("",31),o=[p];function c(l,i,u,r,k,d){return a(),s("div",null,o)}var f=n(e,[["render",c]]);export{h as __pageData,f as default};
diff --git a/assets/reference_index.md.05295186.js b/assets/reference_index.md.05295186.js
new file mode 100644
index 00000000..d7e68eba
--- /dev/null
+++ b/assets/reference_index.md.05295186.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o,a as r}from"./app.850f5e05.js";const f='{"title":"Reference","description":"","frontmatter":{},"headers":[],"relativePath":"reference/index.md"}',a={},n=r('<h1 id="reference" tabindex="-1">Reference <a class="header-anchor" href="#reference" aria-hidden="true">#</a></h1><p>In total there are a number of different aspects to using <code>swagger-php</code>. Depending on how custom your requirements are this might be limited to just annotating your code and using the command line tool.</p><p>However, <code>swagger-php</code> offers more.</p><ul><li><p><a href="./attributes.html">Attributes</a></p><p>The new way of adding meta-data to your codebase. Requires PHP 8.1</p></li><li><p><a href="./annotations.html">Docblock annotations</a></p><p>The &#39;traditional&#39; way of documenting your API.</p></li><li><p>The <a href="./generator.html"><code>Generator</code></a></p><p>The <code>\\OpenAPI\\Generator</code> class is the main entry point to programmatically generate OpenAPI documents from your code.</p></li><li><p><a href="./processors.html">Processors</a></p><p><code>swagger-php</code> comes with a list of pre-defined processors that convert the raw data to a complete OpenAPI document. Custom processors can be added or existing removed to tweak swagger-php` to your requirements.</p></li></ul>',4),s=[n];function c(i,d,p,h,l,m){return o(),t("div",null,s)}var _=e(a,[["render",c]]);export{f as __pageData,_ as default};
diff --git a/assets/reference_index.md.05295186.lean.js b/assets/reference_index.md.05295186.lean.js
new file mode 100644
index 00000000..5fba3640
--- /dev/null
+++ b/assets/reference_index.md.05295186.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o,a as r}from"./app.850f5e05.js";const f='{"title":"Reference","description":"","frontmatter":{},"headers":[],"relativePath":"reference/index.md"}',a={},n=r("",4),s=[n];function c(i,d,p,h,l,m){return o(),t("div",null,s)}var _=e(a,[["render",c]]);export{f as __pageData,_ as default};
diff --git a/assets/reference_processors.md.40e47002.js b/assets/reference_processors.md.40e47002.js
new file mode 100644
index 00000000..1df3d8db
--- /dev/null
+++ b/assets/reference_processors.md.40e47002.js
@@ -0,0 +1,13 @@
+import{_ as e,c as a,o as t,a as n}from"./app.850f5e05.js";const m='{"title":"Processor Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Processor Configuration","slug":"processor-configuration"},{"level":3,"title":"Command line","slug":"command-line"},{"level":3,"title":"Programmatically with PHP","slug":"programmatically-with-php"},{"level":2,"title":"Default Processors","slug":"default-processors"},{"level":3,"title":"DocBlockDescriptions","slug":"docblockdescriptions"},{"level":3,"title":"MergeIntoOpenApi","slug":"mergeintoopenapi"},{"level":3,"title":"MergeIntoComponents","slug":"mergeintocomponents"},{"level":3,"title":"ExpandClasses","slug":"expandclasses"},{"level":3,"title":"ExpandInterfaces","slug":"expandinterfaces"},{"level":3,"title":"ExpandTraits","slug":"expandtraits"},{"level":3,"title":"ExpandEnums","slug":"expandenums"},{"level":3,"title":"AugmentSchemas","slug":"augmentschemas"},{"level":3,"title":"AugmentRequestBody","slug":"augmentrequestbody"},{"level":3,"title":"AugmentProperties","slug":"augmentproperties"},{"level":3,"title":"BuildPaths","slug":"buildpaths"},{"level":3,"title":"AugmentParameters","slug":"augmentparameters"},{"level":3,"title":"AugmentRefs","slug":"augmentrefs"},{"level":3,"title":"MergeJsonContent","slug":"mergejsoncontent"},{"level":3,"title":"MergeXmlContent","slug":"mergexmlcontent"},{"level":3,"title":"OperationId","slug":"operationid"},{"level":3,"title":"AugmentTags","slug":"augmenttags"},{"level":3,"title":"CleanUnmerged","slug":"cleanunmerged"},{"level":3,"title":"PathFilter","slug":"pathfilter"},{"level":3,"title":"CleanUnusedComponents","slug":"cleanunusedcomponents"}],"relativePath":"reference/processors.md"}',s={},r=n(`<h1 id="processor-reference" tabindex="-1">Processor Reference <a class="header-anchor" href="#processor-reference" aria-hidden="true">#</a></h1><p>This page is generated automatically from the <code>swagger-php</code> sources.</p><p>For improvements head over to <a href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer">GitHub</a> and create a PR \u{1F609}</p><p><em>Processors are listed in the default order of execution.</em></p><h2 id="processor-configuration" tabindex="-1">Processor Configuration <a class="header-anchor" href="#processor-configuration" aria-hidden="true">#</a></h2><h3 id="command-line" tabindex="-1">Command line <a class="header-anchor" href="#command-line" aria-hidden="true">#</a></h3><p>The <code>-c</code> option allows to specify a name/value pair with the name consisting of the processor name (starting lowercase) and option name separated by a dot (<code>.</code>).</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./bin/openapi <span class="token parameter variable">-c</span> <span class="token assign-left variable">operatinId.hash</span><span class="token operator">=</span>true // <span class="token punctuation">..</span>.
+<span class="token operator">&gt;</span> ./bin/openapi <span class="token parameter variable">-c</span> pathFilter.tags<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token operator">=</span>/pets/ <span class="token parameter variable">-c</span> pathFilter.tags<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token operator">=</span>/store/ // <span class="token punctuation">..</span>.
+</code></pre></div><h3 id="programmatically-with-php" tabindex="-1">Programmatically with PHP <a class="header-anchor" href="#programmatically-with-php" aria-hidden="true">#</a></h3><p>Configuration can be set using the <code>Generator::setConfig()</code> method. Keys can either be the same as on the command line or be broken down into nested arrays.</p><div class="language-php"><pre><code><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">Generator</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">setConfig</span><span class="token punctuation">(</span><span class="token punctuation">[</span>
+        <span class="token string single-quoted-string">&#39;operationId.hash&#39;</span> <span class="token operator">=&gt;</span> <span class="token constant boolean">true</span><span class="token punctuation">,</span>
+        <span class="token string single-quoted-string">&#39;pathFilter&#39;</span> <span class="token operator">=&gt;</span> <span class="token punctuation">[</span>
+            <span class="token string single-quoted-string">&#39;tags&#39;</span> <span class="token operator">=&gt;</span> <span class="token punctuation">[</span>
+                <span class="token string single-quoted-string">&#39;/pets/&#39;</span><span class="token punctuation">,</span>
+                <span class="token string single-quoted-string">&#39;/store/&#39;</span><span class="token punctuation">,</span>
+            <span class="token punctuation">]</span><span class="token punctuation">,</span>
+        <span class="token punctuation">]</span><span class="token punctuation">,</span>
+    <span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><h2 id="default-processors" tabindex="-1">Default Processors <a class="header-anchor" href="#default-processors" aria-hidden="true">#</a></h2><h3 id="docblockdescriptions" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/DocBlockDescriptions.php" target="_blank" rel="noopener noreferrer">DocBlockDescriptions</a> <a class="header-anchor" href="#docblockdescriptions" aria-hidden="true">#</a></h3><p>Checks if the annotation has a summary and/or description property and uses the text in the comment block (above the annotations) as summary and/or description.</p><p>Use <code>null</code>, for example: <code>@Annotation(description=null)</code>, if you don&#39;t want the annotation to have a description.</p><h3 id="mergeintoopenapi" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeIntoOpenApi.php" target="_blank" rel="noopener noreferrer">MergeIntoOpenApi</a> <a class="header-anchor" href="#mergeintoopenapi" aria-hidden="true">#</a></h3><p>Merge all @OA\\OpenApi annotations into one.</p><h3 id="mergeintocomponents" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeIntoComponents.php" target="_blank" rel="noopener noreferrer">MergeIntoComponents</a> <a class="header-anchor" href="#mergeintocomponents" aria-hidden="true">#</a></h3><p>Merge reusable annotation into @OA\\Schemas.</p><h3 id="expandclasses" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandClasses.php" target="_blank" rel="noopener noreferrer">ExpandClasses</a> <a class="header-anchor" href="#expandclasses" aria-hidden="true">#</a></h3><p>Iterate over the chain of ancestors of a schema and:</p><ul><li>if the ancestor has a schema =&gt; inherit from the ancestor if it has a schema (allOf) and stop.</li><li>else =&gt; merge ancestor properties into the schema.</li></ul><h3 id="expandinterfaces" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandInterfaces.php" target="_blank" rel="noopener noreferrer">ExpandInterfaces</a> <a class="header-anchor" href="#expandinterfaces" aria-hidden="true">#</a></h3><p>Look at all (direct) interfaces for a schema and:</p><ul><li>merge interfaces annotations/methods into the schema if the interface does not have a schema itself</li><li>inherit from the interface if it has a schema (allOf).</li></ul><h3 id="expandtraits" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandTraits.php" target="_blank" rel="noopener noreferrer">ExpandTraits</a> <a class="header-anchor" href="#expandtraits" aria-hidden="true">#</a></h3><p>Look at all (direct) traits for a schema and:</p><ul><li>merge trait annotations/methods/properties into the schema if the trait does not have a schema itself</li><li>inherit from the trait if it has a schema (allOf).</li></ul><h3 id="expandenums" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandEnums.php" target="_blank" rel="noopener noreferrer">ExpandEnums</a> <a class="header-anchor" href="#expandenums" aria-hidden="true">#</a></h3><p>Expands PHP enums.</p><p>Determines <code>schema</code>, <code>enum</code> and <code>type</code>.</p><h3 id="augmentschemas" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentSchemas.php" target="_blank" rel="noopener noreferrer">AugmentSchemas</a> <a class="header-anchor" href="#augmentschemas" aria-hidden="true">#</a></h3><p>Use the Schema context to extract useful information and inject that into the annotation.</p><p>Merges properties.</p><h3 id="augmentrequestbody" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentRequestBody.php" target="_blank" rel="noopener noreferrer">AugmentRequestBody</a> <a class="header-anchor" href="#augmentrequestbody" aria-hidden="true">#</a></h3><p>Use the RequestBody context to extract useful information and inject that into the annotation.</p><h3 id="augmentproperties" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentProperties.php" target="_blank" rel="noopener noreferrer">AugmentProperties</a> <a class="header-anchor" href="#augmentproperties" aria-hidden="true">#</a></h3><p>Use the property context to extract useful information and inject that into the annotation.</p><h3 id="buildpaths" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/BuildPaths.php" target="_blank" rel="noopener noreferrer">BuildPaths</a> <a class="header-anchor" href="#buildpaths" aria-hidden="true">#</a></h3><p>Build the openapi-&gt;paths using the detected <code>@OA\\PathItem</code> and <code>@OA\\Operation</code> (<code>@OA\\Get</code>, <code>@OA\\Post</code>, etc).</p><h3 id="augmentparameters" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentParameters.php" target="_blank" rel="noopener noreferrer">AugmentParameters</a> <a class="header-anchor" href="#augmentparameters" aria-hidden="true">#</a></h3><p>Augments shared and operations parameters from docblock comments.</p><h4 id="config-settings" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings" aria-hidden="true">#</a></h4><dl><dt><strong>augmentParameters.augmentOperationParameters</strong> : <span style="font-family:monospace;">bool</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">true</span></dt><dd><p>If set to <code>true</code> try to find operation parameter descriptions in the operation docblock.</p></dd></dl><h3 id="augmentrefs" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentRefs.php" target="_blank" rel="noopener noreferrer">AugmentRefs</a> <a class="header-anchor" href="#augmentrefs" aria-hidden="true">#</a></h3><h3 id="mergejsoncontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeJsonContent.php" target="_blank" rel="noopener noreferrer">MergeJsonContent</a> <a class="header-anchor" href="#mergejsoncontent" aria-hidden="true">#</a></h3><p>Split JsonContent into Schema and MediaType.</p><h3 id="mergexmlcontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeXmlContent.php" target="_blank" rel="noopener noreferrer">MergeXmlContent</a> <a class="header-anchor" href="#mergexmlcontent" aria-hidden="true">#</a></h3><p>Split XmlContent into Schema and MediaType.</p><h3 id="operationid" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/OperationId.php" target="_blank" rel="noopener noreferrer">OperationId</a> <a class="header-anchor" href="#operationid" aria-hidden="true">#</a></h3><p>Generate the OperationId based on the context of the OpenApi annotation.</p><h4 id="config-settings-1" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings-1" aria-hidden="true">#</a></h4><dl><dt><strong>operationId.hash</strong> : <span style="font-family:monospace;">bool</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">true</span></dt><dd><p>If set to <code>true</code> generate ids (md5) instead of clear text operation ids.</p></dd></dl><h3 id="augmenttags" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentTags.php" target="_blank" rel="noopener noreferrer">AugmentTags</a> <a class="header-anchor" href="#augmenttags" aria-hidden="true">#</a></h3><p>Ensures that all tags used on operations also exist in the global <code>tags</code> list.</p><h3 id="cleanunmerged" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/CleanUnmerged.php" target="_blank" rel="noopener noreferrer">CleanUnmerged</a> <a class="header-anchor" href="#cleanunmerged" aria-hidden="true">#</a></h3><h3 id="pathfilter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/PathFilter.php" target="_blank" rel="noopener noreferrer">PathFilter</a> <a class="header-anchor" href="#pathfilter" aria-hidden="true">#</a></h3><p>Allows to filter endpoints based on tags and/or path.</p><p>If no <code>tags</code> or <code>paths</code> filters are set, no filtering is performed. All filter (regular) expressions must be enclosed within delimiter characters as they are used as-is.</p><h4 id="config-settings-2" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings-2" aria-hidden="true">#</a></h4><dl><dt><strong>pathFilter.tags</strong> : <span style="font-family:monospace;">array</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">[]</span></dt><dd><p>A list of regular expressions to match <code>tags</code> to include.</p></dd></dl><dl><dt><strong>pathFilter.paths</strong> : <span style="font-family:monospace;">array</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">[]</span></dt><dd><p>A list of regular expressions to match <code>paths</code> to include.</p></dd></dl><h3 id="cleanunusedcomponents" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/CleanUnusedComponents.php" target="_blank" rel="noopener noreferrer">CleanUnusedComponents</a> <a class="header-anchor" href="#cleanunusedcomponents" aria-hidden="true">#</a></h3><p>Tracks the use of all <code>Components</code> and removed unused schemas.</p><h4 id="config-settings-3" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings-3" aria-hidden="true">#</a></h4><dl><dt><strong>cleanUnusedComponents.enabled</strong> : <span style="font-family:monospace;">bool</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">false</span></dt><dd><p>Enables/disables the <code>CleanUnusedComponents</code> processor.</p></dd></dl>`,66),o=[r];function p(i,c,l,h,d,g){return t(),a("div",null,o)}var f=e(s,[["render",p]]);export{m as __pageData,f as default};
diff --git a/assets/reference_processors.md.40e47002.lean.js b/assets/reference_processors.md.40e47002.lean.js
new file mode 100644
index 00000000..105c44d1
--- /dev/null
+++ b/assets/reference_processors.md.40e47002.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as a,o as t,a as n}from"./app.850f5e05.js";const m='{"title":"Processor Reference","description":"","frontmatter":{},"headers":[{"level":2,"title":"Processor Configuration","slug":"processor-configuration"},{"level":3,"title":"Command line","slug":"command-line"},{"level":3,"title":"Programmatically with PHP","slug":"programmatically-with-php"},{"level":2,"title":"Default Processors","slug":"default-processors"},{"level":3,"title":"DocBlockDescriptions","slug":"docblockdescriptions"},{"level":3,"title":"MergeIntoOpenApi","slug":"mergeintoopenapi"},{"level":3,"title":"MergeIntoComponents","slug":"mergeintocomponents"},{"level":3,"title":"ExpandClasses","slug":"expandclasses"},{"level":3,"title":"ExpandInterfaces","slug":"expandinterfaces"},{"level":3,"title":"ExpandTraits","slug":"expandtraits"},{"level":3,"title":"ExpandEnums","slug":"expandenums"},{"level":3,"title":"AugmentSchemas","slug":"augmentschemas"},{"level":3,"title":"AugmentRequestBody","slug":"augmentrequestbody"},{"level":3,"title":"AugmentProperties","slug":"augmentproperties"},{"level":3,"title":"BuildPaths","slug":"buildpaths"},{"level":3,"title":"AugmentParameters","slug":"augmentparameters"},{"level":3,"title":"AugmentRefs","slug":"augmentrefs"},{"level":3,"title":"MergeJsonContent","slug":"mergejsoncontent"},{"level":3,"title":"MergeXmlContent","slug":"mergexmlcontent"},{"level":3,"title":"OperationId","slug":"operationid"},{"level":3,"title":"AugmentTags","slug":"augmenttags"},{"level":3,"title":"CleanUnmerged","slug":"cleanunmerged"},{"level":3,"title":"PathFilter","slug":"pathfilter"},{"level":3,"title":"CleanUnusedComponents","slug":"cleanunusedcomponents"}],"relativePath":"reference/processors.md"}',s={},r=n("",66),o=[r];function p(i,c,l,h,d,g){return t(),a("div",null,o)}var f=e(s,[["render",p]]);export{m as __pageData,f as default};
diff --git a/assets/related-projects.md.cb587093.js b/assets/related-projects.md.cb587093.js
new file mode 100644
index 00000000..db0611cf
--- /dev/null
+++ b/assets/related-projects.md.cb587093.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o as r,a}from"./app.850f5e05.js";const u='{"title":"Related projects","description":"","frontmatter":{"sidebar":false},"headers":[],"relativePath":"related-projects.md"}',n={},o=a('<h1 id="related-projects" tabindex="-1">Related projects <a class="header-anchor" href="#related-projects" aria-hidden="true">#</a></h1><table><thead><tr><th>Project</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://swagger.io/tools/swagger-ui/" target="_blank" rel="noopener noreferrer">Swagger UI</a></td><td>The webinterface for reading the generated documentation</td></tr><tr><td><a href="https://bfanger.nl/swagger-explained/" target="_blank" rel="noopener noreferrer">Swagger Explained</a></td><td>Browse the spec by using an swagger.json.</td></tr><tr><td><a href="https://github.com/DerManoMann/silex2swagger" target="_blank" rel="noopener noreferrer">silex2swagger</a></td><td>Generate swagger documentation from Silex Annotations</td></tr><tr><td><a href="https://github.com/lichunqiang/yii2-swagger" target="_blank" rel="noopener noreferrer">yii2-swagger</a></td><td>swagger-php integration with yii2</td></tr><tr><td><a href="https://github.com/DarkaOnLine/SwaggerLume" target="_blank" rel="noopener noreferrer">Lumen swagger</a></td><td>swagger-php integration with lumen/laravel</td></tr><tr><td><a href="https://github.com/nelmio/NelmioApiDocBundle" target="_blank" rel="noopener noreferrer">NelmioApiDocBundle</a></td><td>Symfony bundle on top of swagger-php</td></tr><tr><td><a href="https://github.com/kevupton/auto-swagger-ui" target="_blank" rel="noopener noreferrer">auto-swagger-ui</a></td><td>Automatically add swagger ui and json to your application</td></tr><tr><td><a href="https://github.com/DerManoMann/openapi-router" target="_blank" rel="noopener noreferrer">openapi-router</a></td><td>Configure framework routes from OpenApi annotations</td></tr><tr><td><a href="https://github.com/DerManoMann/openapi-verifier" target="_blank" rel="noopener noreferrer">openapi-verifier</a></td><td>Verify response against OpenAPI specification in PHPUnit</td></tr><tr><td><a href="https://github.com/Mermade/openapi-filter" target="_blank" rel="noopener noreferrer">openapi-filter</a></td><td>Filter internal paths, operations, parameters, etc</td></tr><tr><td><a href="https://github.com/Tobion/OpenAPI-Symfony-Routing" target="_blank" rel="noopener noreferrer">OpenAPI-Symfony-Routing</a></td><td>Load routes in Symfony based on OpenAPI annotations</td></tr><tr><td><a href="https://kizu514.com/swagit.php" target="_blank" rel="noopener noreferrer">Swag It PHP</a></td><td>Convert JSON to PHP Swagger annotations</td></tr><tr><td><a href="https://github.com/DarkaOnLine/L5-Swagger" target="_blank" rel="noopener noreferrer">Laravel Swagger</a></td><td>OpenApi or Swagger integration to Laravel</td></tr><tr><td><a href="https://github.com/DerManoMann/openapi-extras" target="_blank" rel="noopener noreferrer">openapi-extras</a></td><td>Extra annotations for swagger-php</td></tr><tr><td><a href="https://github.com/MattyRad/openapi-serialize" target="_blank" rel="noopener noreferrer">openapi-serialize</a></td><td>Serialize an object using swagger-php</td></tr></tbody></table><p>Is a related project missing? Create a pull request!</p>',3),i=[o];function d(p,s,g,l,h,f){return r(),t("div",null,i)}var _=e(n,[["render",d]]);export{u as __pageData,_ as default};
diff --git a/assets/related-projects.md.cb587093.lean.js b/assets/related-projects.md.cb587093.lean.js
new file mode 100644
index 00000000..4c6d431d
--- /dev/null
+++ b/assets/related-projects.md.cb587093.lean.js
@@ -0,0 +1 @@
+import{_ as e,c as t,o as r,a}from"./app.850f5e05.js";const u='{"title":"Related projects","description":"","frontmatter":{"sidebar":false},"headers":[],"relativePath":"related-projects.md"}',n={},o=a("",3),i=[o];function d(p,s,g,l,h,f){return r(),t("div",null,i)}var _=e(n,[["render",d]]);export{u as __pageData,_ as default};
diff --git a/assets/snippets_preamble_annotations.md.bb82314f.js b/assets/snippets_preamble_annotations.md.bb82314f.js
new file mode 100644
index 00000000..63c48e72
--- /dev/null
+++ b/assets/snippets_preamble_annotations.md.bb82314f.js
@@ -0,0 +1 @@
+import{_ as a,c as r,o,d as e,e as t}from"./app.850f5e05.js";const u='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"snippets/preamble_annotations.md"}',s={},n=e("p",null,[t("In addition to this page, there are also a number of "),e("a",{href:"https://github.com/zircote/swagger-php/tree/master/Examples#readme",target:"_blank",rel:"noopener noreferrer"},"examples"),t(" which might help you out.")],-1),p=[n];function c(i,l,_,d,h,m){return o(),r("div",null,p)}var g=a(s,[["render",c]]);export{u as __pageData,g as default};
diff --git a/assets/snippets_preamble_annotations.md.bb82314f.lean.js b/assets/snippets_preamble_annotations.md.bb82314f.lean.js
new file mode 100644
index 00000000..63c48e72
--- /dev/null
+++ b/assets/snippets_preamble_annotations.md.bb82314f.lean.js
@@ -0,0 +1 @@
+import{_ as a,c as r,o,d as e,e as t}from"./app.850f5e05.js";const u='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"snippets/preamble_annotations.md"}',s={},n=e("p",null,[t("In addition to this page, there are also a number of "),e("a",{href:"https://github.com/zircote/swagger-php/tree/master/Examples#readme",target:"_blank",rel:"noopener noreferrer"},"examples"),t(" which might help you out.")],-1),p=[n];function c(i,l,_,d,h,m){return o(),r("div",null,p)}var g=a(s,[["render",c]]);export{u as __pageData,g as default};
diff --git a/assets/snippets_preamble_attributes.md.b131e034.js b/assets/snippets_preamble_attributes.md.b131e034.js
new file mode 100644
index 00000000..dc86e742
--- /dev/null
+++ b/assets/snippets_preamble_attributes.md.b131e034.js
@@ -0,0 +1 @@
+import{_ as a,c as r,o,d as e,e as t}from"./app.850f5e05.js";const f='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"snippets/preamble_annotations.md"}',s={},n=e("p",null,[t("In addition to this page, there are also a number of "),e("a",{href:"https://github.com/zircote/swagger-php/tree/master/Examples#readme",target:"_blank",rel:"noopener noreferrer"},"examples"),t(" which might help you out.")],-1),p=[n];function c(i,l,_,d,h,m){return o(),r("div",null,p)}var g=a(s,[["render",c]]);export{f as __pageData,g as default};
diff --git a/assets/snippets_preamble_attributes.md.b131e034.lean.js b/assets/snippets_preamble_attributes.md.b131e034.lean.js
new file mode 100644
index 00000000..dc86e742
--- /dev/null
+++ b/assets/snippets_preamble_attributes.md.b131e034.lean.js
@@ -0,0 +1 @@
+import{_ as a,c as r,o,d as e,e as t}from"./app.850f5e05.js";const f='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"snippets/preamble_annotations.md"}',s={},n=e("p",null,[t("In addition to this page, there are also a number of "),e("a",{href:"https://github.com/zircote/swagger-php/tree/master/Examples#readme",target:"_blank",rel:"noopener noreferrer"},"examples"),t(" which might help you out.")],-1),p=[n];function c(i,l,_,d,h,m){return o(),r("div",null,p)}var g=a(s,[["render",c]]);export{f as __pageData,g as default};
diff --git a/assets/snippets_preamble_processors.md.309ada33.js b/assets/snippets_preamble_processors.md.309ada33.js
new file mode 100644
index 00000000..bee98fd0
--- /dev/null
+++ b/assets/snippets_preamble_processors.md.309ada33.js
@@ -0,0 +1 @@
+import{_ as t,c as s,o,d as e}from"./app.850f5e05.js";const u='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"snippets/preamble_processors.md"}',r={},a=e("p",null,[e("em",null,"Processors are listed in the default order of execution.")],-1),c=[a];function n(p,_,l,d,i,f){return o(),s("div",null,c)}var h=t(r,[["render",n]]);export{u as __pageData,h as default};
diff --git a/assets/snippets_preamble_processors.md.309ada33.lean.js b/assets/snippets_preamble_processors.md.309ada33.lean.js
new file mode 100644
index 00000000..bee98fd0
--- /dev/null
+++ b/assets/snippets_preamble_processors.md.309ada33.lean.js
@@ -0,0 +1 @@
+import{_ as t,c as s,o,d as e}from"./app.850f5e05.js";const u='{"title":"","description":"","frontmatter":{},"headers":[],"relativePath":"snippets/preamble_processors.md"}',r={},a=e("p",null,[e("em",null,"Processors are listed in the default order of execution.")],-1),c=[a];function n(p,_,l,d,i,f){return o(),s("div",null,c)}var h=t(r,[["render",n]]);export{u as __pageData,h as default};
diff --git a/assets/style.29d805fc.css b/assets/style.29d805fc.css
new file mode 100644
index 00000000..4f0f50a5
--- /dev/null
+++ b/assets/style.29d805fc.css
@@ -0,0 +1 @@
+:root{--c-white: #ffffff;--c-white-dark: #f8f8f8;--c-black: #000000;--c-divider-light: rgba(60, 60, 67, .12);--c-divider-dark: rgba(84, 84, 88, .48);--c-text-light-1: #2c3e50;--c-text-light-2: #476582;--c-text-light-3: #90a4b7;--c-brand: #3eaf7c;--c-brand-light: #4abf8a;--font-family-base: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen, Ubuntu, Cantarell, "Fira Sans", "Droid Sans", "Helvetica Neue", sans-serif;--font-family-mono: source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;--z-index-navbar: 10;--z-index-sidebar: 6;--shadow-1: 0 1px 2px rgba(0, 0, 0, .04), 0 1px 2px rgba(0, 0, 0, .06);--shadow-2: 0 3px 12px rgba(0, 0, 0, .07), 0 1px 4px rgba(0, 0, 0, .07);--shadow-3: 0 12px 32px rgba(0, 0, 0, .1), 0 2px 6px rgba(0, 0, 0, .08);--shadow-4: 0 14px 44px rgba(0, 0, 0, .12), 0 3px 9px rgba(0, 0, 0, .12);--shadow-5: 0 18px 56px rgba(0, 0, 0, .16), 0 4px 12px rgba(0, 0, 0, .16);--header-height: 3.6rem}:root{--c-divider: var(--c-divider-light);--c-text: var(--c-text-light-1);--c-text-light: var(--c-text-light-2);--c-text-lighter: var(--c-text-light-3);--c-bg: var(--c-white);--c-bg-accent: var(--c-white-dark);--code-line-height: 24px;--code-font-family: var(--font-family-mono);--code-font-size: 14px;--code-inline-bg-color: rgba(27, 31, 35, .05);--code-bg-color: #282c34}*,:before,:after{box-sizing:border-box}html{line-height:1.4;font-size:16px;-webkit-text-size-adjust:100%}body{margin:0;width:100%;min-width:320px;min-height:100vh;line-height:1.4;font-family:var(--font-family-base);font-size:16px;font-weight:400;color:var(--c-text);background-color:var(--c-bg);direction:ltr;font-synthesis:none;text-rendering:optimizeLegibility;-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}main{display:block}h1,h2,h3,h4,h5,h6{margin:0;line-height:1.25}h1,h2,h3,h4,h5,h6,strong,b{font-weight:600}h1:hover .header-anchor,h1:focus .header-anchor,h2:hover .header-anchor,h2:focus .header-anchor,h3:hover .header-anchor,h3:focus .header-anchor,h4:hover .header-anchor,h4:focus .header-anchor,h5:hover .header-anchor,h5:focus .header-anchor,h6:hover .header-anchor,h6:focus .header-anchor{opacity:1}h1{margin-top:1.5rem;font-size:1.9rem}@media screen and (min-width: 420px){h1{font-size:2.2rem}}h2{margin-top:2.25rem;margin-bottom:1.25rem;border-bottom:1px solid var(--c-divider);padding-bottom:.3rem;line-height:1.25;font-size:1.65rem}h2+h3{margin-top:1.5rem}h3{margin-top:2rem;font-size:1.35rem}h4{font-size:1.15rem}p,ol,ul{margin:1rem 0;line-height:1.7}a,area,button,[role=button],input,label,select,summary,textarea{touch-action:manipulation}a{text-decoration:none;color:var(--c-brand)}a:hover{text-decoration:underline}a.header-anchor{float:left;margin-top:.125em;margin-left:-.87em;padding-right:.23em;font-size:.85em;opacity:0}a.header-anchor:hover,a.header-anchor:focus{text-decoration:none}figure{margin:0}img{max-width:100%}ul,ol{padding-left:1.25em}li>ul,li>ol{margin:0}table{display:block;border-collapse:collapse;margin:1rem 0;overflow-x:auto}tr{border-top:1px solid #dfe2e5}tr:nth-child(2n){background-color:#f6f8fa}th,td{border:1px solid #dfe2e5;padding:.6em 1em}blockquote{margin:1rem 0;border-left:.2rem solid #dfe2e5;padding:.25rem 0 .25rem 1rem;font-size:1rem;color:#999}blockquote>p{margin:0}form{margin:0}.theme.sidebar-open .sidebar-mask{display:block}.theme.no-navbar>h1,.theme.no-navbar>h2,.theme.no-navbar>h3,.theme.no-navbar>h4,.theme.no-navbar>h5,.theme.no-navbar>h6{margin-top:1.5rem;padding-top:0}.theme.no-navbar aside{top:0}@media screen and (min-width: 720px){.theme.no-sidebar aside{display:none}.theme.no-sidebar main{margin-left:0}}.sidebar-mask{position:fixed;z-index:2;display:none;width:100vw;height:100vh}code{margin:0;border-radius:3px;padding:.25rem .5rem;font-family:var(--code-font-family);font-size:.85em;color:var(--c-text-light);background-color:var(--code-inline-bg-color)}code .token.deleted{color:#ec5975}code .token.inserted{color:var(--c-brand)}div[class*=language-]{position:relative;margin:1rem -1.5rem;background-color:var(--code-bg-color);overflow-x:auto}li>div[class*=language-]{border-radius:6px 0 0 6px;margin:1rem -1.5rem 1rem -1.25rem;line-height:initial}@media (min-width: 420px){div[class*=language-]{margin:1rem 0;border-radius:6px}li>div[class*=language-]{margin:1rem 0 1rem 0rem;border-radius:6px}}[class*=language-] pre,[class*=language-] code{text-align:left;white-space:pre;word-spacing:normal;word-break:normal;word-wrap:normal;-moz-tab-size:4;-o-tab-size:4;tab-size:4;-webkit-hyphens:none;-moz-hyphens:none;-ms-hyphens:none;hyphens:none;background:transparent}[class*=language-] pre{position:relative;z-index:1;margin:0;padding:1.25rem 1.5rem;overflow-x:auto}[class*=language-] code{padding:0;line-height:var(--code-line-height);font-size:var(--code-font-size);color:#eee}.highlight-lines{position:absolute;top:0;bottom:0;left:0;padding:1.25rem 0;width:100%;line-height:var(--code-line-height);font-family:var(--code-font-family);font-size:var(--code-font-size);user-select:none;overflow:hidden}.highlight-lines .highlighted{background-color:#000000a8}div[class*=language-].line-numbers-mode{padding-left:3.5rem}.line-numbers-wrapper{position:absolute;top:0;bottom:0;left:0;z-index:3;border-right:1px solid rgba(0,0,0,.5);padding:1.25rem 0;width:3.5rem;text-align:center;line-height:var(--code-line-height);font-family:var(--code-font-family);font-size:var(--code-font-size);color:#888}div[class*=language-]:before{position:absolute;top:.6em;right:1em;z-index:2;font-size:.8rem;color:#888}div[class~=language-html]:before,div[class~=language-markup]:before{content:"html"}div[class~=language-md]:before,div[class~=language-markdown]:before{content:"md"}div[class~=language-css]:before{content:"css"}div[class~=language-sass]:before{content:"sass"}div[class~=language-scss]:before{content:"scss"}div[class~=language-less]:before{content:"less"}div[class~=language-stylus]:before{content:"styl"}div[class~=language-js]:before,div[class~=language-javascript]:before{content:"js"}div[class~=language-ts]:before,div[class~=language-typescript]:before{content:"ts"}div[class~=language-json]:before{content:"json"}div[class~=language-rb]:before,div[class~=language-ruby]:before{content:"rb"}div[class~=language-py]:before,div[class~=language-python]:before{content:"py"}div[class~=language-sh]:before,div[class~=language-bash]:before{content:"sh"}div[class~=language-php]:before{content:"php"}div[class~=language-go]:before{content:"go"}div[class~=language-rust]:before{content:"rust"}div[class~=language-java]:before{content:"java"}div[class~=language-c]:before{content:"c"}div[class~=language-yaml]:before{content:"yaml"}div[class~=language-dockerfile]:before{content:"dockerfile"}div[class~=language-vue]:before{content:"vue"}.token.comment,.token.block-comment,.token.prolog,.token.doctype,.token.cdata{color:#999}.token.punctuation{color:#ccc}.token.tag,.token.attr-name,.token.namespace,.token.deleted{color:#e2777a}.token.function-name{color:#6196cc}.token.boolean,.token.number,.token.function{color:#f08d49}.token.property,.token.class-name,.token.constant,.token.symbol{color:#f8c555}.token.selector,.token.important,.token.atrule,.token.keyword,.token.builtin{color:#cc99cd}.token.string,.token.char,.token.attr-value,.token.regex,.token.variable{color:#7ec699}.token.operator,.token.entity,.token.url{color:#67cdcc}.token.important,.token.bold{font-weight:700}.token.italic{font-style:italic}.token.entity{cursor:help}.token.inserted{color:green}.custom-block.tip,.custom-block.info,.custom-block.warning,.custom-block.danger{margin:1rem 0;border-left:.5rem solid;padding:.1rem 1.5rem;overflow-x:auto}.custom-block.tip{background-color:#f3f5f7;border-color:var(--c-brand)}.custom-block.info{background-color:#f3f5f7;border-color:var(--c-text-light-2)}.custom-block.warning{border-color:#e7c000;color:#6b5900;background-color:#ffe5644d}.custom-block.warning .custom-block-title{color:#b29400}.custom-block.warning a{color:var(--c-text)}.custom-block.danger{border-color:#c00;color:#4d0000;background-color:#ffe6e6}.custom-block.danger .custom-block-title{color:#900}.custom-block.danger a{color:var(--c-text)}.custom-block.details{position:relative;display:block;border-radius:2px;margin:1.6em 0;padding:1.6em;background-color:#eee}.custom-block.details h4{margin-top:0}.custom-block.details figure:last-child,.custom-block.details p:last-child{margin-bottom:0;padding-bottom:0}.custom-block.details summary{outline:none;cursor:pointer}.custom-block-title{margin-bottom:-.4rem;font-weight:600}.sidebar-links{margin:0;padding:0;list-style:none}.sidebar-link-item{display:block;margin:0;border-left:.25rem solid transparent;color:var(--c-text)}a.sidebar-link-item:hover{text-decoration:none;color:var(--c-brand)}a.sidebar-link-item.active{color:var(--c-brand)}.sidebar>.sidebar-links{padding:.75rem 0 5rem}@media (min-width: 720px){.sidebar>.sidebar-links{padding:1.5rem 0}}.sidebar>.sidebar-links>.sidebar-link+.sidebar-link{padding-top:.5rem}@media (min-width: 720px){.sidebar>.sidebar-links>.sidebar-link+.sidebar-link{padding-top:1.25rem}}.sidebar>.sidebar-links>.sidebar-link>.sidebar-link-item{padding:.35rem 1.5rem .35rem 1.25rem;font-size:1.1rem;font-weight:700}.sidebar>.sidebar-links>.sidebar-link>a.sidebar-link-item.active{border-left-color:var(--c-brand);font-weight:600}.sidebar>.sidebar-links>.sidebar-link>.sidebar-links>.sidebar-link>.sidebar-link-item{display:block;padding:.35rem 1.5rem .35rem 2rem;line-height:1.4;font-size:1rem;font-weight:400}.sidebar>.sidebar-links>.sidebar-link>.sidebar-links>.sidebar-link>a.sidebar-link-item.active{border-left-color:var(--c-brand);font-weight:600}.sidebar>.sidebar-links>.sidebar-link>.sidebar-links>.sidebar-link>.sidebar-links>.sidebar-link>.sidebar-link-item{display:block;padding:.3rem 1.5rem .3rem 3rem;line-height:1.4;font-size:.9rem;font-weight:400}.sidebar>.sidebar-links>.sidebar-link>.sidebar-links>.sidebar-link>.sidebar-links>.sidebar-link>.sidebar-links>.sidebar-link>.sidebar-link-item{display:block;padding:.3rem 1.5rem .3rem 4rem;line-height:1.4;font-size:.9rem;font-weight:400}.debug[data-v-765646fb]{box-sizing:border-box;position:fixed;right:8px;bottom:8px;z-index:9999;border-radius:4px;width:74px;height:32px;color:#eee;overflow:hidden;cursor:pointer;background-color:#000000d9;transition:all .15s ease}.debug[data-v-765646fb]:hover{background-color:#000000bf}.debug.open[data-v-765646fb]{right:0;bottom:0;width:100%;height:100%;margin-top:0;border-radius:0;padding:0;overflow:scroll}@media (min-width: 512px){.debug.open[data-v-765646fb]{width:512px}}.debug.open[data-v-765646fb]:hover{background-color:#000000d9}.title[data-v-765646fb]{margin:0;padding:6px 16px;line-height:20px;font-size:13px}.block[data-v-765646fb]{margin:2px 0 0;border-top:1px solid rgba(255,255,255,.16);padding:8px 16px;font-family:Hack,monospace;font-size:13px}.block+.block[data-v-765646fb]{margin-top:8px}.icon.outbound{position:relative;top:-1px;display:inline-block;vertical-align:middle;color:var(--c-text-lighter)}.item[data-v-49fe041d]{display:block;padding:0 1.5rem;line-height:36px;font-size:1rem;font-weight:600;color:var(--c-text);white-space:nowrap}.item[data-v-49fe041d]:hover,.item.active[data-v-49fe041d]{text-decoration:none;color:var(--c-brand)}.item.external[data-v-49fe041d]:hover{border-bottom-color:transparent;color:var(--c-text)}@media (min-width: 720px){.item[data-v-49fe041d]{border-bottom:2px solid transparent;padding:0;line-height:24px;font-size:.9rem;font-weight:500}.item[data-v-49fe041d]:hover,.item.active[data-v-49fe041d]{border-bottom-color:var(--c-brand);color:var(--c-text)}}.home-hero[data-v-5d8b683d]{margin:2.5rem 0 2.75rem;padding:0 1.5rem;text-align:center}@media (min-width: 420px){.home-hero[data-v-5d8b683d]{margin:3.5rem 0}}@media (min-width: 720px){.home-hero[data-v-5d8b683d]{margin:4rem 0 4.25rem}}.figure[data-v-5d8b683d]{padding:0 1.5rem}.image[data-v-5d8b683d]{display:block;margin:0 auto;width:auto;max-width:100%;max-height:280px}.title[data-v-5d8b683d]{margin-top:1.5rem;font-size:2rem}@media (min-width: 420px){.title[data-v-5d8b683d]{font-size:3rem}}@media (min-width: 720px){.title[data-v-5d8b683d]{margin-top:2rem}}.tagline[data-v-5d8b683d]{margin:0;margin-top:.25rem;line-height:1.3;font-size:1.2rem;color:var(--c-text-light)}@media (min-width: 420px){.tagline[data-v-5d8b683d]{line-height:1.2;font-size:1.6rem}}.action[data-v-5d8b683d]{margin-top:1.5rem;display:inline-block}.action.alt[data-v-5d8b683d]{margin-left:1.5rem}@media (min-width: 420px){.action[data-v-5d8b683d]{margin-top:2rem;display:inline-block}}.action[data-v-5d8b683d] .item{display:inline-block;border-radius:6px;padding:0 20px;line-height:44px;font-size:1rem;font-weight:500;color:var(--c-bg);background-color:var(--c-brand);border:2px solid var(--c-brand);transition:background-color .1s ease}.action.alt[data-v-5d8b683d] .item{background-color:var(--c-bg);color:var(--c-brand)}.action[data-v-5d8b683d] .item:hover{text-decoration:none;color:var(--c-bg);background-color:var(--c-brand-light)}@media (min-width: 420px){.action[data-v-5d8b683d] .item{padding:0 24px;line-height:52px;font-size:1.2rem;font-weight:500}}.home-features[data-v-245bde66]{margin:0 auto;padding:2.5rem 0 2.75rem;max-width:960px}.home-hero+.home-features[data-v-245bde66]{padding-top:0}@media (min-width: 420px){.home-features[data-v-245bde66]{padding:3.25rem 0 3.5rem}.home-hero+.home-features[data-v-245bde66]{padding-top:0}}@media (min-width: 720px){.home-features[data-v-245bde66]{padding-right:1.5rem;padding-left:1.5rem}}.wrapper[data-v-245bde66]{padding:0 1.5rem}.home-hero+.home-features .wrapper[data-v-245bde66]{border-top:1px solid var(--c-divider);padding-top:2.5rem}@media (min-width: 420px){.home-hero+.home-features .wrapper[data-v-245bde66]{padding-top:3.25rem}}@media (min-width: 720px){.wrapper[data-v-245bde66]{padding-right:0;padding-left:0}}.container[data-v-245bde66]{margin:0 auto;max-width:392px}@media (min-width: 720px){.container[data-v-245bde66]{max-width:960px}}.features[data-v-245bde66]{display:flex;flex-wrap:wrap;margin:-20px -24px}.feature[data-v-245bde66]{flex-shrink:0;padding:20px 24px;width:100%}@media (min-width: 720px){.feature[data-v-245bde66]{width:calc(100% / 3)}}.title[data-v-245bde66]{margin:0;border-bottom:0;line-height:1.4;font-size:1.25rem;font-weight:500}@media (min-width: 420px){.title[data-v-245bde66]{font-size:1.4rem}}.details[data-v-245bde66]{margin:0;line-height:1.6;font-size:1rem;color:var(--c-text-light)}.title+.details[data-v-245bde66]{padding-top:.25rem}.footer[data-v-bff49316]{margin:0 auto;max-width:960px}@media (min-width: 720px){.footer[data-v-bff49316]{padding:0 1.5rem}}.container[data-v-bff49316]{padding:2rem 1.5rem 2.25rem}.home-hero+.footer .container[data-v-bff49316],.home-features+.footer .container[data-v-bff49316],.home-content+.footer .container[data-v-bff49316]{border-top:1px solid var(--c-divider)}@media (min-width: 420px){.container[data-v-bff49316]{padding:3rem 1.5rem 3.25rem}}.text[data-v-bff49316]{margin:0;text-align:center;line-height:1.4;font-size:.9rem;color:var(--c-text-light)}.home[data-v-8382b818]{padding-top:var(--header-height)}.home-content[data-v-8382b818]{max-width:960px;margin:0 auto;padding:0 1.5rem}.nav-bar-title[data-v-016a8bd8]{font-size:1.3rem;font-weight:600;color:var(--c-text);display:flex;justify-content:center;align-items:center}.nav-bar-title[data-v-016a8bd8]:hover{text-decoration:none}.logo[data-v-016a8bd8]{margin-right:.75rem;height:1.3rem;vertical-align:bottom}.item[data-v-07381bdb]{display:block;padding:0 1.5rem 0 2.5rem;line-height:32px;font-size:.9rem;font-weight:500;color:var(--c-text);white-space:nowrap}@media (min-width: 720px){.item[data-v-07381bdb]{padding:0 24px 0 12px;line-height:32px;font-size:.85rem;font-weight:500;color:var(--c-text);white-space:nowrap}.item.active .arrow[data-v-07381bdb]{opacity:1}}.item[data-v-07381bdb]:hover,.item.active[data-v-07381bdb]{text-decoration:none;color:var(--c-brand)}.item.external[data-v-07381bdb]:hover{border-bottom-color:transparent;color:var(--c-text)}@media (min-width: 720px){.arrow[data-v-07381bdb]{display:inline-block;margin-right:8px;border-top:6px solid #ccc;border-right:4px solid transparent;border-bottom:0;border-left:4px solid transparent;vertical-align:middle;opacity:0;transform:translateY(-2px) rotate(-90deg)}}.nav-dropdown-link[data-v-18d75f62]{position:relative;height:36px;overflow:hidden;cursor:pointer}@media (min-width: 720px){.nav-dropdown-link[data-v-18d75f62]{height:auto;overflow:visible}.nav-dropdown-link:hover .dialog[data-v-18d75f62]{display:block}}.nav-dropdown-link.open[data-v-18d75f62]{height:auto}.button[data-v-18d75f62]{display:block;border:0;padding:0 1.5rem;width:100%;text-align:left;line-height:36px;font-family:var(--font-family-base);font-size:1rem;font-weight:600;color:var(--c-text);white-space:nowrap;background-color:transparent;cursor:pointer}.button[data-v-18d75f62]:focus{outline:0}@media (min-width: 720px){.button[data-v-18d75f62]{border-bottom:2px solid transparent;padding:0;line-height:24px;font-size:.9rem;font-weight:500}}.button-arrow[data-v-18d75f62]{display:inline-block;margin-top:-1px;margin-left:8px;border-top:6px solid #ccc;border-right:4px solid transparent;border-bottom:0;border-left:4px solid transparent;vertical-align:middle}.button-arrow.right[data-v-18d75f62]{transform:rotate(-90deg)}@media (min-width: 720px){.button-arrow.right[data-v-18d75f62]{transform:rotate(0)}}.dialog[data-v-18d75f62]{margin:0;padding:0;list-style:none}@media (min-width: 720px){.dialog[data-v-18d75f62]{display:none;position:absolute;top:26px;right:-8px;border-radius:6px;padding:12px 0;min-width:128px;background-color:var(--c-bg);box-shadow:var(--shadow-3)}}.nav-links[data-v-35b91e7e]{padding:.75rem 0;border-bottom:1px solid var(--c-divider)}@media (min-width: 720px){.nav-links[data-v-35b91e7e]{display:flex;padding:6px 0 0;align-items:center;border-bottom:0}.item+.item[data-v-35b91e7e]{padding-left:24px}}.sidebar-button{position:absolute;top:.6rem;left:1rem;display:none;padding:.6rem;cursor:pointer}.sidebar-button .icon{display:block;width:1.25rem;height:1.25rem}@media screen and (max-width: 719px){.sidebar-button{display:block}}.nav-bar[data-v-40587210]{position:fixed;top:0;right:0;left:0;z-index:var(--z-index-navbar);display:flex;justify-content:space-between;align-items:center;border-bottom:1px solid var(--c-divider);padding:.7rem 1.5rem .7rem 4rem;height:var(--header-height);background-color:var(--c-bg)}@media (min-width: 720px){.nav-bar[data-v-40587210]{padding:.7rem 1.5rem}}.flex-grow[data-v-40587210]{flex-grow:1}.nav[data-v-40587210]{display:none}@media (min-width: 720px){.nav[data-v-40587210]{display:block}}.sidebar[data-v-17c48e2f]{position:fixed;top:var(--header-height);bottom:0;left:0;z-index:var(--z-index-sidebar);border-right:1px solid var(--c-divider);width:16.4rem;background-color:var(--c-bg);overflow-y:auto;transform:translate(-100%);transition:transform .25s ease}@media (min-width: 720px){.sidebar[data-v-17c48e2f]{transform:translate(0)}}@media (min-width: 960px){.sidebar[data-v-17c48e2f]{width:20rem}}.sidebar.open[data-v-17c48e2f]{transform:translate(0)}.nav[data-v-17c48e2f]{display:block}@media (min-width: 720px){.nav[data-v-17c48e2f]{display:none}}.link[data-v-55695e90]{display:inline-block;font-size:1rem;font-weight:500;color:var(--c-text-light)}.link[data-v-55695e90]:hover{text-decoration:none;color:var(--c-brand)}.icon[data-v-55695e90]{margin-left:4px}.last-updated[data-v-7e06cdca]{display:inline-block;margin:0;line-height:1.4;font-size:.9rem;color:var(--c-text-light)}@media (min-width: 960px){.last-updated[data-v-7e06cdca]{font-size:1rem}}.prefix[data-v-7e06cdca]{display:inline-block;font-weight:500}.datetime[data-v-7e06cdca]{display:inline-block;margin-left:6px;font-weight:400}.page-footer[data-v-b65b4b36]{padding-top:1rem;padding-bottom:1rem;overflow:auto}@media (min-width: 960px){.page-footer[data-v-b65b4b36]{display:flex;justify-content:space-between;align-items:center}}.updated[data-v-b65b4b36]{padding-top:4px}@media (min-width: 960px){.updated[data-v-b65b4b36]{padding-top:0}}.next-and-prev-link[data-v-e65a9748]{padding-top:1rem}.container[data-v-e65a9748]{display:flex;justify-content:space-between;border-top:1px solid var(--c-divider);padding-top:1rem}.prev[data-v-e65a9748],.next[data-v-e65a9748]{display:flex;flex-shrink:0;width:50%}.prev[data-v-e65a9748]{justify-content:flex-start;padding-right:12px}.next[data-v-e65a9748]{justify-content:flex-end;padding-left:12px}.link[data-v-e65a9748]{display:inline-flex;align-items:center;max-width:100%;font-size:1rem;font-weight:500}.text[data-v-e65a9748]{display:block;white-space:nowrap;overflow:hidden;text-overflow:ellipsis}.icon[data-v-e65a9748]{display:block;flex-shrink:0;width:16px;height:16px;fill:var(--c-text);transform:translateY(1px)}.icon-prev[data-v-e65a9748]{margin-right:8px}.icon-next[data-v-e65a9748]{margin-left:8px}.page[data-v-8fcebc32]{padding-top:var(--header-height)}@media (min-width: 720px){.page[data-v-8fcebc32]{margin-left:16.4rem}}@media (min-width: 960px){.page[data-v-8fcebc32]{margin-left:20rem}}.container[data-v-8fcebc32]{margin:0 auto;padding:0 1.5rem 4rem;max-width:48rem}.content[data-v-8fcebc32]{padding-bottom:1.5rem}@media (max-width: 420px){.content[data-v-8fcebc32]{clear:both}}#ads-container{margin:0 auto}@media (min-width: 420px){#ads-container{position:relative;right:0;float:right;margin:-8px -8px 24px 24px;width:146px}}@media (max-width: 420px){#ads-container{height:105px;margin:1.75rem 0}}@media (min-width: 1400px){#ads-container{position:fixed;right:8px;bottom:8px}}.tabs-component-tabs{border:solid 1px #ddd;border-radius:6px;margin-bottom:5px}@media (min-width: 700px){.tabs-component-tabs{border:0;align-items:stretch;display:flex;justify-content:flex-start;margin-bottom:-1px}}.tabs-component-tab{color:#999;font-size:14px;font-weight:600;margin-right:0;list-style:none}.tabs-component-tab:hover{color:#666}.tabs-component-tab.is-active{color:#000}.tabs-component-tab.is-disabled *{color:#cdcdcd;cursor:not-allowed!important}@media (min-width: 700px){.tabs-component-tab{background-color:#fff;border:solid 1px #ddd;border-radius:3px 3px 0 0;margin-right:.5em;transform:translateY(2px);transition:transform .3s ease}.tabs-component-tab.is-active{border-bottom:solid 1px #fff;z-index:2;transform:translateY(0)}}.tabs-component-tab-a{align-items:center;color:inherit;display:flex;padding:.5em 1.25em;text-decoration:none}.tabs-component-panels{padding:1em 0}@media (min-width: 700px){.tabs-component-panels{background-color:#fff;border:solid 1px #ddd;border-radius:6px;box-shadow:0 0 10px #0000000d;padding:1em;position:relative}}:root{--c-brand: #74a535;--c-brand-light: #94c73d;--c-bg: #fefefe}.tabs-component{margin:2em 0}.tabs-component-panels{padding:0;border:none}.tabs-component-tab-a{padding:.5em}.tabs-component-tab{transform:none}@media (min-width: 700px){.tabs-component-tab.is-active{border-bottom:solid 1px #ddd}}
diff --git a/guide/annotations.html b/guide/annotations.html
new file mode 100644
index 00000000..7650369a
--- /dev/null
+++ b/guide/annotations.html
@@ -0,0 +1,96 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Annotations | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_annotations.md.8cc52798.lean.js">
+    
+    <meta name="twitter:title" content="Annotations | Swagger-PHP">
+  <meta property="og:title" content="Annotations | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/annotations">Annotations</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#doctrine">Doctrine</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#escaping">Escaping</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#arrays-and-objects">Arrays and Objects</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#constants">Constants</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="annotations" tabindex="-1">Annotations <a class="header-anchor" href="#annotations" aria-hidden="true">#</a></h1><div class="tip custom-block"><p class="custom-block-title">Namespace</p><p>Using a namespace alias simplifies typing and improves readability.</p><p>All annotations are in the <code>OpenApi\Annotations</code> namespace.</p></div><p>Since Annotations are technically PHP comments, adding <code>use OpenApi\Annotations as OA;</code> is strictly speaking not necessary. However, doctrine will be quite specific about whether an alias is valid or not.</p><p><code>swagger-php</code> will automatically register the <code>@OA</code> alias so all annotations can be used using the <code>@OA</code> shortcut without any additional work.</p><h2 id="doctrine" tabindex="-1">Doctrine <a class="header-anchor" href="#doctrine" aria-hidden="true">#</a></h2><p>Annotations are PHP comments (docblocks) containing <a href="https://www.doctrine-project.org/projects/annotations.html" target="_blank" rel="noopener noreferrer">doctrine style annotations</a>.</p><div class="info custom-block"><p class="custom-block-title">INFO</p><p>All documentation related to doctrine applies to annotations only.</p></div><p><strong>Example:</strong></p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Annotations</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @OA\Info(title=&quot;My First API&quot;, version=&quot;0.1&quot;)
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApi</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span> <span class="token punctuation">{</span>
+
+    <span class="token comment">/**
+     * @OA\Get(
+     *     path=&quot;/api/resource.json&quot;,
+     *     @OA\Response(response=&quot;200&quot;, description=&quot;An example resource&quot;)
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">resource</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token comment">// ...</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><h2 id="escaping" tabindex="-1">Escaping <a class="header-anchor" href="#escaping" aria-hidden="true">#</a></h2><div class="tip custom-block"><p class="custom-block-title">Escaping double quotes</p><p>Double quotes can be escaped by doubling them rather than using <code>\</code></p><p>For example:</p><div class="language-php"><pre><code>    @<span class="token constant">OA</span><span class="token function"><span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span>
+       title<span class="token operator">=</span><span class="token string double-quoted-string">&quot;Request&quot;</span><span class="token punctuation">,</span>
+       schema<span class="token operator">=</span><span class="token string double-quoted-string">&quot;Request&quot;</span><span class="token punctuation">,</span>
+       example<span class="token operator">=</span><span class="token punctuation">{</span>
+          <span class="token string double-quoted-string">&quot;configuration&quot;</span><span class="token punctuation">:</span><span class="token string double-quoted-string">&quot;{&quot;</span><span class="token string double-quoted-string">&quot;formConfig&quot;</span><span class="token string double-quoted-string">&quot;:123}&quot;</span>
+       <span class="token punctuation">}</span>
+     <span class="token punctuation">)</span>
+</code></pre></div></div><h2 id="arrays-and-objects" tabindex="-1">Arrays and Objects <a class="header-anchor" href="#arrays-and-objects" aria-hidden="true">#</a></h2><p>Doctrine annotations support arrays, but use <code>{</code> and <code>}</code> instead of <code>[</code> and <code>]</code>.</p><p>Doctrine also supports objects, which also use <code>{</code> and <code>}</code> and require the property names to be surrounded with <code>&quot;</code>.</p><div class="warning custom-block"><p class="custom-block-title">DON&#39;T WRITE</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Info(
+ *   title=&quot;My first API&quot;,
+ *   version=&quot;1.0.0&quot;,
+ *   contact={
+ *     &quot;email&quot;: &quot;support@example.com&quot;
+ *   }
+ * )
+ */</span>
+</code></pre></div></div><p>This &quot;works&quot; but most objects have an annotation with the same name as the property, such as <code>@OA\Contact</code> for <code>contact</code>:</p><div class="tip custom-block"><p class="custom-block-title">WRITE</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Info(
+ *   title=&quot;My first API&quot;,
+ *   version=&quot;1.0.0&quot;,
+ *   @OA\Contact(
+ *     email=&quot;support@example.com&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div></div><p>This also adds validation, so when you misspell a property or forget a required property, it will trigger a PHP warning.</p><p>For example, if you write <code>emial=&quot;support@example.com&quot;</code>, swagger-php would generate a notice with <code>Unexpected field &quot;emial&quot; for @OA\Contact(), expecting &quot;name&quot;, &quot;email&quot;, ...</code></p><p>Placing multiple annotations of the same type will result in an array of objects. For objects, the key is defined by the field with the same name as the annotation: <code>response</code> in a <code>@OA\Response</code>, <code>property</code> in a <code>@OA\Property</code>, etc.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Get(
+ *   path=&quot;/products&quot;,
+ *   summary=&quot;list products&quot;,
+ *   @OA\Response(
+ *     response=200,
+ *     description=&quot;A list with products&quot;
+ *   ),
+ *   @OA\Response(
+ *     response=&quot;default&quot;,
+ *     description=&quot;an &quot;&quot;unexpected&quot;&quot; error&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div><p><strong>Results in</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">paths</span><span class="token punctuation">:</span>
+  <span class="token key atrule">/products</span><span class="token punctuation">:</span>
+    <span class="token key atrule">get</span><span class="token punctuation">:</span>
+      <span class="token key atrule">summary</span><span class="token punctuation">:</span> <span class="token string">&quot;list products&quot;</span>
+      <span class="token key atrule">responses</span><span class="token punctuation">:</span>
+        <span class="token key atrule">&quot;200&quot;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&quot;A list with products&quot;</span>
+        <span class="token key atrule">default</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;an &quot;unexpected&quot; error&#39;</span>
+</code></pre></div><h2 id="constants" tabindex="-1">Constants <a class="header-anchor" href="#constants" aria-hidden="true">#</a></h2><p>You can use constants inside doctrine annotations.</p><div class="language-php"><pre><code><span class="token function">define</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;API_HOST&quot;</span><span class="token punctuation">,</span> <span class="token punctuation">(</span><span class="token variable">$env</span> <span class="token operator">===</span> <span class="token string double-quoted-string">&quot;production&quot;</span><span class="token punctuation">)</span> <span class="token operator">?</span> <span class="token string double-quoted-string">&quot;example.com&quot;</span> <span class="token punctuation">:</span> <span class="token string double-quoted-string">&quot;localhost&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Server(url=API_HOST)
+ */</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>Using the CLI you might need to include the php file with the constants using the <code>--bootstrap</code> options.</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> openapi <span class="token parameter variable">--bootstrap</span> constants.php
+</code></pre></div></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/attributes" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Attributes</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/required-elements" data-v-e65a9748><span class="text" data-v-e65a9748>Required elements</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/attributes.html b/guide/attributes.html
new file mode 100644
index 00000000..ff9eba7c
--- /dev/null
+++ b/guide/attributes.html
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Attributes | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_attributes.md.3e0b725a.lean.js">
+    
+    <meta name="twitter:title" content="Attributes | Swagger-PHP">
+  <meta property="og:title" content="Attributes | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/attributes">Attributes</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#nesting">Nesting</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="attributes" tabindex="-1">Attributes <a class="header-anchor" href="#attributes" aria-hidden="true">#</a></h1><div class="tip custom-block"><p class="custom-block-title">Namespace</p><p>Using a namespace alias simplifies typing and improves readability.</p><p>All attributes are in the <code>OpenApi\Attributes</code> namespace.</p></div><h2 id="nesting" tabindex="-1">Nesting <a class="header-anchor" href="#nesting" aria-hidden="true">#</a></h2><p>Similar to annotations attributes can be top level or nested. However, attributes <strong>may be put at the same level</strong> if there is no ambiguity. <code>swagger-php</code> will then merge attributes according to the defined rules about parent/child relationships.</p><p><strong>Example</strong></p><p>Nested:</p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Get</span><span class="token punctuation">(</span>
+        <span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/api/users&#39;</span><span class="token punctuation">,</span>
+        <span class="token attribute-class-name class-name">responses</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
+            <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">200</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;AOK&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+            <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">401</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;Not allowed&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+        <span class="token punctuation">]</span>
+    <span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">users</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Not nested:</p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/api/users&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">200</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;AOK&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token number">401</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;Not allowed&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">users</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Depending on how much nesting there is this can make things a bit simpler and easier to read.</p><div class="warning custom-block"><p class="custom-block-title">Top level only</p><p>Automatic merging of attributes works only at the top level - in the example that would be the method <code>users()</code>.</p></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/generating-openapi-documents" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Generating OpenAPI documents</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/annotations" data-v-e65a9748><span class="text" data-v-e65a9748>Annotations</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/common-techniques.html b/guide/common-techniques.html
new file mode 100644
index 00000000..4119ecd4
--- /dev/null
+++ b/guide/common-techniques.html
@@ -0,0 +1,236 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Common techniques | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_common-techniques.md.e2af46b9.lean.js">
+    
+    <meta name="twitter:title" content="Common techniques | Swagger-PHP">
+  <meta property="og:title" content="Common techniques | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/common-techniques">Common techniques</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#annotation-placement">Annotation placement</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#context-awareness">Context awareness</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#response-media-type">Response media type</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#using-references-ref">Using references - $ref</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#array-parameters-in-query">Array parameters in query</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#vendor-extensions">Vendor extensions</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#enums">Enums</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#enum-cases-as-value">Enum cases as value</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#enum-schemas">Enum schemas</a><!----></li></ul></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="common-techniques" tabindex="-1">Common techniques <a class="header-anchor" href="#common-techniques" aria-hidden="true">#</a></h1><h2 id="annotation-placement" tabindex="-1">Annotation placement <a class="header-anchor" href="#annotation-placement" aria-hidden="true">#</a></h2><p>You shouldn&#39;t place all annotations inside one big block, but scatter them throughout your codebase as close to the relevant source code as appropriate.</p><p><code>swagger-php</code> will scan your project and merge all meta-data into one<code> @OA\OpenApi</code> annotation.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>As of <code>swagger-php</code> v4 all annotations or attributes must be associated with a structural element (<code>class</code>, <code>method</code>, <code>parameter</code> or <code>enum</code>)</p></div><h2 id="context-awareness" tabindex="-1">Context awareness <a class="header-anchor" href="#context-awareness" aria-hidden="true">#</a></h2><p><code>swagger-php</code> looks at the context of the annotation and will augment it with things like <code>property name</code>, <code>data type</code> (doctype and native type hints) as well as a couple other things.</p><p>This means in a lot of cases it is not necessary to explicitly document all details.</p><p><strong>Example</strong></p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token comment">/**
+ * @OA\Schema()
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span> <span class="token punctuation">{</span>
+
+    <span class="token comment">/**
+     * The product name,
+     * @var string
+     * @OA\Property()
+     */</span>
+    <span class="token keyword">public</span> <span class="token variable">$name</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><p><strong>Results in</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">name</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&quot;The product name&quot;</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><p><strong>As if you&#39;d written</strong></p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * The product name
+     * @var string
+     *
+     * @OA\Property(
+     *   property=&quot;name&quot;,
+     *   type=&quot;string&quot;,
+     *   description=&quot;The product name&quot;
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token variable">$name</span><span class="token punctuation">;</span>
+</code></pre></div><h2 id="response-media-type" tabindex="-1">Response media type <a class="header-anchor" href="#response-media-type" aria-hidden="true">#</a></h2><p>The <code>@OA\MediaType</code> is used to describe the content:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Response(
+ *     response=200,
+ *     description=&quot;successful operation&quot;,
+ *     @OA\MediaType(
+ *         mediaType=&quot;application/json&quot;,
+ *         @OA\Schema(ref=&quot;#/components/schemas/User&quot;),
+ *     )
+ * ),
+ */</span>
+</code></pre></div><p>But because most API requests and responses are JSON, the <code>@OA\JsonContent</code> allows you to simplify this by writing:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Response(
+ *     response=200,
+ *     description=&quot;successful operation&quot;,
+ *     @OA\JsonContent(ref=&quot;#/components/schemas/User&quot;),
+ * )
+ */</span>
+</code></pre></div><p>During processing the <code>@OA\JsonContent</code> unfolds to <code>@OA\MediaType( mediaType=&quot;application/json&quot;, @OA\Schema(...)</code> and will generate the same output.</p><h2 id="using-references-ref" tabindex="-1">Using references - <code>$ref</code> <a class="header-anchor" href="#using-references-ref" aria-hidden="true">#</a></h2><p>It&#39;s quite common that endpoints have some overlap in either their request or response data. To keep things DRY (Don&#39;t Repeat Yourself) the specification allows reusing components using <code>$ref</code>&#39;s</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Schema(
+ *   schema=&quot;product_id&quot;,
+ *   type=&quot;integer&quot;,
+ *   format=&quot;int64&quot;,
+ *   description=&quot;The unique identifier of a product in our catalog&quot;
+ * )
+ */</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">product_id</span><span class="token punctuation">:</span>
+      <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&quot;The unique identifier of a product in our catalog&quot;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+      <span class="token key atrule">format</span><span class="token punctuation">:</span> int64
+</code></pre></div><p>This doesn&#39;t do anything by itself, but now you can reference this fragment by its path in the document tree <code>#/components/schemas/product_id</code></p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * @OA\Property(ref=&quot;#/components/schemas/product_id&quot;)
+     */</span>
+    <span class="token keyword">public</span> <span class="token variable">$id</span><span class="token punctuation">;</span>
+</code></pre></div><div class="info custom-block"><p class="custom-block-title">Examples</p><p>There are more uses cases on how to use refs in the <a href="https://github.com/zircote/swagger-php/tree/master/Examples/using-refs" target="_blank" rel="noopener noreferrer">using-refs example</a>.</p></div><h2 id="array-parameters-in-query" tabindex="-1">Array parameters in query <a class="header-anchor" href="#array-parameters-in-query" aria-hidden="true">#</a></h2><p>Depending on <a href="https://swagger.io/specification/#style-values" target="_blank" rel="noopener noreferrer">style-values</a> <code>@OA\Parameter(in=&quot;query&quot;, name=&quot;param&quot;, ...)</code> might create urls like this: <code>path?param=123&amp;param=abc</code> which do not work when reading the param values in PHP.</p><p>The solution is to change the name <code>param</code> into <code>param[]</code> which will create <code>path?param[]=123&amp;param[]=abc</code> and results in a PHP array.</p><h2 id="vendor-extensions" tabindex="-1">Vendor extensions <a class="header-anchor" href="#vendor-extensions" aria-hidden="true">#</a></h2><p>The specification allows for <a href="http://swagger.io/specification/#vendorExtensions" target="_blank" rel="noopener noreferrer">custom properties</a> as long as they start with &quot;x-&quot;. Therefore, all swagger-php annotations have an <code>x</code> property which accepts an array (map) and will unfold into &quot;x-&quot; properties.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Info(
+ *   title=&quot;Example&quot;,
+ *   version=&quot;1.0.0&quot;,
+ *   x={
+ *     &quot;some-name&quot;: &quot;a-value&quot;,
+ *     &quot;another&quot;: 2,
+ *     &quot;complex-type&quot;: {
+ *       &quot;supported&quot;:{
+ *         {&quot;version&quot;: &quot;1.0&quot;, &quot;level&quot;: &quot;baseapi&quot;},
+ *         {&quot;version&quot;: &quot;2.1&quot;, &quot;level&quot;: &quot;fullapi&quot;},
+ *       }
+ *     }
+ *   }
+ * )
+ */</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">info</span><span class="token punctuation">:</span>
+  <span class="token key atrule">title</span><span class="token punctuation">:</span> Example
+  <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token number">1</span>
+  <span class="token key atrule">x-some-name</span><span class="token punctuation">:</span> a<span class="token punctuation">-</span>value
+  <span class="token key atrule">x-another</span><span class="token punctuation">:</span> <span class="token number">2</span>
+  <span class="token key atrule">x-complex-type</span><span class="token punctuation">:</span>
+    <span class="token key atrule">supported</span><span class="token punctuation">:</span>
+      <span class="token punctuation">-</span> <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token string">&quot;1.0&quot;</span>
+        <span class="token key atrule">level</span><span class="token punctuation">:</span> baseapi
+      <span class="token punctuation">-</span> <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token string">&quot;2.1&quot;</span>
+        <span class="token key atrule">level</span><span class="token punctuation">:</span> fullapi
+</code></pre></div><h2 id="enums" tabindex="-1">Enums <a class="header-anchor" href="#enums" aria-hidden="true">#</a></h2><p><a href="https://www.php.net/manual/en/language.enumerations.basics.php" target="_blank" rel="noopener noreferrer">PHP 8.1 enums</a> are supported in two main use cases.</p><h3 id="enum-cases-as-value" tabindex="-1">Enum cases as value <a class="header-anchor" href="#enum-cases-as-value" aria-hidden="true">#</a></h3><p>Enum cases can be used as value in an <code>enum</code> list just like a <code>string</code>, <code>integer</code> or any other primitive type.</p><p><strong>Basic enum:</strong></p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Suit</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">Hearts</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">Diamonds</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">Clubs</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">Spades</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Model</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">enum</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token attribute-class-name class-name">Suit</span><span class="token operator">::</span><span class="token constant">Hearts</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">Suit</span><span class="token operator">::</span><span class="token constant">Diamonds</span><span class="token punctuation">]</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">protected</span> <span class="token keyword type-declaration">array</span> <span class="token variable">$someSuits</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Model</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">someSuits</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+          <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+            <span class="token punctuation">-</span> Hearts
+            <span class="token punctuation">-</span> Diamonds
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+
+</code></pre></div><p><strong>Backed enums</strong></p><p>If the enum is a backed enum, the case backing value is used instead of the name.</p><h2 id="enum-schemas" tabindex="-1">Enum schemas <a class="header-anchor" href="#enum-schemas" aria-hidden="true">#</a></h2><p>The simples way of using enums is to annotate them as <code>Schema</code>. This allows you to reference them like any other schema in your spec.</p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Colour</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">GREEN</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">BLUE</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">RED</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token class-name type-declaration">Colour</span> <span class="token variable">$colour</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Colour</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> GREEN
+        <span class="token punctuation">-</span> BLUE
+        <span class="token punctuation">-</span> RED
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">colour</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Colour&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><p><strong>Backed enums</strong></p><p>For backed enums there exist two rules that determine whether the name or backing value is used:</p><ol><li>If no schema type is given, the enum name is used.</li><li>If a schema type is given, and it matches the backing type, the enum backing value is used.</li></ol><p><strong>Using the name of a backed enum:</strong></p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Colour</span><span class="token punctuation">:</span> <span class="token keyword type-declaration">int</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">GREEN</span> <span class="token operator">=</span> <span class="token number">1</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">BLUE</span> <span class="token operator">=</span> <span class="token number">2</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">RED</span> <span class="token operator">=</span> <span class="token number">3</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token class-name type-declaration">Colour</span> <span class="token variable">$colour</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Colour</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> GREEN
+        <span class="token punctuation">-</span> BLUE
+        <span class="token punctuation">-</span> RED
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">colour</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Colour&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><p><strong>Using the backing value:</strong></p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;integer&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">Colour</span><span class="token punctuation">:</span> <span class="token keyword type-declaration">int</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">GREEN</span> <span class="token operator">=</span> <span class="token number">1</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">BLUE</span> <span class="token operator">=</span> <span class="token number">2</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">RED</span> <span class="token operator">=</span> <span class="token number">3</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Product</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token class-name type-declaration">Colour</span> <span class="token variable">$colour</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Results in:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Colour</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> <span class="token number">1</span>
+        <span class="token punctuation">-</span> <span class="token number">2</span>
+        <span class="token punctuation">-</span> <span class="token number">3</span>
+    <span class="token key atrule">Product</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">colour</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Colour&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/required-elements" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Required elements</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/migrating-to-v4" data-v-e65a9748><span class="text" data-v-e65a9748>Migration from 3.x to 4.x</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/cookbook.html b/guide/cookbook.html
new file mode 100644
index 00000000..c2e9389e
--- /dev/null
+++ b/guide/cookbook.html
@@ -0,0 +1,516 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Cookbook | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_cookbook.md.2d416869.lean.js">
+    
+    <meta name="twitter:title" content="Cookbook | Swagger-PHP">
+  <meta property="og:title" content="Cookbook | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/cookbook">Cookbook</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#x-taggroups">x-tagGroups</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#adding-examples-to-oa-response">Adding examples to @OA\Response</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#external-documentation">External documentation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#properties-with-union-types">Properties with union types</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#referencing-a-security-scheme">Referencing a security scheme</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#file-upload-with-headers">File upload with headers</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#set-the-xml-root-name">Set the XML root name</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#upload-multipart-form-data">upload multipart/form-data</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#default-security-scheme-for-all-endpoints">Default security scheme for all endpoints</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#nested-objects">Nested objects</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#documenting-union-type-response-data-using-oneof">Documenting union type response data using oneOf</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#reusing-responses">Reusing responses</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mediatype">mediaType=&quot;/&quot;</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#warning-about-multiple-response-with-same-response-200">Warning about Multiple response with same response=&quot;200&quot;</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#callbacks">Callbacks</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mostly-virtual-models">(Mostly) virtual models</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#using-class-name-as-type-instead-of-references">Using class name as type instead of references</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#enums">Enums</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#multi-value-query-parameter-q-1-q-1">Multi value query parameter: &amp;q[]=1&amp;q[]=1</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#custom-response-classes">Custom response classes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#annotating-class-constants">Annotating class constants</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="cookbook" tabindex="-1">Cookbook <a class="header-anchor" href="#cookbook" aria-hidden="true">#</a></h1><h2 id="x-taggroups" tabindex="-1"><code>x-tagGroups</code> <a class="header-anchor" href="#x-taggroups" aria-hidden="true">#</a></h2><p>OpenApi has the concept of grouping endpoints using tags. On top of that, some tools (<a href="https://redoc.ly/docs/api-reference-docs/specification-extensions/x-tag-groups/" target="_blank" rel="noopener noreferrer">redocly</a>, for example) support further grouping via the vendor extension <code>x-tagGroups</code>.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\OpenApi(
+ *   x={
+ *       &quot;tagGroups&quot;=
+ *           {{&quot;name&quot;=&quot;User Management&quot;, &quot;tags&quot;={&quot;Users&quot;, &quot;API keys&quot;, &quot;Admin&quot;}}
+ *       }
+ *   }
+ * )
+ */</span>
+</code></pre></div><h2 id="adding-examples-to-oa-response" tabindex="-1">Adding examples to <code>@OA\Response</code> <a class="header-anchor" href="#adding-examples-to-oa-response" aria-hidden="true">#</a></h2><div class="language-php"><pre><code><span class="token comment">/*
+ * @OA\Response(
+ *     response=200,
+ *     description=&quot;OK&quot;,
+ *     @OA\JsonContent(
+ *         oneOf={
+ *             @OA\Schema(ref=&quot;#/components/schemas/Result&quot;),
+ *             @OA\Schema(type=&quot;boolean&quot;)
+ *         },
+ *         @OA\Examples(example=&quot;result&quot;, value={&quot;success&quot;: true}, summary=&quot;An result object.&quot;),
+ *         @OA\Examples(example=&quot;bool&quot;, value=false, summary=&quot;A boolean value.&quot;),
+ *     )
+ * )
+ */</span>
+</code></pre></div><h2 id="external-documentation" tabindex="-1">External documentation <a class="header-anchor" href="#external-documentation" aria-hidden="true">#</a></h2><p>OpenApi allows a single reference to external documentation. This is a part of the top level <code>@OA\OpenApi</code>.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\OpenApi(
+ *   @OA\ExternalDocumentation(
+ *     description=&quot;More documentation here...&quot;,
+ *     url=&quot;https://example.com/externaldoc1/&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">TIP</p><p>If no <code>@OA\OpenApi</code> is configured, <code>swagger-php</code> will create one automatically.</p><p>That means the above example would also work with just the <code>OA\ExternalDocumentation</code> annotation.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\ExternalDocumentation(
+ *   description=&quot;More documentation here...&quot;,
+ *   url=&quot;https://example.com/externaldoc1/&quot;
+ * )
+ */</span>
+</code></pre></div></div><h2 id="properties-with-union-types" tabindex="-1">Properties with union types <a class="header-anchor" href="#properties-with-union-types" aria-hidden="true">#</a></h2><p>Sometimes properties or even lists (arrays) may contain data of different types. This can be expressed using <code>oneOf</code>.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Schema(
+ *      schema=&quot;StringList&quot;,
+ *      @OA\Property(property=&quot;value&quot;, type=&quot;array&quot;, @OA\Items(anyOf={@OA\Schema(type=&quot;string&quot;)}))
+ * )
+ * @OA\Schema(
+ *      schema=&quot;String&quot;,
+ *      @OA\Property(property=&quot;value&quot;, type=&quot;string&quot;)
+ * )
+ * @OA\Schema(
+ *      schema=&quot;Object&quot;,
+ *      @OA\Property(property=&quot;value&quot;, type=&quot;object&quot;)
+ * )
+ * @OA\Schema(
+ *     schema=&quot;mixedList&quot;,
+ *     @OA\Property(property=&quot;fields&quot;, type=&quot;array&quot;, @OA\Items(oneOf={
+ *         @OA\Schema(ref=&quot;#/components/schemas/StringList&quot;),
+ *         @OA\Schema(ref=&quot;#/components/schemas/String&quot;),
+ *         @OA\Schema(ref=&quot;#/components/schemas/Object&quot;)
+ *     }))
+ * )
+ */</span>
+</code></pre></div><p>This will resolve into this YAML</p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">StringList</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">value</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+          <span class="token key atrule">items</span><span class="token punctuation">:</span>
+            <span class="token key atrule">anyOf</span><span class="token punctuation">:</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">String</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">value</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">Object</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">value</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">mixedList</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">fields</span><span class="token punctuation">:</span>
+          <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+          <span class="token key atrule">items</span><span class="token punctuation">:</span>
+            <span class="token key atrule">oneOf</span><span class="token punctuation">:</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/StringList&#39;</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/String&#39;</span>
+              <span class="token punctuation">-</span>
+                <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/Object&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+</code></pre></div><h2 id="referencing-a-security-scheme" tabindex="-1">Referencing a security scheme <a class="header-anchor" href="#referencing-a-security-scheme" aria-hidden="true">#</a></h2><p>An API might have zero or more security schemes. These are defined at the top level and vary from simple to complex:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\SecurityScheme(
+ *     type=&quot;apiKey&quot;,
+ *     name=&quot;api_key&quot;,
+ *     in=&quot;header&quot;,
+ *     securityScheme=&quot;api_key&quot;
+ * )
+ *
+ * @OA\SecurityScheme(
+ *   type=&quot;oauth2&quot;,
+ *   securityScheme=&quot;petstore_auth&quot;,
+ *   @OA\Flow(
+ *      authorizationUrl=&quot;http://petstore.swagger.io/oauth/dialog&quot;,
+ *      flow=&quot;implicit&quot;,
+ *      scopes={
+ *         &quot;read:pets&quot;: &quot;read your pets&quot;,
+ *         &quot;write:pets&quot;: &quot;modify pets in your account&quot;
+ *      }
+ *   )
+ * )
+ */</span>
+</code></pre></div><p>To declare an endpoint as secure and define what security schemes are available to authenticate a client it needs to be added to the operation, for example:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Get(
+ *      path=&quot;/api/secure/&quot;,
+ *      summary=&quot;Requires authentication&quot;
+ *    ),
+ *    security={ {&quot;api_key&quot;: {}} }
+ * )
+ */</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">Endpoints can support multiple security schemes and have custom options too:</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Get(
+ *      path=&quot;/api/secure/&quot;,
+ *      summary=&quot;Requires authentication&quot;
+ *    ),
+ *    security={
+ *      { &quot;api_key&quot;: {} },
+ *      { &quot;petstore_auth&quot;: {&quot;write:pets&quot;, &quot;read:pets&quot;} }
+ *    }
+ * )
+ */</span>
+</code></pre></div></div><h2 id="file-upload-with-headers" tabindex="-1">File upload with headers <a class="header-anchor" href="#file-upload-with-headers" aria-hidden="true">#</a></h2><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Post(
+ *   path=&quot;/v1/media/upload&quot;,
+ *   summary=&quot;Upload document&quot;,
+ *   description=&quot;&quot;,
+ *   tags={&quot;Media&quot;},
+ *   @OA\RequestBody(
+ *     required=true,
+ *     @OA\MediaType(
+ *       mediaType=&quot;application/octet-stream&quot;,
+ *       @OA\Schema(
+ *         required={&quot;content&quot;},
+ *         @OA\Property(
+ *           description=&quot;Binary content of file&quot;,
+ *           property=&quot;content&quot;,
+ *           type=&quot;string&quot;,
+ *           format=&quot;binary&quot;
+ *         )
+ *       )
+ *     )
+ *   ),
+ *   @OA\Response(
+ *     response=200, description=&quot;Success&quot;,
+ *     @OA\Schema(type=&quot;string&quot;)
+ *   ),
+ *   @OA\Response(
+ *     response=400, description=&quot;Bad Request&quot;
+ *   )
+ * )
+ */</span>
+</code></pre></div><h2 id="set-the-xml-root-name" tabindex="-1">Set the XML root name <a class="header-anchor" href="#set-the-xml-root-name" aria-hidden="true">#</a></h2><p>The <code>OA\Xml</code> annotation may be used to set the XML root element for a given <code>@OA\XmlContent</code> response body</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Schema(
+ *     schema=&quot;Error&quot;,
+ *     @OA\Property(property=&quot;message&quot;),
+ *     @OA\Xml(name=&quot;details&quot;)
+ * )
+ */</span>
+
+<span class="token comment">/**
+ * @OA\Post(
+ *     path=&quot;/foobar&quot;,
+ *     @OA\Response(
+ *         response=400,
+ *         description=&quot;Request error&quot;,
+ *         @OA\XmlContent(ref=&quot;#/components/schemas/Error&quot;,
+ *           @OA\Xml(name=&quot;error&quot;)
+ *        )
+ *     )
+ * )
+ */</span>
+</code></pre></div><h2 id="upload-multipart-form-data" tabindex="-1">upload multipart/form-data <a class="header-anchor" href="#upload-multipart-form-data" aria-hidden="true">#</a></h2><p>Form posts are <code>@OA\Post</code> requests with a <code>multipart/form-data</code> <code>@OA\RequestBody</code>. The relevant bit looks something like this</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Post(
+ *   path=&quot;/v1/user/update&quot;,
+ *   summary=&quot;Form post&quot;,
+ *   @OA\RequestBody(
+ *     @OA\MediaType(
+ *       mediaType=&quot;multipart/form-data&quot;,
+ *       @OA\Schema(
+ *         @OA\Property(property=&quot;name&quot;),
+ *         @OA\Property(
+ *           description=&quot;file to upload&quot;,
+ *           property=&quot;avatar&quot;,
+ *           type=&quot;string&quot;,
+ *           format=&quot;binary&quot;,
+ *         ),
+ *       )
+ *     )
+ *   ),
+ *   @OA\Response(response=200, description=&quot;Success&quot;)
+ * )
+ */</span>
+</code></pre></div><h2 id="default-security-scheme-for-all-endpoints" tabindex="-1">Default security scheme for all endpoints <a class="header-anchor" href="#default-security-scheme-for-all-endpoints" aria-hidden="true">#</a></h2><p>Unless specified each endpoint needs to declare what security schemes it supports. However, there is a way to also configure security schemes globally for the whole API.</p><p>This is done on the <code>@OA\OpenApi</code> annotation:</p><div><div class="tabs-component"><ul role="tablist" class="tabs-component-tabs"><!--[--><!--]--></ul><div class="tabs-component-panels"><!--[--><section id="minimal-at-pane" data-tab-id="minimal-at" aria-hidden="true" class="tabs-component-panel" role="tabpanel" tabindex="-1" style="display:none;"><!--[--><!--[--><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OAT</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>OpenApi</span><span class="token punctuation">(</span>
+    <span class="token attribute-class-name class-name">security</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;bearerAuth&#39;</span> <span class="token operator">=&gt;</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">]</span><span class="token punctuation">]</span>
+<span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Components</span><span class="token punctuation">(</span>
+    <span class="token attribute-class-name class-name">securitySchemes</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
+        <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>SecurityScheme</span><span class="token punctuation">(</span>
+            <span class="token attribute-class-name class-name">securityScheme</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;bearerAuth&#39;</span><span class="token punctuation">,</span>
+            <span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;http&#39;</span><span class="token punctuation">,</span>
+            <span class="token attribute-class-name class-name">scheme</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;bearer&#39;</span>
+        <span class="token punctuation">)</span>
+    <span class="token punctuation">]</span>
+<span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><!--]--><!--]--></section><section id="minimal-an-pane" data-tab-id="minimal-an" aria-hidden="true" class="tabs-component-panel" role="tabpanel" tabindex="-1" style="display:none;"><!--[--><!--[--><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Annotations</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @OA\OpenApi(
+ *   security={{&quot;bearerAuth&quot;: {}}}
+ * )
+ *
+ * @OA\SecurityScheme(
+ *   securityScheme=&quot;bearerAuth&quot;,
+ *   type=&quot;http&quot;,
+ *   scheme=&quot;bearer&quot;
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><!--]--><!--]--></section><!--]--></div></div></div><h2 id="nested-objects" tabindex="-1">Nested objects <a class="header-anchor" href="#nested-objects" aria-hidden="true">#</a></h2><p>Complex, nested data structures are defined by nesting <code>@OA\Property</code> annotations inside others (with <code>type=&quot;object&quot;</code>).</p><div class="language-php"><pre><code><span class="token comment">/**
+ *  @OA\Schema(
+ *    schema=&quot;Profile&quot;,
+ *    type=&quot;object&quot;,
+*
+ *    @OA\Property(
+ *      property=&quot;Status&quot;,
+ *      type=&quot;string&quot;,
+ *      example=&quot;0&quot;
+ *    ),
+ *
+ *    @OA\Property(
+ *      property=&quot;Group&quot;,
+ *      type=&quot;object&quot;,
+ *
+ *      @OA\Property(
+ *        property=&quot;ID&quot;,
+ *        description=&quot;ID de grupo&quot;,
+ *        type=&quot;number&quot;,
+ *        example=-1
+ *      ),
+ *
+ *      @OA\Property(
+ *        property=&quot;Name&quot;,
+ *        description=&quot;Nombre de grupo&quot;,
+ *        type=&quot;string&quot;,
+ *        example=&quot;Superadmin&quot;
+ *      )
+ *    )
+ *  )
+ */</span>
+
+</code></pre></div><h2 id="documenting-union-type-response-data-using-oneof" tabindex="-1">Documenting union type response data using <code>oneOf</code> <a class="header-anchor" href="#documenting-union-type-response-data-using-oneof" aria-hidden="true">#</a></h2><p>A response with either a single or a list of <code>QualificationHolder</code>&#39;s.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Response(
+ *     response=200,
+ *     @OA\JsonContent(
+ *         oneOf={
+ *             @OA\Schema(ref=&quot;#/components/schemas/QualificationHolder&quot;),
+ *             @OA\Schema(
+ *                 type=&quot;array&quot;,
+ *                 @OA\Items(ref=&quot;#/components/schemas/QualificationHolder&quot;)
+ *             )
+ *         }
+ *     )
+ * )
+ */</span>
+</code></pre></div><h2 id="reusing-responses" tabindex="-1">Reusing responses <a class="header-anchor" href="#reusing-responses" aria-hidden="true">#</a></h2><p>Global responses are found under <code>/components/responses</code> and can be referenced/shared just like schema definitions (models)</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Response(
+ *   response=&quot;product&quot;,
+ *   description=&quot;All information about a product&quot;,
+ *   @OA\JsonContent(ref=&quot;#/components/schemas/Product&quot;)
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">ProductResponse</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
+
+ <span class="token comment">// ...</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">ProductController</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * @OA\Get(
+     *   tags={&quot;Products&quot;},
+     *   path=&quot;/products/{product_id}&quot;,
+     *   @OA\Response(
+     *       response=&quot;default&quot;,
+     *       ref=&quot;#/components/responses/product&quot;
+     *   )
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getProduct</span><span class="token punctuation">(</span><span class="token variable">$id</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">`response` parameter is always required</p><p>Even if referencing a shared response definition, the <code>response</code> parameter is still required.</p></div><h2 id="mediatype" tabindex="-1">mediaType=&quot;<em>/</em>&quot; <a class="header-anchor" href="#mediatype" aria-hidden="true">#</a></h2><p>Using <code>*/*</code> as <code>mediaType</code> is not possible using annotations.</p><p><strong>Example:</strong></p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\MediaType(
+ *     mediaType=&quot;*/</span><span class="token operator">*</span><span class="token string double-quoted-string">&quot;,
+ *     @OA\Schema(type=&quot;</span><span class="token keyword type-declaration">string</span><span class="token string double-quoted-string">&quot;,format=&quot;</span>binary&quot;<span class="token punctuation">)</span>
+ <span class="token operator">*</span> <span class="token punctuation">)</span>
+ <span class="token operator">*</span><span class="token operator">/</span>
+</code></pre></div><p>The doctrine annotations library used for parsing annotations does not handle this and will interpret the <code>*/</code> bit as the end of the comment.</p><p>Using just <code>*</code> or <code>application/octet-stream</code> might be usable workarounds.</p><h2 id="warning-about-multiple-response-with-same-response-200" tabindex="-1">Warning about <code>Multiple response with same response=&quot;200&quot;</code> <a class="header-anchor" href="#warning-about-multiple-response-with-same-response-200" aria-hidden="true">#</a></h2><p>There are two scenarios where this can happen</p><ol><li>A single endpoint contains two responses with the same <code>response</code> value.</li><li>There are multiple global response declared, again more than one with the same <code>response</code> value.</li></ol><h2 id="callbacks" tabindex="-1">Callbacks <a class="header-anchor" href="#callbacks" aria-hidden="true">#</a></h2><p>The API does include basic support for callbacks. However, this needs to be set up mostly manually.</p><p><strong>Example</strong></p><div class="language-php"><pre><code><span class="token comment">/**
+ *     ...
+ *
+ *     callbacks={
+ *         &quot;onChange&quot;={
+ *              &quot;{$request.query.callbackUrl}&quot;={
+ *                  &quot;post&quot;: {
+ *                      &quot;requestBody&quot;: @OA\RequestBody(
+ *                          description=&quot;subscription payload&quot;,
+ *                          @OA\MediaType(mediaType=&quot;application/json&quot;, @OA\Schema(
+ *                              @OA\Property(property=&quot;timestamp&quot;, type=&quot;string&quot;, format=&quot;date-time&quot;, description=&quot;time of change&quot;)
+ *                          ))
+ *                      )
+ *                  },
+ *                  &quot;responses&quot;: {
+ *                      &quot;202&quot;: {
+ *                          &quot;description&quot;: &quot;Your server implementation should return this HTTP status code if the data was received successfully&quot;
+ *                      }
+ *                  }
+ *              }
+ *         }
+ *     }
+ *
+ *     ...
+ *
+ */</span>
+</code></pre></div><h2 id="mostly-virtual-models" tabindex="-1">(Mostly) virtual models <a class="header-anchor" href="#mostly-virtual-models" aria-hidden="true">#</a></h2><p>Typically, a model is annotated by adding a <code>@OA\Schema</code> annotation to the class and then individual <code>@OA\Property</code> annotations to the individually declared class properties.</p><p>It is possible, however, to nest <code>O@\Property</code> annotations inside a schema even without properties. In fact, all that is needed is a code anchor - e.g. an empty class.</p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span>
+    <span class="token attribute-class-name class-name">properties</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
+        <span class="token string single-quoted-string">&#39;name&#39;</span> <span class="token operator">=&gt;</span> <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">property</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;name&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;string&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+        <span class="token string single-quoted-string">&#39;email&#39;</span> <span class="token operator">=&gt;</span> <span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">property</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;email&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;string&#39;</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
+    <span class="token punctuation">]</span>
+<span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">User</span> <span class="token punctuation">{</span><span class="token punctuation">}</span>
+</code></pre></div><h2 id="using-class-name-as-type-instead-of-references" tabindex="-1">Using class name as type instead of references <a class="header-anchor" href="#using-class-name-as-type-instead-of-references" aria-hidden="true">#</a></h2><p>Typically, when referencing schemas this is done using <code>$ref</code>&#39;s</p><div class="language-php"><pre><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">schema</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;user&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">User</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Book</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * @var User
+     */</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">ref</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;#/components/schemas/user&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token variable">$author</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>This works, but is not very convenient.</p><p>First, when using custom schema names (<code>schema: &#39;user&#39;</code>), this needs to be taken into account everywhere. Secondly, having to write <code>ref: &#39;#/components/schemas/user&#39;</code> is tedious and error-prone.</p><p>Using attributes all this changes as we can take advantage of PHP itself by referring to a schema by its (fully qualified) class name.</p><p>With the same <code>User</code> schema as before, the <code>Book::author</code> property could be written in a few different ways</p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> User author<span class="token punctuation">;</span>
+</code></pre></div><p><strong>or</strong></p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * @var User
+     */</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> author<span class="token punctuation">;</span>
+</code></pre></div><p><strong>or</strong></p><div class="language-php"><pre><code>    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">type</span><span class="token punctuation">:</span> <span class="token attribute-class-name class-name">User</span><span class="token operator">::</span><span class="token constant">class</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> author<span class="token punctuation">;</span>
+</code></pre></div><h2 id="enums" tabindex="-1">Enums <a class="header-anchor" href="#enums" aria-hidden="true">#</a></h2><p>As of PHP 8.1 there is native support for <code>enum</code>&#39;s.</p><p><code>swagger-php</code> supports enums in much the same way as class names can be used to reference schemas.</p><p><strong>Example</strong></p><div class="language-php"><pre><code><span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">enum</span> <span class="token class-name-definition class-name">State</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">case</span> <span class="token constant">OPEN</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">MERGED</span><span class="token punctuation">;</span>
+    <span class="token keyword">case</span> <span class="token constant">DECLINED</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">PullRequest</span>
+   <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OAT<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+   <span class="token keyword">public</span> <span class="token class-name type-declaration">State</span> <span class="token variable">$state</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>However, in this case the schema generated for <code>State</code> will be an enum:</p><div class="language-yaml"><pre><code><span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">PullRequest</span><span class="token punctuation">:</span>
+      <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+        <span class="token key atrule">state</span><span class="token punctuation">:</span>
+          <span class="token key atrule">$ref</span><span class="token punctuation">:</span> <span class="token string">&#39;#/components/schemas/State&#39;</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> object
+    <span class="token key atrule">State</span><span class="token punctuation">:</span>
+      <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+      <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span> OPEN
+        <span class="token punctuation">-</span> MERGED
+        <span class="token punctuation">-</span> DECLINED
+</code></pre></div><h2 id="multi-value-query-parameter-q-1-q-1" tabindex="-1">Multi value query parameter: <code>&amp;q[]=1&amp;q[]=1</code> <a class="header-anchor" href="#multi-value-query-parameter-q-1-q-1" aria-hidden="true">#</a></h2><p>PHP allows to have query parameters multiple times in the url and will combine the values to an array if the parameter name uses trailing <code>[]</code>. In fact, it is possible to create nested arrays too by using more than one pair of <code>[]</code>.</p><p>In terms of OpenAPI, the parameters can be considered a single parameter with a list of values.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Get(
+ *     path=&quot;/api/endpoint&quot;,
+ *     description=&quot;The endpoint&quot;,
+ *     operationId=&quot;endpoint&quot;,
+ *     tags={&quot;endpoints&quot;},
+ *     @OA\Parameter(
+ *         name=&quot;things[]&quot;,
+ *         in=&quot;query&quot;,
+ *         description=&quot;A list of things.&quot;,
+ *         required=false,
+ *         @OA\Schema(
+ *             type=&quot;array&quot;,
+ *             @OA\Items(type=&quot;integer&quot;)
+ *         )
+ *     ),
+ *     @OA\Response(response=&quot;200&quot;, description=&quot;All good&quot;)
+ * )
+ */</span>
+</code></pre></div><p>The corresponding bit of the spec will look like this:</p><div class="language-yaml"><pre><code>      <span class="token key atrule">parameters</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span>
+          <span class="token key atrule">name</span><span class="token punctuation">:</span> <span class="token string">&#39;things[]&#39;</span>
+          <span class="token key atrule">in</span><span class="token punctuation">:</span> query
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;A list of things.&#39;</span>
+          <span class="token key atrule">required</span><span class="token punctuation">:</span> <span class="token boolean important">false</span>
+          <span class="token key atrule">schema</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> array
+            <span class="token key atrule">items</span><span class="token punctuation">:</span>
+              <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+</code></pre></div><p><code>swagger-ui</code> will show a form that allows to add/remove items (<code>integer</code> values in this case) to/from a list and post those values as something like <code>?things[]=1&amp;things[]=2&amp;things[]=0</code></p><h2 id="custom-response-classes" tabindex="-1">Custom response classes <a class="header-anchor" href="#custom-response-classes" aria-hidden="true">#</a></h2><p>Even with using refs there is a bit of overhead in sharing responses. One way around that is to write your own response classes. The beauty is that in your custom <code>__construct()</code> method you can prefill as much as you need.</p><p>Best of all, this works for both annotations and attributes.</p><p>Example:</p><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @Annotation
+ */</span>
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content">\<span class="token attribute-class-name class-name">Attribute</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name class-name-fully-qualified"><span class="token punctuation">\</span>Attribute</span><span class="token operator">::</span><span class="token constant">TARGET_CLASS</span> <span class="token operator">|</span> <span class="token attribute-class-name class-name class-name-fully-qualified"><span class="token punctuation">\</span>Attribute</span><span class="token operator">::</span><span class="token constant">TARGET_METHOD</span> <span class="token operator">|</span> <span class="token attribute-class-name class-name class-name-fully-qualified"><span class="token punctuation">\</span>Attribute</span><span class="token operator">::</span><span class="token constant">IS_REPEATABLE</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">BadRequest</span> <span class="token keyword">extends</span> <span class="token class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Response</span>
+<span class="token punctuation">{</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">__construct</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+        <span class="token keyword static-context">parent</span><span class="token operator">::</span><span class="token function">__construct</span><span class="token punctuation">(</span><span class="token argument-name">response</span><span class="token punctuation">:</span> <span class="token number">400</span><span class="token punctuation">,</span> <span class="token argument-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;Bad request&#39;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Controller</span>
+<span class="token punctuation">{</span>
+
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/foo&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">responses</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name">BadRequest</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">]</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Post</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/foo&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name">BadRequest</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">post</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+
+    <span class="token comment">/**
+     * @OA\Delete(
+     *     path=&quot;/foo&quot;,
+     *     @BadRequest()
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">delete</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">Annotations only?</p><p>If you are only interested in annotations you canleave out the attribute setup line (<code>#[\Attribute...</code>) for <code>BadRequest</code>.</p><p>Furthermore, your custom annotations should extend from the <code>OpenApi\Annotations</code> namespace.</p></div><h2 id="annotating-class-constants" tabindex="-1">Annotating class constants <a class="header-anchor" href="#annotating-class-constants" aria-hidden="true">#</a></h2><div class="language-php"><pre><code><span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Schema</span><span class="token punctuation">(</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">Airport</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Property</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">property</span><span class="token operator">=</span><span class="token string single-quoted-string">&#39;kind&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">const</span> <span class="token constant">KIND</span> <span class="token operator">=</span> <span class="token string single-quoted-string">&#39;Airport&#39;</span><span class="token punctuation">;</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>The <code>const</code> property is supported in OpenApi 3.1.0.</p><div class="language-yaml"><pre><code><span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Airport</span><span class="token punctuation">:</span>
+        <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+          <span class="token key atrule">kind</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+            <span class="token key atrule">const</span><span class="token punctuation">:</span> Airport
+</code></pre></div><p>For 3.0.0 this is serialized into a single value <code>enum</code>.</p><div class="language-yaml"><pre><code><span class="token key atrule">components</span><span class="token punctuation">:</span>
+  <span class="token key atrule">schemas</span><span class="token punctuation">:</span>
+    <span class="token key atrule">Airport</span><span class="token punctuation">:</span>
+        <span class="token key atrule">properties</span><span class="token punctuation">:</span>
+          <span class="token key atrule">kind</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> string
+            <span class="token key atrule">enum</span><span class="token punctuation">:</span>
+              <span class="token punctuation">-</span> Airport
+</code></pre></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/migrating-to-v3" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Migration from 2.x to 3.x</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/faq" data-v-e65a9748><span class="text" data-v-e65a9748>FAQ</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/faq.html b/guide/faq.html
new file mode 100644
index 00000000..38a843c3
--- /dev/null
+++ b/guide/faq.html
@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>FAQ | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_faq.md.b1f45c64.lean.js">
+    
+    <meta name="twitter:title" content="FAQ | Swagger-PHP">
+  <meta property="og:title" content="FAQ | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/faq">FAQ</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#warning-required-oa-info-not-found">Warning: Required @OA\Info() not found</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#annotations-missing">Annotations missing</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#skipping-unknown-someclass">Skipping unknown \SomeClass</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#using-the-b-bootstrap-option">Using the -b --bootstrap option</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#namespace-mismatch">Namespace mismatch</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#no-output-from-openapi-command-line-tool">No output from openapi command line tool</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="faq" tabindex="-1">FAQ <a class="header-anchor" href="#faq" aria-hidden="true">#</a></h1><h2 id="warning-required-oa-info-not-found" tabindex="-1">Warning: Required <code>@OA\Info()</code> not found <a class="header-anchor" href="#warning-required-oa-info-not-found" aria-hidden="true">#</a></h2><p>With adding support for <a href="https://www.php.net/manual/en/language.attributes.php" target="_blank" rel="noopener noreferrer">PHP attributes</a> in version 4, some architectural changes had to be made.</p><p>One of those changes is that placing annotations in your source files is now subject to the same limitations as attributes. These limits are dictated by the PHP reflection API, specifically where it provides access to attributes and doc comments.</p><p>This means stand-alone annotations are no longer supported and ignored as <code>swagger-php</code> cannot <em>&quot;see&quot;</em> them any more.</p><p>Supported locations:</p><ul><li>class</li><li>interface</li><li>trait</li><li>method</li><li>property</li><li>class/interface const</li></ul><p>Most commonly this manifests with a warning about the required <code>@OA\Info</code> not being found. While most annotations have specific related code, the info annotation (and a few more) is kind of global.</p><p>The simplest solution to avoid this issue is to add a &#39;dummy&#39; class to the docblock and add all &#39;global&#39; annotations (e.g. <code>Tag</code>, <code>Server</code>, <code>SecurityScheme</code>, etc.) <strong>in a single docblock</strong> to that class.</p><div class="language-php"><pre><code><span class="token comment">/**
+ * @OA\Tag(
+ *     name=&quot;user&quot;,
+ *     description=&quot;User related operations&quot;
+ * )
+ * @OA\Info(
+ *     version=&quot;1.0&quot;,
+ *     title=&quot;Example API&quot;,
+ *     description=&quot;Example info&quot;,
+ *     @OA\Contact(name=&quot;Swagger API Team&quot;)
+ * )
+ * @OA\Server(
+ *     url=&quot;https://example.localhost&quot;,
+ *     description=&quot;API server&quot;
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>As of version 4.8 the <code>doctrine/annotations</code> library is optional and might cause the same message.</strong></p><p>If this is the case, <code>doctrine annotations</code> must be installed separately:</p><div class="language-shell"><pre><code><span class="token function">composer</span> require doctrine/annotations
+</code></pre></div><h2 id="annotations-missing" tabindex="-1">Annotations missing <a class="header-anchor" href="#annotations-missing" aria-hidden="true">#</a></h2><p>Another side effect of using reflection is that <code>swagger-php</code> <em>&quot;can&#39;t see&quot;</em> multiple consecutive docblocks any more as the PHP reflection API only provides access to the docblock closest to a given structural element.</p><div class="language-php"><pre><code><span class="token keyword">class</span> <span class="token class-name-definition class-name">Controller</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * @OA\Delete(
+     *      path=&quot;/api/v0.0.2/notifications/{id}&quot;,
+     *      operationId=&quot;deleteNotificationById&quot;,
+     *      summary=&quot;Delete notification by ID&quot;,
+     *      @OA\Parameter(name=&quot;id&quot;, in=&quot;path&quot;, @OA\Schema(type=&quot;integer&quot;)),
+     *      @OA\Response(response=200, description=&quot;OK&quot;),
+     *      @OA\Response(response=400, description=&quot;Bad Request&quot;)
+     * )
+     */</span>
+    <span class="token comment">/**
+     * Delete notification by ID.
+     *
+     * @param Request $request
+     * @param AppNotification $notification
+     *
+     * @return Response
+     * @throws Exception
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">destroy</span><span class="token punctuation">(</span><span class="token class-name type-declaration">Request</span> <span class="token variable">$request</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">AppNotification</span> <span class="token variable">$notification</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token comment">//</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>In this case the simplest solution is to merge both docblocks. As an additional benefit the duplication of the summary can be avoided.</p><p>In this improved version <code>swagger-php</code> will automatically use the docblock summary just as explicitly done above.</p><div class="language-php"><pre><code><span class="token keyword">class</span> <span class="token class-name-definition class-name">Controller</span>
+<span class="token punctuation">{</span>
+    <span class="token comment">/**
+     * Delete notification by ID.
+     *
+     * @OA\Delete(
+     *      path=&quot;/api/v0.0.2/notifications/{id}&quot;,
+     *      operationId=&quot;deleteNotificationById&quot;,
+     *      @OA\Parameter(name=&quot;id&quot;, in=&quot;path&quot;, @OA\Schema(type=&quot;integer&quot;)),
+     *      @OA\Response(response=200, description=&quot;OK&quot;),
+     *      @OA\Response(response=400, description=&quot;Bad Request&quot;)
+     * )
+     *
+     * @param Request $request
+     * @param AppNotification $notification
+     *
+     * @return Response
+     * @throws Exception
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">destroy</span><span class="token punctuation">(</span><span class="token class-name type-declaration">Request</span> <span class="token variable">$request</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">AppNotification</span> <span class="token variable">$notification</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token comment">//</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p><strong>Resulting spec:</strong></p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">paths</span><span class="token punctuation">:</span>
+  <span class="token key atrule">&#39;/api/v0.0.2/notifications/{id}&#39;</span><span class="token punctuation">:</span>
+    <span class="token key atrule">delete</span><span class="token punctuation">:</span>
+      <span class="token key atrule">summary</span><span class="token punctuation">:</span> <span class="token string">&#39;XDelete notification by ID.&#39;</span>
+      <span class="token key atrule">operationId</span><span class="token punctuation">:</span> deleteNotificationById
+      <span class="token key atrule">parameters</span><span class="token punctuation">:</span>
+        <span class="token punctuation">-</span>
+          <span class="token key atrule">name</span><span class="token punctuation">:</span> id
+          <span class="token key atrule">in</span><span class="token punctuation">:</span> path
+          <span class="token key atrule">schema</span><span class="token punctuation">:</span>
+            <span class="token key atrule">type</span><span class="token punctuation">:</span> integer
+      <span class="token key atrule">responses</span><span class="token punctuation">:</span>
+        <span class="token key atrule">&#39;200&#39;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> OK
+        <span class="token key atrule">&#39;400&#39;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;Bad Request&#39;</span>
+
+</code></pre></div><h2 id="skipping-unknown-someclass" tabindex="-1">Skipping unknown <code>\SomeClass</code> <a class="header-anchor" href="#skipping-unknown-someclass" aria-hidden="true">#</a></h2><p>This message means that <code>swagger-php</code> has tried to use reflection to inspect <code>\SomeClass</code> and that PHP could not find/load that class. Effectively, this means that <code>class_exists(&quot;\SomeClass&quot;)</code> returns <code>false</code>.</p><h3 id="using-the-b-bootstrap-option" tabindex="-1">Using the <code>-b</code> <code>--bootstrap</code> option <a class="header-anchor" href="#using-the-b-bootstrap-option" aria-hidden="true">#</a></h3><p>There are a number of reasons why this could happen. If you are using the <code>openapi</code> command line tool from a global installation typically the application classloader (composer) is not active. With you application root being <code>myapp</code> you could try:</p><div class="language-shell"><pre><code>openapi <span class="token parameter variable">-b</span> myapp/vendor/autoload.php myapp/src
+</code></pre></div><p>The <code>-b</code> allows to execute some extra PHP code to load whatever is needed to register your apps classloader with PHP.</p><h3 id="namespace-mismatch" tabindex="-1">Namespace mismatch <a class="header-anchor" href="#namespace-mismatch" aria-hidden="true">#</a></h3><p>Another reason for this error could be that your class actually has the wrong namespace (or no namespace at all!).</p><p>Depending on your framework this might still work in the context of your app, but the composer autoloader alone might not be able to load your class (assuming you are using composer).</p><h2 id="no-output-from-openapi-command-line-tool" tabindex="-1">No output from <code>openapi</code> command line tool <a class="header-anchor" href="#no-output-from-openapi-command-line-tool" aria-hidden="true">#</a></h2><p>Depending on your PHP configuration, running the <code>openapi</code> command line tool might result in no output at all.</p><p>The reason for this is that <code>openapi</code> currently uses the <a href="https://www.php.net/manual/en/function.error-log.php" target="_blank" rel="noopener noreferrer"><code>error_log</code></a> function for all output.</p><p>So if this is configured to write to a file, then it will seem like the command is broken.</p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/cookbook" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Cookbook</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/under-the-hood" data-v-e65a9748><span class="text" data-v-e65a9748>Under the hood</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/generating-openapi-documents.html b/guide/generating-openapi-documents.html
new file mode 100644
index 00000000..51f292d8
--- /dev/null
+++ b/guide/generating-openapi-documents.html
@@ -0,0 +1,50 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Generating OpenAPI documents | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_generating-openapi-documents.md.9bb1fdd6.lean.js">
+    
+    <meta name="twitter:title" content="Generating OpenAPI documents | Swagger-PHP">
+  <meta property="og:title" content="Generating OpenAPI documents | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#bin-openapi">./bin/openapi</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#using-php">Using PHP</a><!----></li></ul></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="generating-openapi-documents" tabindex="-1">Generating OpenAPI documents <a class="header-anchor" href="#generating-openapi-documents" aria-hidden="true">#</a></h1><h2 id="bin-openapi" tabindex="-1"><code>./bin/openapi</code> <a class="header-anchor" href="#bin-openapi" aria-hidden="true">#</a></h2><p><code>swagger-php</code> includes a command line tool <code>./bin/openapi</code>. This can be used to generate OpenAPI documents.</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./vendor/bin/openapi app <span class="token parameter variable">-o</span> openapi.yaml
+</code></pre></div><div class="tip custom-block"><p class="custom-block-title">Output Format</p><p>By default the output format is YAML. If a filename is given (via <code>--output</code> or <code>-o</code>) the tool will use the file extension to determine the format.</p><p>The <code>--format</code> option can be used to force a specific format.</p></div><p>For a list of all available options use the <code>-h</code> option</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./bin/openapi <span class="token parameter variable">-h</span>
+
+Usage: openapi <span class="token punctuation">[</span>--option value<span class="token punctuation">]</span> <span class="token punctuation">[</span>/path/to/project <span class="token punctuation">..</span>.<span class="token punctuation">]</span>
+
+Options:
+  <span class="token parameter variable">--config</span> <span class="token punctuation">(</span>-c<span class="token punctuation">)</span>     Generator config
+                    ex: <span class="token parameter variable">-c</span> <span class="token assign-left variable">operationId.hash</span><span class="token operator">=</span>false
+  <span class="token parameter variable">--legacy</span> <span class="token punctuation">(</span>-l<span class="token punctuation">)</span>     Use legacy TokenAnalyser<span class="token punctuation">;</span> default is the new ReflectionAnalyser
+  <span class="token parameter variable">--output</span> <span class="token punctuation">(</span>-o<span class="token punctuation">)</span>     Path to store the generated documentation.
+                    ex: <span class="token parameter variable">--output</span> openapi.yaml
+  <span class="token parameter variable">--exclude</span> <span class="token punctuation">(</span>-e<span class="token punctuation">)</span>    Exclude path<span class="token punctuation">(</span>s<span class="token punctuation">)</span>.
+                    ex: <span class="token parameter variable">--exclude</span> vendor,library/Zend
+  <span class="token parameter variable">--pattern</span> <span class="token punctuation">(</span>-n<span class="token punctuation">)</span>    Pattern of files to scan.
+                    ex: <span class="token parameter variable">--pattern</span> <span class="token string">&quot;*.php&quot;</span> or <span class="token parameter variable">--pattern</span> <span class="token string">&quot;/\.(phps|php)$/&quot;</span>
+  <span class="token parameter variable">--bootstrap</span> <span class="token punctuation">(</span>-b<span class="token punctuation">)</span>  Bootstrap a php <span class="token function">file</span> <span class="token keyword">for</span> defining constants, etc.
+                    ex: <span class="token parameter variable">--bootstrap</span> config/constants.php
+  <span class="token parameter variable">--processor</span> <span class="token punctuation">(</span>-p<span class="token punctuation">)</span>  Register an additional processor.
+  <span class="token parameter variable">--format</span> <span class="token punctuation">(</span>-f<span class="token punctuation">)</span>     Force yaml or json.
+  <span class="token parameter variable">--debug</span> <span class="token punctuation">(</span>-d<span class="token punctuation">)</span>      Show additional error information.
+  <span class="token parameter variable">--version</span>         The OpenAPI version<span class="token punctuation">;</span> defaults to <span class="token number">3.0</span>.0.
+  <span class="token parameter variable">--help</span> <span class="token punctuation">(</span>-h<span class="token punctuation">)</span>       Display this <span class="token builtin class-name">help</span> message.
+</code></pre></div><h2 id="using-php" tabindex="-1">Using PHP <a class="header-anchor" href="#using-php" aria-hidden="true">#</a></h2><p>Depending on your use case PHP code can also be used to generate OpenAPI documents in a more dynamic way.</p><p>In its simplest form this may look something like</p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+<span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Generator</span><span class="token operator">::</span><span class="token function">scan</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path/to/project&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token function">header</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;Content-Type: application/x-yaml&#39;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+<span class="token keyword">echo</span> <span class="token variable">$openapi</span><span class="token operator">-&gt;</span><span class="token function">toYaml</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</span></code></pre></div><div class="tip custom-block"><p class="custom-block-title">Programming API</p><p>Details about the <code>swagger-php</code> API can be found in the <a href="./../reference/">reference</a>.</p></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/installation" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Installation</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/attributes" data-v-e65a9748><span class="text" data-v-e65a9748>Attributes</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/index.html b/guide/index.html
new file mode 100644
index 00000000..50f97e78
--- /dev/null
+++ b/guide/index.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>What is Swagger-PHP? | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_index.md.29bf901a.lean.js">
+    
+    <meta name="twitter:title" content="What is Swagger-PHP? | Swagger-PHP">
+  <meta property="og:title" content="What is Swagger-PHP? | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="what-is-swagger-php" tabindex="-1">What is Swagger-PHP? <a class="header-anchor" href="#what-is-swagger-php" aria-hidden="true">#</a></h1><p><code>swagger-php</code> is a library that extracts API metadata from your PHP source code files.</p><p>The idea is to add <code>swagger-php</code> <a href="./annotations.html">annotations</a> or <a href="./attributes.html">attributes</a> next to the relevant PHP code in your application. These will contain the details about your API and <code>swagger-php</code> will convert those into machine-readable <a href="https://spec.openapis.org/oas/v3.1.0.html" target="_blank" rel="noopener noreferrer">OpenAPI documentation</a>.</p><p>By adding your API documentation next to the corresponding source code (same file!) makes it easy to keep it up-to-date as all details can be modified in one place.</p><div class="tip custom-block"><p class="custom-block-title">Annotating vs. Annotations</p><p>When talking about annotating your code we mean the act of adding meta-data to your codebase. This can be done by either adding <a href="./annotations.html"><code>Annotations</code></a> or <a href="./attributes.html"><code>Attributes</code></a>.</p></div><div class="warning custom-block"><p class="custom-block-title">Requirements</p><p>Using <code>swagger-php</code> requires a minimum of <strong>PHP 7.2</strong> for using annotations and at least <strong>PHP 8.1</strong> to use attributes.</p></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><!----></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/installation" data-v-e65a9748><span class="text" data-v-e65a9748>Installation</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/installation.html b/guide/installation.html
new file mode 100644
index 00000000..c66ef2d6
--- /dev/null
+++ b/guide/installation.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Installation | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_installation.md.34074778.lean.js">
+    
+    <meta name="twitter:title" content="Installation | Swagger-PHP">
+  <meta property="og:title" content="Installation | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/installation">Installation</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#per-project">Per project</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#globally">Globally</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="installation" tabindex="-1">Installation <a class="header-anchor" href="#installation" aria-hidden="true">#</a></h1><h2 id="per-project" tabindex="-1">Per project <a class="header-anchor" href="#per-project" aria-hidden="true">#</a></h2><p>We recommend adding <code>swagger-php</code> to your project using <a href="https://getcomposer.org" target="_blank" rel="noopener noreferrer">Composer</a></p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> <span class="token function">composer</span> require zircote/swagger-php
+</code></pre></div><h2 id="globally" tabindex="-1">Globally <a class="header-anchor" href="#globally" aria-hidden="true">#</a></h2><p>Alternatively, use the composer <code>global</code> argument to install <code>swagger-php</code> globally.</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> <span class="token function">composer</span> global require zircote/swagger-php
+</code></pre></div><div class="warning custom-block"><p class="custom-block-title">PATH variables</p><p>Remember to add the <code>~/.composer/vendor/bin</code> directory to the PATH in your environment.</p></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>What is Swagger-PHP?</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/generating-openapi-documents" data-v-e65a9748><span class="text" data-v-e65a9748>Generating OpenAPI documents</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/migrating-to-v3.html b/guide/migrating-to-v3.html
new file mode 100644
index 00000000..e39583fa
--- /dev/null
+++ b/guide/migrating-to-v3.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Migrating to v3 | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_migrating-to-v3.md.549bb338.lean.js">
+    
+    <meta name="twitter:title" content="Migrating to v3 | Swagger-PHP">
+  <meta property="og:title" content="Migrating to v3 | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#the-default-output-changed-from-json-to-yaml">The default output changed from json to yaml</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#updated-cli">Updated CLI</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#changed-annotations">Changed annotations</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#swg-is-renamed-to-oa">SWG is renamed to OA</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#swg-swagger-is-renamed-to-oa-openapi">@SWG\Swagger() is renamed to @OA\OpenApi()</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#swg-path-is-renamed-to-oa-pathitem">@SWG\Path() is renamed to @OA\PathItem()</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#swg-definition-is-removed">@SWG\Definition() is removed</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#swg-path-is-removed">@SWG\Path is removed</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#consumes-produces-field-is-removed-from-openapi-specification">Consumes, produces field is removed from OpenAPI specification</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#rename-parameter-references">Rename parameter references</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#rename-response-references">Rename response references</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#renamed-cli">Renamed cli</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#more-details-about-differences">More details about differences:</a><!----></li></ul></li></ul></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="migrating-to-v3" tabindex="-1">Migrating to v3 <a class="header-anchor" href="#migrating-to-v3" aria-hidden="true">#</a></h1><p>Swagger-PHP 3.x generates an openapi.json file that follows the <a href="https://github.com/OAI/OpenAPI-Specification" target="_blank" rel="noopener noreferrer">OpenAPI Version 3.0.x Specification</a>.</p><p>If you need to output the older 2.x specification use OpenApi-php 2.x</p><h2 id="the-default-output-changed-from-json-to-yaml" tabindex="-1">The default output changed from json to yaml <a class="header-anchor" href="#the-default-output-changed-from-json-to-yaml" aria-hidden="true">#</a></h2><p>This aligns better with the direction of the swagger documentation and examples. Annotations can&#39;t be used as string anymore, you&#39;ll need to call <code>toYaml()</code> or <code>toJson()</code> if you prefer the json format.</p><h2 id="updated-cli" tabindex="-1">Updated CLI <a class="header-anchor" href="#updated-cli" aria-hidden="true">#</a></h2><ul><li>Added colors</li><li>No output for successful execution (Removed summary)</li><li>non-zero exit when an error occurred.</li><li>Defaults to yaml</li><li>Defaults to stdout. To save to openapi.yaml use <code>-o</code> or <code>&gt;</code></li></ul><h2 id="changed-annotations" tabindex="-1">Changed annotations <a class="header-anchor" href="#changed-annotations" aria-hidden="true">#</a></h2><h3 id="swg-is-renamed-to-oa" tabindex="-1">SWG is renamed to OA <a class="header-anchor" href="#swg-is-renamed-to-oa" aria-hidden="true">#</a></h3><p>The namespace is renamed from SWG (Swagger) to OA (OpenApi)</p><h3 id="swg-swagger-is-renamed-to-oa-openapi" tabindex="-1">@SWG\Swagger() is renamed to @OA\OpenApi() <a class="header-anchor" href="#swg-swagger-is-renamed-to-oa-openapi" aria-hidden="true">#</a></h3><h3 id="swg-path-is-renamed-to-oa-pathitem" tabindex="-1">@SWG\Path() is renamed to @OA\PathItem() <a class="header-anchor" href="#swg-path-is-renamed-to-oa-pathitem" aria-hidden="true">#</a></h3><p>The specification uses the term &quot;Path Item Object&quot;, updated the annotation to reflect that.</p><h3 id="swg-definition-is-removed" tabindex="-1">@SWG\Definition() is removed <a class="header-anchor" href="#swg-definition-is-removed" aria-hidden="true">#</a></h3><p>Use @OA\Schema() instead of @OA\Definition() and update the references from &quot;#/definitions/something&quot; to &quot;#/components/schemas/something&quot;.</p><h3 id="swg-path-is-removed" tabindex="-1">@SWG\Path is removed <a class="header-anchor" href="#swg-path-is-removed" aria-hidden="true">#</a></h3><p>Use @OA\PathItem instead of @SWG\Path and update references.</p><h3 id="consumes-produces-field-is-removed-from-openapi-specification" tabindex="-1">Consumes, produces field is removed from OpenAPI specification <a class="header-anchor" href="#consumes-produces-field-is-removed-from-openapi-specification" aria-hidden="true">#</a></h3><p>Use @OA\MediaType to set data format.</p><h3 id="rename-parameter-references" tabindex="-1">Rename parameter references <a class="header-anchor" href="#rename-parameter-references" aria-hidden="true">#</a></h3><p>Rename <code>#/parameters/{parameter_name}</code> to <code>#/components/parameters/{parameter_name}</code></p><h3 id="rename-response-references" tabindex="-1">Rename response references <a class="header-anchor" href="#rename-response-references" aria-hidden="true">#</a></h3><p>Rename <code>#/responses/{response}</code> to <code>#/components/responses/{response}</code></p><h3 id="renamed-cli" tabindex="-1">Renamed cli <a class="header-anchor" href="#renamed-cli" aria-hidden="true">#</a></h3><p>Renamed swagger to openapi</p><h3 id="more-details-about-differences" tabindex="-1">More details about differences: <a class="header-anchor" href="#more-details-about-differences" aria-hidden="true">#</a></h3><p><a href="https://blog.readme.io/an-example-filled-guide-to-swagger-3-2/" target="_blank" rel="noopener noreferrer">A Visual Guide to What&#39;s New in Swagger 3.0</a></p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/migrating-to-v4" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Migration from 3.x to 4.x</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/cookbook" data-v-e65a9748><span class="text" data-v-e65a9748>Cookbook</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/migrating-to-v4.html b/guide/migrating-to-v4.html
new file mode 100644
index 00000000..d50a0e89
--- /dev/null
+++ b/guide/migrating-to-v4.html
@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Migrating to v4 | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_migrating-to-v4.md.714a0f1b.lean.js">
+    
+    <meta name="twitter:title" content="Migrating to v4 | Swagger-PHP">
+  <meta property="og:title" content="Migrating to v4 | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#overview">Overview</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#annotations-as-php-attributes">Annotations as PHP attributes</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#using-annotations">Using annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#using-attributes">Using attributes</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#optional-nesting">Optional nesting</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#annotations-must-be-associated-with-a-structural-element">Annotations must be associated with a structural element</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#the-pathparameter-annotation">The PathParameter annotation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#the-attachable-annotation">The Attachable annotation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#removed-deprecated-elements">Removed deprecated elements</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#openapi-analysis-processors">\Openapi\Analysis::processors()</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#openapi-analyser-whitelist">\Openapi\Analyser::$whitelist</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#openapi-analyser-defaultimports">\Openapi\Analyser::$defaultImports</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#openapi-logger">\Openapi\Logger</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#improvements-to-the-generator-class">Improvements to the Generator class</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="migrating-to-v4" tabindex="-1">Migrating to v4 <a class="header-anchor" href="#migrating-to-v4" aria-hidden="true">#</a></h1><h2 id="overview" tabindex="-1">Overview <a class="header-anchor" href="#overview" aria-hidden="true">#</a></h2><ul><li>As of PHP 8.1 annotations may be used as <a href="https://www.php.net/manual/en/language.attributes.overview.php" target="_blank" rel="noopener noreferrer">PHP attributes</a> instead. That means all references to annotations in this document also apply to attributes.</li><li>If you haven&#39;t switched to attributes yet, the Doctrine annotations library must be installed manually: <code>composer require doctrine/annotations</code></li><li>Annotations now <strong>must be</strong> associated with a structural element (class, trait, interface), a method, property or const.</li><li>A new annotation <code>PathParameter</code> was added for improved framework support.</li><li>A new annotation <code>Attachable</code> was added to simplify custom processing. <code>Attachable</code> can be used to attach arbitrary data to any given annotation.</li><li>Deprecated elements have been removed <ul><li><code>\Openapi\Analysis::processors()</code></li><li><code>\Openapi\Analyser::$whitelist</code></li><li><code>\Openapi\Analyser::$defaultImports</code></li><li><code>\Openapi\Logger</code></li></ul></li><li>Legacy support is available via the previous <code>TokenAnalyser</code></li><li>Improvements to the <code>Generator</code> class</li></ul><h2 id="annotations-as-php-attributes" tabindex="-1">Annotations as PHP attributes <a class="header-anchor" href="#annotations-as-php-attributes" aria-hidden="true">#</a></h2><p>While PHP attributes have been around since PHP 8.0 they were lacking the ability to be nested. This changes with PHP 8.1 which allows to use <code>new</code> in initializers.</p><p>Swagger-php attributes also make use of named arguments, so attribute parameters can be (mostly) typed. There are some limitations to type hints which can only be resolved once support for PHP 7.x is dropped.</p><h3 id="using-annotations" tabindex="-1">Using annotations <a class="header-anchor" href="#using-annotations" aria-hidden="true">#</a></h3><div class="language-php"><pre><code>
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Annotations</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @OA\Info(
+ *   version=&quot;1.0.0&quot;,
+ *   title=&quot;My API&quot;,
+ *   @OA\License(name=&quot;MIT&quot;),
+ *   @OA\Attachable()
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</code></pre></div><h3 id="using-attributes" tabindex="-1">Using attributes <a class="header-anchor" href="#using-attributes" aria-hidden="true">#</a></h3><div class="language-php"><pre><code>
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Info</span><span class="token punctuation">(</span>
+    <span class="token attribute-class-name class-name">version</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;1.0.0&#39;</span><span class="token punctuation">,</span>
+    <span class="token attribute-class-name class-name">title</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;My API&#39;</span><span class="token punctuation">,</span>
+    <span class="token attribute-class-name class-name">attachables</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token attribute-class-name class-name">new</span> <span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Attachable</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">]</span>
+<span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>License</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">name</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;MIT&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApiSpec</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+</code></pre></div><h2 id="optional-nesting" tabindex="-1">Optional nesting <a class="header-anchor" href="#optional-nesting" aria-hidden="true">#</a></h2><p>One of the few differences between annotations and attributes visible in the above example is that the <code>OA\License</code> attribute is not nested within <code>OA\Info</code>. Nesting of attributes is possible and required in certain cases however, <strong>in cases where there is no ambiguity attributes may be all written on the top level</strong> and swagger-php will do the rest.</p><h2 id="annotations-must-be-associated-with-a-structural-element" tabindex="-1">Annotations must be associated with a structural element <a class="header-anchor" href="#annotations-must-be-associated-with-a-structural-element" aria-hidden="true">#</a></h2><p>The (now legacy) way of parsing PHP files meant that docblocks could live in a file without a single line of actual PHP code.</p><p>PHP Attributes cannot exist in isolation; they need code to be associated with and then are available via reflection on the associated structural element. In order to allow to keep supporting annotations and the code simple it made sense to treat annotations and attributes the same in this respect.</p><h2 id="the-pathparameter-annotation" tabindex="-1">The <code>PathParameter</code> annotation <a class="header-anchor" href="#the-pathparameter-annotation" aria-hidden="true">#</a></h2><p>As annotation this is just a short form for</p><div class="language-php"><pre><code>   @<span class="token constant">OA</span><span class="token function"><span class="token punctuation">\</span>Parameter</span><span class="token punctuation">(</span>in<span class="token operator">=</span><span class="token string single-quoted-string">&#39;body&#39;</span><span class="token punctuation">)</span>
+</code></pre></div><p>Things get more interesting when it comes to using it as attribute, though. In the context of a controller you can now do something like</p><div class="language-php"><pre><code><span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span>
+<span class="token punctuation">{</span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/products/{product_id}&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getProduct</span><span class="token punctuation">(</span>
+        <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>PathParameter</span></span><span class="token delimiter punctuation">]</span></span> <span class="token keyword type-declaration">string</span> <span class="token variable">$product_id</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</code></pre></div><p>Here it avoids having to duplicate details about the <code>$product_id</code> parameter and the simple use of the attribute will pick up typehints automatically.</p><h2 id="the-attachable-annotation" tabindex="-1">The <code>Attachable</code> annotation <a class="header-anchor" href="#the-attachable-annotation" aria-hidden="true">#</a></h2><p>Technically these were added in version 3.3.0, however they become really useful only with version 4.</p><p>The attachable annotation is similar to the OpenApi vendor extension <code>x=</code>. The main difference are that</p><ol><li>Attachables allow complex structures and strong typing</li><li><strong>Attachables are not added to the generated spec.</strong></li></ol><p>Their main purpose is to make customizing swagger-php easier by allowing to add arbitrary data to any annotation.</p><p>One possible use case could be custom annotations. Classes extending <code>Attachable</code> are allowed to limit the allowed parent annotations. This means it would be easy to create a new attribute to flag certain endpoints as private and exclude them under certain conditions from the spec (via a custom processor).</p><h2 id="removed-deprecated-elements" tabindex="-1">Removed deprecated elements <a class="header-anchor" href="#removed-deprecated-elements" aria-hidden="true">#</a></h2><h3 id="openapi-analysis-processors" tabindex="-1"><code>\Openapi\Analysis::processors()</code> <a class="header-anchor" href="#openapi-analysis-processors" aria-hidden="true">#</a></h3><p>Processors have been moved into the <code>Generator</code> class incl. some new convenience methods.</p><h3 id="openapi-analyser-whitelist" tabindex="-1"><code>\Openapi\Analyser::$whitelist</code> <a class="header-anchor" href="#openapi-analyser-whitelist" aria-hidden="true">#</a></h3><p>This has been replaced with the <code>Generator</code> <code>namespaces</code> property.</p><h3 id="openapi-analyser-defaultimports" tabindex="-1"><code>\Openapi\Analyser::$defaultImports</code> <a class="header-anchor" href="#openapi-analyser-defaultimports" aria-hidden="true">#</a></h3><p>This has been replaced with the <code>Generator</code> <code>aliases</code> property.</p><h3 id="openapi-logger" tabindex="-1"><code>\Openapi\Logger</code> <a class="header-anchor" href="#openapi-logger" aria-hidden="true">#</a></h3><p>This class has been removed completely. Instead, you may configure a <a href="https://www.php-fig.org/psr/psr-3/" target="_blank" rel="noopener noreferrer">PSR-3 logger</a>.</p><h2 id="improvements-to-the-generator-class" tabindex="-1">Improvements to the <code>Generator</code> class <a class="header-anchor" href="#improvements-to-the-generator-class" aria-hidden="true">#</a></h2><p>The removal of deprecated static config options means that the <code>Generator</code> class now is the main entry point into swagger-php when used programmatically.</p><p>To make the migration as simple as possible a new <code>Generator::withContext(callable)</code> has been added. This allows to use parts of the library (an <code>Analyser</code> instance, for example) within the context of a <code>Generator</code> instance.</p><p>Example:</p><div class="language-php"><pre><code><span class="token variable">$analyser</span> <span class="token operator">=</span> <span class="token function">createMyAnalyser</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$analysis</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">Generator</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">addAlias</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;fo&#39;</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">&#39;My\\Attribute\\Namespace&#39;</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">addNamespace</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;Other\\Annotations\\&#39;</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">withContext</span><span class="token punctuation">(</span><span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token class-name type-declaration">Generator</span> <span class="token variable">$generator</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">Analysis</span> <span class="token variable">$analysis</span><span class="token punctuation">,</span> <span class="token class-name type-declaration">Context</span> <span class="token variable">$context</span><span class="token punctuation">)</span> <span class="token keyword">use</span> <span class="token punctuation">(</span><span class="token variable">$analyser</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
+        <span class="token variable">$analyser</span><span class="token operator">-&gt;</span><span class="token function">setGenerator</span><span class="token punctuation">(</span><span class="token variable">$generator</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+        <span class="token variable">$analysis</span> <span class="token operator">=</span> <span class="token variable">$analyser</span><span class="token operator">-&gt;</span><span class="token function">fromFile</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;my_code.php&#39;</span><span class="token punctuation">,</span> <span class="token variable">$context</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+        <span class="token variable">$analysis</span><span class="token operator">-&gt;</span><span class="token function">process</span><span class="token punctuation">(</span><span class="token variable">$generator</span><span class="token operator">-&gt;</span><span class="token function">getProcessors</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+        <span class="token keyword">return</span> <span class="token variable">$analysis</span><span class="token punctuation">;</span>
+    <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/common-techniques" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Common techniques</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/migrating-to-v3" data-v-e65a9748><span class="text" data-v-e65a9748>Migration from 2.x to 3.x</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/required-elements.html b/guide/required-elements.html
new file mode 100644
index 00000000..dbf57d9a
--- /dev/null
+++ b/guide/required-elements.html
@@ -0,0 +1,82 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Required elements | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_required-elements.md.ef909293.lean.js">
+    
+    <meta name="twitter:title" content="Required elements | Swagger-PHP">
+  <meta property="og:title" content="Required elements | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/required-elements">Required elements</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#minimum-required-annotations">Minimum required annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#optional-elements">Optional elements</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/under-the-hood">Under the hood</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="required-elements" tabindex="-1">Required elements <a class="header-anchor" href="#required-elements" aria-hidden="true">#</a></h1><p>The OpenAPI specification defines a minimum set of information for a valid document.</p><p>For the most part that consists of some general information about the API like <code>name</code>, <code>version</code> and at least one endpoint.</p><p>The endpoint, in turn, needs to have a path and at least one response.</p><h2 id="minimum-required-annotations" tabindex="-1">Minimum required annotations <a class="header-anchor" href="#minimum-required-annotations" aria-hidden="true">#</a></h2><p>With the above in mind a minimal API with a single endpoint could look like this:</p><div><div class="tabs-component"><ul role="tablist" class="tabs-component-tabs"><!--[--><!--]--></ul><div class="tabs-component-panels"><!--[--><section id="minimal-at-pane" data-tab-id="minimal-at" aria-hidden="true" class="tabs-component-panel" role="tabpanel" tabindex="-1" style="display:none;"><!--[--><!--[--><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Info</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">title</span><span class="token punctuation">:</span> <span class="token string double-quoted-string">&quot;My First API&quot;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">version</span><span class="token punctuation">:</span> <span class="token string double-quoted-string">&quot;0.1&quot;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApi</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span>
+<span class="token punctuation">{</span>
+
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/api/data.json&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;200&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;The data&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getResource</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+        <span class="token comment">// ...</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><!--]--><!--]--></section><section id="minimal-an-pane" data-tab-id="minimal-an" aria-hidden="true" class="tabs-component-panel" role="tabpanel" tabindex="-1" style="display:none;"><!--[--><!--[--><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Annotations</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @OA\Info(
+ *     title=&quot;My First API&quot;,
+ *     version=&quot;0.1&quot;
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApi</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span>
+<span class="token punctuation">{</span>
+
+    <span class="token comment">/**
+     * @OA\Get(
+     *     path=&quot;/api/data.json&quot;,
+     *     @OA\Response(
+     *         response=&quot;200&quot;,
+     *         description=&quot;The data&quot;
+     *     )
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getResource</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+        <span class="token comment">// ...</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><!--]--><!--]--></section><!--]--></div></div></div><p>with the resulting OpenAPI document like this</p><div class="language-yaml"><pre><code><span class="token key atrule">openapi</span><span class="token punctuation">:</span> 3.0.0
+<span class="token key atrule">info</span><span class="token punctuation">:</span>
+  <span class="token key atrule">title</span><span class="token punctuation">:</span> <span class="token string">&#39;My First API&#39;</span>
+  <span class="token key atrule">version</span><span class="token punctuation">:</span> <span class="token string">&#39;0.1&#39;</span>
+<span class="token key atrule">paths</span><span class="token punctuation">:</span>
+  <span class="token key atrule">/api/data.json</span><span class="token punctuation">:</span>
+    <span class="token key atrule">get</span><span class="token punctuation">:</span>
+      <span class="token key atrule">operationId</span><span class="token punctuation">:</span> 236f26ae21b015a60adbce41f8f316e3
+      <span class="token key atrule">responses</span><span class="token punctuation">:</span>
+        <span class="token key atrule">&#39;200&#39;</span><span class="token punctuation">:</span>
+          <span class="token key atrule">description</span><span class="token punctuation">:</span> <span class="token string">&#39;The data&#39;</span>
+</code></pre></div><div class="warning custom-block"><p class="custom-block-title">Code locations</p><p>Attributes and annotations can be added anywhere on declarations in code as defined by the PHP docs. These are limited to the extent of what the PHP Reflection APIs supports.</p></div><h2 id="optional-elements" tabindex="-1">Optional elements <a class="header-anchor" href="#optional-elements" aria-hidden="true">#</a></h2><p>Looking at the generated document you will notice that there are some elements that <code>swagger-php</code> adds automatically when they are missing.</p><p>For the most part those are <code>@OA\OpenApi</code>, <code>@OA\Components</code> and <code>@OA\PathItem</code>.</p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/annotations" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Annotations</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/guide/common-techniques" data-v-e65a9748><span class="text" data-v-e65a9748>Common techniques</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/guide/under-the-hood.html b/guide/under-the-hood.html
new file mode 100644
index 00000000..c0ecf58f
--- /dev/null
+++ b/guide/under-the-hood.html
@@ -0,0 +1,23 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Under the hood | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/guide_under-the-hood.md.58a1fa15.lean.js">
+    
+    <meta name="twitter:title" content="Under the hood | Swagger-PHP">
+  <meta property="og:title" content="Under the hood | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Introduction</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/">What is Swagger-PHP?</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/generating-openapi-documents">Generating OpenAPI documents</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Annotating your code</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/annotations">Annotations</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/required-elements">Required elements</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/common-techniques">Common techniques</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Upgrading</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v4">Migration from 3.x to 4.x</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/migrating-to-v3">Migration from 2.x to 3.x</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Other</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/cookbook">Cookbook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/guide/faq">FAQ</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/guide/under-the-hood">Under the hood</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#processing-flow">Processing flow</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#context">Context</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#analysis">Analysis</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#documentation">Documentation</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#installation">Installation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#workflow">Workflow</a><!----></li></ul></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/related-projects">Related Projects</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="under-the-hood" tabindex="-1">Under the hood <a class="header-anchor" href="#under-the-hood" aria-hidden="true">#</a></h1><h2 id="processing-flow" tabindex="-1">Processing flow <a class="header-anchor" href="#processing-flow" aria-hidden="true">#</a></h2><ul><li>The <code>Generator</code> iterates over the given sources (Symfony <code>Finder</code>, file/directory list, etc)</li><li>The configured analyser (<code>AnalyserInterface</code>) reads the files and builds an <code>Analysis</code> object. Default (as of v4) is the <code>ReflectionAnalyser</code>. Alternatively, there is the <code>TokenAnalyser</code> which was the default in v3.</li><li>The <code>Analysis</code> object and its annotations are then processed by the configured processors.</li><li>If enabled, the analysis/annotations are validated.</li><li>The root <code>OpenApi</code> annotation then contains all annotations and is serialized into YAML/JSON.</li></ul><h2 id="context" tabindex="-1"><code>Context</code> <a class="header-anchor" href="#context" aria-hidden="true">#</a></h2><p>Each annotation is associated with a unique <code>Context</code> instance. This contains details, collected by the parser/analyser, about the PHP context where the annotation was found.</p><p>Typically, there will be a processor that uses the data to augment/enrich the annotation.</p><p><strong>Examples of the data collected:</strong></p><ul><li>class/interface/trait/enum names</li><li>property names</li><li>doctype or native type hints</li><li>file name and line number</li></ul><h2 id="analysis" tabindex="-1">Analysis <a class="header-anchor" href="#analysis" aria-hidden="true">#</a></h2><p>Contains all detected annotations and other relevant meta-data.</p><p>It uses a <code>SplObjectStorage</code> instance to store the parsed annotations.</p><h2 id="documentation" tabindex="-1">Documentation <a class="header-anchor" href="#documentation" aria-hidden="true">#</a></h2><p>This documentation is generated with <a href="https://vitepress.vuejs.org/" target="_blank" rel="noopener noreferrer">VitePress</a></p><h3 id="installation" tabindex="-1">Installation <a class="header-anchor" href="#installation" aria-hidden="true">#</a></h3><div class="language-shell"><pre><code><span class="token builtin class-name">cd</span> docs
+<span class="token function">npm</span> <span class="token function">install</span> vitepress 
+</code></pre></div><h3 id="workflow" tabindex="-1">Workflow <a class="header-anchor" href="#workflow" aria-hidden="true">#</a></h3><ul><li>Edit <code>.md</code> files in the <code>docs</code> folder</li><li>Update annotation / attribute PHP docblocks.<br>These will be extracted during publishing into the <a href="./../reference/">reference</a> section.</li><li>Run &#39;composer docs:build&#39; to check for any errors</li><li>Run &#39;composer docs:dev&#39; to test the generated documentation locally (<code>localhost:3000</code>)</li><li>Create PR and update <code>master</code></li><li>Manually trigger the <code>gh-pages</code> workflow to update the online docs.</li></ul><p>The last step requires commit rights on <code>zircote/swagger-php</code>.</p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/guide/faq" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>FAQ</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/related-projects" data-v-e65a9748><span class="text" data-v-e65a9748>Related Projects</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/hashmap.json b/hashmap.json
new file mode 100644
index 00000000..62bb7edd
--- /dev/null
+++ b/hashmap.json
@@ -0,0 +1 @@
+{"guide_annotations.md":"8cc52798","guide_attributes.md":"3e0b725a","guide_common-techniques.md":"e2af46b9","guide_cookbook.md":"2d416869","guide_faq.md":"b1f45c64","guide_generating-openapi-documents.md":"9bb1fdd6","guide_index.md":"29bf901a","guide_installation.md":"34074778","guide_migrating-to-v3.md":"549bb338","guide_migrating-to-v4.md":"714a0f1b","guide_required-elements.md":"ef909293","guide_under-the-hood.md":"58a1fa15","index.md":"56757007","reference_annotations.md":"93df9735","reference_attributes.md":"0f7b8389","reference_generator.md":"857d4ce7","reference_index.md":"05295186","reference_processors.md":"40e47002","related-projects.md":"cb587093","snippets_preamble_annotations.md":"bb82314f","snippets_preamble_attributes.md":"b131e034","snippets_preamble_processors.md":"309ada33"}
diff --git a/index.html b/index.html
new file mode 100644
index 00000000..2accef78
--- /dev/null
+++ b/index.html
@@ -0,0 +1,73 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/index.md.56757007.lean.js">
+    
+    <meta name="twitter:title" content="Swagger-PHP">
+  <meta property="og:title" content="Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="no-sidebar theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><a class="sidebar-link-item" href="#links">Links</a><!----></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><!--[--><main class="home" aria-labelledby="main-title" data-v-8382b818><header class="home-hero" data-v-8382b818 data-v-5d8b683d><!----><h1 id="main-title" class="title" data-v-5d8b683d>Swagger-PHP</h1><p class="tagline" data-v-5d8b683d>Generate OpenAPI documentation for your RESTful API.</p><div class="nav-link action" data-v-5d8b683d data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide → <!----></a></div><!----></header><!--[--><!--]--><div class="home-features" data-v-8382b818 data-v-245bde66><div class="wrapper" data-v-245bde66><div class="container" data-v-245bde66><div class="features" data-v-245bde66><!--[--><section class="feature" data-v-245bde66><h2 class="title" data-v-245bde66>OpenAPI conformant</h2><p class="details" data-v-245bde66>Generate OpenAPI documents in version 3.0 or 3.1.</p></section><section class="feature" data-v-245bde66><h2 class="title" data-v-245bde66>Document your API inside PHP source code</h2><p class="details" data-v-245bde66>Using swagger-php lets you write the API documentation inside the PHP source files which helps keeping the documentation up-to-date.</p></section><section class="feature" data-v-245bde66><h2 class="title" data-v-245bde66>Annotation and Attribute support</h2><p class="details" data-v-245bde66>Annotations can be either docblocks or PHP 8.1 attributes.</p></section><!--]--></div></div></div></div><div class="home-content" data-v-8382b818><div style="position:relative;" data-v-8382b818><div><h3 id="_1-install-with-composer" tabindex="-1">1. Install with composer: <a class="header-anchor" href="#_1-install-with-composer" aria-hidden="true">#</a></h3><div class="language-shell"><pre><code><span class="token operator">&gt;</span> <span class="token function">composer</span> require zircote/swagger-php
+</code></pre></div><h3 id="_2-update-your-code" tabindex="-1">2. Update your code <a class="header-anchor" href="#_2-update-your-code" aria-hidden="true">#</a></h3><p>Add <code>swagger-php</code> attributes or annotations to your source code.</p><div><div class="tabs-component"><ul role="tablist" class="tabs-component-tabs"><!--[--><!--]--></ul><div class="tabs-component-panels"><!--[--><section id="minimal-at-pane" data-tab-id="minimal-at" aria-hidden="true" class="tabs-component-panel" role="tabpanel" tabindex="-1" style="display:none;"><!--[--><!--[--><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Attributes</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Info</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">title</span><span class="token punctuation">:</span> <span class="token string double-quoted-string">&quot;My First API&quot;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">version</span><span class="token punctuation">:</span> <span class="token string double-quoted-string">&quot;0.1&quot;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApi</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span>
+<span class="token punctuation">{</span>
+
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Get</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">path</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;/api/data.json&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token attribute"><span class="token delimiter punctuation">#[</span><span class="token attribute-content"><span class="token attribute-class-name class-name class-name-fully-qualified">OA<span class="token punctuation">\</span>Response</span><span class="token punctuation">(</span><span class="token attribute-class-name class-name">response</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;200&#39;</span><span class="token punctuation">,</span> <span class="token attribute-class-name class-name">description</span><span class="token punctuation">:</span> <span class="token string single-quoted-string">&#39;The data&#39;</span><span class="token punctuation">)</span></span><span class="token delimiter punctuation">]</span></span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getResource</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+        <span class="token comment">// ...</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><!--]--><!--]--></section><section id="minimal-an-pane" data-tab-id="minimal-an" aria-hidden="true" class="tabs-component-panel" role="tabpanel" tabindex="-1" style="display:none;"><!--[--><!--[--><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+
+<span class="token keyword">use</span> <span class="token package">OpenApi<span class="token punctuation">\</span>Annotations</span> <span class="token keyword">as</span> <span class="token constant">OA</span><span class="token punctuation">;</span>
+
+<span class="token comment">/**
+ * @OA\Info(
+ *     title=&quot;My First API&quot;,
+ *     version=&quot;0.1&quot;
+ * )
+ */</span>
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">OpenApi</span>
+<span class="token punctuation">{</span>
+<span class="token punctuation">}</span>
+
+<span class="token keyword">class</span> <span class="token class-name-definition class-name">MyController</span>
+<span class="token punctuation">{</span>
+
+    <span class="token comment">/**
+     * @OA\Get(
+     *     path=&quot;/api/data.json&quot;,
+     *     @OA\Response(
+     *         response=&quot;200&quot;,
+     *         description=&quot;The data&quot;
+     *     )
+     * )
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">getResource</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
+    <span class="token punctuation">{</span>
+        <span class="token comment">// ...</span>
+    <span class="token punctuation">}</span>
+<span class="token punctuation">}</span>
+</span></code></pre></div><!--]--><!--]--></section><!--]--></div></div></div><h3 id="_3-generate-openapi-documentation" tabindex="-1">3. Generate OpenAPI documentation <a class="header-anchor" href="#_3-generate-openapi-documentation" aria-hidden="true">#</a></h3><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./bin/openapi src <span class="token parameter variable">-o</span> openapi.yaml
+</code></pre></div><h3 id="_4-explore-and-interact-with-your-api" tabindex="-1">4. Explore and interact with your API <a class="header-anchor" href="#_4-explore-and-interact-with-your-api" aria-hidden="true">#</a></h3><p>Use an OpenAPI tool like <a href="https://swagger.io/tools/swagger-ui/" target="_blank" rel="noopener noreferrer">Swagger UI </a> to explore and interact with your API.</p><h2 id="links" tabindex="-1">Links <a class="header-anchor" href="#links" aria-hidden="true">#</a></h2><ul><li><a href="./guide/">User Guide</a></li><li><a href="./reference/">Reference</a></li><li><a href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer">OpenApi Documentation</a></li><li><a href="https://spec.openapis.org/oas/v3.1.0.html" target="_blank" rel="noopener noreferrer">OpenApi Specification</a></li><li><a href="https://github.com/zircote/swagger-php/tree/master/Examples" target="_blank" rel="noopener noreferrer">Learn by example</a></li><li><a href="./related-projects.html">Related projects</a></li><li><a href="https://github.com/zircote/swagger-php/tree/2.x/docs" target="_blank" rel="noopener noreferrer">Swagger-php 2.x documentation</a></li></ul></div></div></div><!--[--><!--]--><!----><!--[--><!--]--></main><!--]--></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/reference/annotations.html b/reference/annotations.html
new file mode 100644
index 00000000..2d469f99
--- /dev/null
+++ b/reference/annotations.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Annotation Reference | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/reference_annotations.md.93df9735.lean.js">
+    
+    <meta name="twitter:title" content="Annotation Reference | Swagger-PHP">
+  <meta property="og:title" content="Annotation Reference | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Reference</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/reference/annotations">Annotations</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#annotations">Annotations</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#additionalproperties">AdditionalProperties</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#attachable">Attachable</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#components">Components</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#contact">Contact</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#cookieparameter">CookieParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#delete">Delete</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#discriminator">Discriminator</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#examples">Examples</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#externaldocumentation">ExternalDocumentation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#flow">Flow</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#get">Get</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#head">Head</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#header">Header</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#headerparameter">HeaderParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#info">Info</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#items">Items</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#jsoncontent">JsonContent</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#license">License</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#link">Link</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mediatype">MediaType</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#openapi">OpenApi</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#options">Options</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#parameter">Parameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#patch">Patch</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#pathitem">PathItem</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#pathparameter">PathParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#post">Post</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#property">Property</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#put">Put</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#queryparameter">QueryParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#requestbody">RequestBody</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#response">Response</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#schema">Schema</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#securityscheme">SecurityScheme</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#server">Server</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#servervariable">ServerVariable</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#tag">Tag</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#trace">Trace</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#webhook">Webhook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#xml">Xml</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#xmlcontent">XmlContent</a><!----></li></ul></li></ul></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Api</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/generator">Generator</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/processors">Processors</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="annotation-reference" tabindex="-1">Annotation Reference <a class="header-anchor" href="#annotation-reference" aria-hidden="true">#</a></h1><p>This page is generated automatically from the <code>swagger-php</code> sources.</p><p>For improvements head over to <a href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer">GitHub</a> and create a PR 😉</p><p>In addition to this page, there are also a number of <a href="https://github.com/zircote/swagger-php/tree/master/Examples#readme" target="_blank" rel="noopener noreferrer">examples</a> which might help you out.</p><h2 id="annotations" tabindex="-1">Annotations <a class="header-anchor" href="#annotations" aria-hidden="true">#</a></h2><h3 id="additionalproperties" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/AdditionalProperties.php" target="_blank" rel="noopener noreferrer">AdditionalProperties</a> <a class="header-anchor" href="#additionalproperties" aria-hidden="true">#</a></h3><h4 id="allowed-in" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#additionalproperties">AdditionalProperties</a></p><h4 id="nested-elements" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h3 id="attachable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Attachable.php" target="_blank" rel="noopener noreferrer">Attachable</a> <a class="header-anchor" href="#attachable" aria-hidden="true">#</a></h3><p>A container for custom data to be attached to an annotation.</p><p>These will be ignored by <code>swagger-php</code> but can be used for custom processing.</p><h4 id="allowed-in-1" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-1" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#components">Components</a>, <a href="#contact">Contact</a>, <a href="#delete">Delete</a>, <a href="#discriminator">Discriminator</a>, <a href="#examples">Examples</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#flow">Flow</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#header">Header</a>, <a href="#info">Info</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#license">License</a>, <a href="#link">Link</a>, <a href="#mediatype">MediaType</a>, <a href="#openapi">OpenApi</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#patch">Patch</a>, <a href="#pathitem">PathItem</a>, <a href="#pathparameter">PathParameter</a>, <a href="#post">Post</a>, <a href="#property">Property</a>, <a href="#put">Put</a>, <a href="#requestbody">RequestBody</a>, <a href="#response">Response</a>, <a href="#schema">Schema</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#server">Server</a>, <a href="#servervariable">ServerVariable</a>, <a href="#tag">Tag</a>, <a href="#trace">Trace</a>, <a href="#webhook">Webhook</a>, <a href="#xml">Xml</a>, <a href="#xmlcontent">XmlContent</a></p><h3 id="components" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Components.php" target="_blank" rel="noopener noreferrer">Components</a> <a class="header-anchor" href="#components" aria-hidden="true">#</a></h3><p>Holds a set of reusable objects for different aspects of the OA.</p><p>All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.</p><h4 id="allowed-in-2" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-2" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-1" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-1" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#requestbody">RequestBody</a>, <a href="#examples">Examples</a>, <a href="#header">Header</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#link">Link</a>, <a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="properties" tabindex="-1">Properties <a class="header-anchor" href="#properties" aria-hidden="true">#</a></h4><hr><dl><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Reusable Callbacks.</p></dd></dl><h4 id="reference" tabindex="-1">Reference <a class="header-anchor" href="#reference" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#components-object" target="_blank" rel="noopener noreferrer">OAI Components Object</a></li></ul><h3 id="contact" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Contact.php" target="_blank" rel="noopener noreferrer">Contact</a> <a class="header-anchor" href="#contact" aria-hidden="true">#</a></h3><p>Contact information for the exposed API.</p><h4 id="allowed-in-3" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-3" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-2" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-2" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-1" tabindex="-1">Properties <a class="header-anchor" href="#properties-1" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The identifying name of the contact person/organization.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL pointing to the contact information.</p></dd><dt><strong>email</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The email address of the contact person/organization.</p></dd></dl><h4 id="reference-1" tabindex="-1">Reference <a class="header-anchor" href="#reference-1" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#contact-object" target="_blank" rel="noopener noreferrer">OAI Contact Object</a></li></ul><h3 id="cookieparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/CookieParameter.php" target="_blank" rel="noopener noreferrer">CookieParameter</a> <a class="header-anchor" href="#cookieparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\Request</code> cookie parameter.</p><h4 id="allowed-in-4" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-4" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-3" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-3" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-2" tabindex="-1">Properties <a class="header-anchor" href="#properties-2" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;cookie&#39; as the default location.</p></dd></dl><h3 id="delete" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Delete.php" target="_blank" rel="noopener noreferrer">Delete</a> <a class="header-anchor" href="#delete" aria-hidden="true">#</a></h3><h4 id="allowed-in-5" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-5" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-4" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-4" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-3" tabindex="-1">Properties <a class="header-anchor" href="#properties-3" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="discriminator" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Discriminator.php" target="_blank" rel="noopener noreferrer">Discriminator</a> <a class="header-anchor" href="#discriminator" aria-hidden="true">#</a></h3><p>The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it.</p><p>This object is based on the <a href="http://json-schema.org" target="_blank" rel="noopener noreferrer">JSON Schema Specification</a> and uses a predefined subset of it. On top of this subset, there are extensions provided by this specification to allow for more complete documentation.</p><h4 id="allowed-in-6" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-6" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-5" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-5" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-4" tabindex="-1">Properties <a class="header-anchor" href="#properties-4" aria-hidden="true">#</a></h4><hr><dl><dt><strong>propertyName</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the property in the payload that will hold the discriminator value.</p></dd><dt><strong>mapping</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object to hold mappings between payload values and schema names or references.</p></dd></dl><h4 id="reference-2" tabindex="-1">Reference <a class="header-anchor" href="#reference-2" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#discriminatorObject" target="_blank" rel="noopener noreferrer">OAI Discriminator Object</a></li><li><a href="http://json-schema.org/" target="_blank" rel="noopener noreferrer">JSON Schema</a></li></ul><h3 id="examples" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Examples.php" target="_blank" rel="noopener noreferrer">Examples</a> <a class="header-anchor" href="#examples" aria-hidden="true">#</a></h3><h4 id="allowed-in-7" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-7" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#schema">Schema</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-6" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-6" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-5" tabindex="-1">Properties <a class="header-anchor" href="#properties-5" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to an example.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into `#/components/examples`.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Short description for the example.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>value</strong> : <span style="font-family:monospace;">int|string|array</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>externalValue</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL that points to the literal example.<br><br> This provides the capability to reference examples that cannot easily be included<br> in JSON or YAML documents.<br><br> The value field and externalValue field are mutually exclusive.</p></dd></dl><h3 id="externaldocumentation" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/ExternalDocumentation.php" target="_blank" rel="noopener noreferrer">ExternalDocumentation</a> <a class="header-anchor" href="#externaldocumentation" aria-hidden="true">#</a></h3><p>Allows referencing an external resource for extended documentation.</p><h4 id="allowed-in-8" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-8" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#tag">Tag</a>, <a href="#schema">Schema</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#property">Property</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-7" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-7" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-6" tabindex="-1">Properties <a class="header-anchor" href="#properties-6" aria-hidden="true">#</a></h4><hr><dl><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description of the target documentation. GFM syntax can be used for rich text representation.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL for the target documentation.</p></dd></dl><h4 id="reference-3" tabindex="-1">Reference <a class="header-anchor" href="#reference-3" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#external-documentation-object" target="_blank" rel="noopener noreferrer">OAI External Documentation Object</a></li></ul><h3 id="flow" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Flow.php" target="_blank" rel="noopener noreferrer">Flow</a> <a class="header-anchor" href="#flow" aria-hidden="true">#</a></h3><p>Configuration details for a supported OAuth Flow.</p><h4 id="allowed-in-9" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-9" aria-hidden="true">#</a></h4><hr><p><a href="#securityscheme">SecurityScheme</a></p><h4 id="nested-elements-8" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-8" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-7" tabindex="-1">Properties <a class="header-anchor" href="#properties-7" aria-hidden="true">#</a></h4><hr><dl><dt><strong>authorizationUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The authorization url to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>tokenUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The token URL to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>refreshUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL to be used for obtaining refresh tokens.<br><br> This must be in the form of an url.</p></dd><dt><strong>flow</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Flow name.<br><br> One of [&#39;implicit&#39;, &#39;password&#39;, &#39;authorizationCode&#39;, &#39;clientCredentials&#39;].</p></dd><dt><strong>scopes</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>The available scopes for the OAuth2 security scheme.<br><br> A map between the scope name and a short description for it.</p></dd></dl><h4 id="reference-4" tabindex="-1">Reference <a class="header-anchor" href="#reference-4" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://swagger.io/specification/#oauthFlowObject" target="_blank" rel="noopener noreferrer">OAI OAuth Flow Object</a></li></ul><h3 id="get" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Get.php" target="_blank" rel="noopener noreferrer">Get</a> <a class="header-anchor" href="#get" aria-hidden="true">#</a></h3><h4 id="allowed-in-10" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-10" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-9" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-9" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-8" tabindex="-1">Properties <a class="header-anchor" href="#properties-8" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="head" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Head.php" target="_blank" rel="noopener noreferrer">Head</a> <a class="header-anchor" href="#head" aria-hidden="true">#</a></h3><h4 id="allowed-in-11" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-11" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-10" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-10" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-9" tabindex="-1">Properties <a class="header-anchor" href="#properties-9" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="header" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Header.php" target="_blank" rel="noopener noreferrer">Header</a> <a class="header-anchor" href="#header" aria-hidden="true">#</a></h3><h4 id="allowed-in-12" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-12" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-11" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-11" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-10" tabindex="-1">Properties <a class="header-anchor" href="#properties-10" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>header</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>No details available.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>No details available.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.</p></dd></dl><h4 id="reference-5" tabindex="-1">Reference <a class="header-anchor" href="#reference-5" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#headerObject" target="_blank" rel="noopener noreferrer">OAI Header Object</a>.</li></ul><h3 id="headerparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/HeaderParameter.php" target="_blank" rel="noopener noreferrer">HeaderParameter</a> <a class="header-anchor" href="#headerparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\Request</code> header parameter.</p><h4 id="allowed-in-13" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-13" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-12" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-12" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-11" tabindex="-1">Properties <a class="header-anchor" href="#properties-11" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;header&#39; as the default location.</p></dd></dl><h3 id="info" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Info.php" target="_blank" rel="noopener noreferrer">Info</a> <a class="header-anchor" href="#info" aria-hidden="true">#</a></h3><p>The object provides metadata about the API.</p><p>The metadata may be used by the clients if needed and may be presented in editing or documentation generation tools for convenience.</p><h4 id="allowed-in-14" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-14" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-13" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-13" aria-hidden="true">#</a></h4><hr><p><a href="#contact">Contact</a>, <a href="#license">License</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-12" tabindex="-1">Properties <a class="header-anchor" href="#properties-12" aria-hidden="true">#</a></h4><hr><dl><dt><strong>title</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The title of the application.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description of the application.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>termsOfService</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL to the Terms of Service for the API.<br><br> Must be in the format of an url.</p></dd><dt><strong>version</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).</p></dd></dl><h4 id="reference-6" tabindex="-1">Reference <a class="header-anchor" href="#reference-6" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#info-object" target="_blank" rel="noopener noreferrer">OAI Info Object</a></li></ul><h3 id="items" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Items.php" target="_blank" rel="noopener noreferrer">Items</a> <a class="header-anchor" href="#items" aria-hidden="true">#</a></h3><p>The description of an item in a Schema with type <code>array</code>.</p><h4 id="allowed-in-15" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-15" aria-hidden="true">#</a></h4><hr><p><a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#items">Items</a></p><h4 id="nested-elements-14" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-14" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h3 id="jsoncontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/JsonContent.php" target="_blank" rel="noopener noreferrer">JsonContent</a> <a class="header-anchor" href="#jsoncontent" aria-hidden="true">#</a></h3><p>Shorthand for a json response.</p><p>Use as <code>@OA\Schema</code> inside a <code>Response</code> and <code>MediaType</code>-&gt;<code>&#39;application/json&#39;</code> will be generated.</p><h4 id="nested-elements-15" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-15" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h3 id="license" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/License.php" target="_blank" rel="noopener noreferrer">License</a> <a class="header-anchor" href="#license" aria-hidden="true">#</a></h3><p>License information for the exposed API.</p><h4 id="allowed-in-16" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-16" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-16" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-16" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-13" tabindex="-1">Properties <a class="header-anchor" href="#properties-13" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The license name used for the API.</p></dd><dt><strong>identifier</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL to the license used for the API. This MUST be in the form of a URL.<br><br> The `url` field is mutually exclusive of the `identifier` field.</p></dd></dl><h4 id="reference-7" tabindex="-1">Reference <a class="header-anchor" href="#reference-7" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#license-object" target="_blank" rel="noopener noreferrer">OAI License Object</a></li></ul><h3 id="link" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Link.php" target="_blank" rel="noopener noreferrer">Link</a> <a class="header-anchor" href="#link" aria-hidden="true">#</a></h3><p>The Link object represents a possible design-time link for a response.</p><p>The presence of a link does not guarantee the caller&#39;s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.</p><p>Unlike dynamic links (i.e. links provided in the response payload), the OA linking mechanism does not require link information in the runtime response.</p><p>For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation.</p><h4 id="allowed-in-17" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-17" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-17" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-17" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-14" tabindex="-1">Properties <a class="header-anchor" href="#properties-14" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>link</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into MediaType-&gt;links array.</p></dd><dt><strong>operationRef</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A relative or absolute reference to an OA operation.<br><br> This field is mutually exclusive of the <code>operationId</code> field, and must point to an Operation object.<br><br> Relative values may be used to locate an existing Operation object in the OpenAPI definition.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of an existing, resolvable OA operation, as defined with a unique <code>operationId</code>.<br><br> This field is mutually exclusive of the <code>operationRef</code> field.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map representing parameters to pass to an operation as specified with operationId or identified via<br> operationRef.<br><br> The key is the parameter name to be used, whereas the value can be a constant or an expression to<br> be evaluated and passed to the linked operation.<br> The parameter name can be qualified using the parameter location [{in}.]{name} for operations<br> that use the same parameter name in different locations (e.g. path.id).</p></dd><dt><strong>requestBody</strong></dt><dd><p>A literal value or {expression} to use as a request body when calling the target operation.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A description of the link.<br><br> CommonMark syntax may be used for rich text representation.</p></dd></dl><h4 id="reference-8" tabindex="-1">Reference <a class="header-anchor" href="#reference-8" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object" target="_blank" rel="noopener noreferrer">OAI Link Object</a></li></ul><h3 id="mediatype" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/MediaType.php" target="_blank" rel="noopener noreferrer">MediaType</a> <a class="header-anchor" href="#mediatype" aria-hidden="true">#</a></h3><p>Each Media Type object provides schema and examples for the media type identified by its key.</p><h4 id="allowed-in-18" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-18" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#requestbody">RequestBody</a></p><h4 id="nested-elements-18" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-18" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-15" tabindex="-1">Properties <a class="header-anchor" href="#properties-15" aria-hidden="true">#</a></h4><hr><dl><dt><strong>mediaType</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Operation-&gt;content array.</p></dd><dt><strong>example</strong></dt><dd><p>Example of the media type.<br><br> The example object should be in the correct format as specified by the media type.<br> The example object is mutually exclusive of the examples object.<br><br> Furthermore, if referencing a schema which contains an example,<br> the example value shall override the example provided by the schema.</p></dd><dt><strong>encoding</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map between a property name and its encoding information.<br><br> The key, being the property name, must exist in the schema as a property.<br><br> The encoding object shall only apply to requestBody objects when the media type is multipart or<br> application/x-www-form-urlencoded.</p></dd></dl><h4 id="reference-9" tabindex="-1">Reference <a class="header-anchor" href="#reference-9" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object" target="_blank" rel="noopener noreferrer">OAI Media Type Object</a></li></ul><h3 id="openapi" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/OpenApi.php" target="_blank" rel="noopener noreferrer">OpenApi</a> <a class="header-anchor" href="#openapi" aria-hidden="true">#</a></h3><p>This is the root document object for the API specification.</p><h4 id="nested-elements-19" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-19" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a>, <a href="#server">Server</a>, <a href="#pathitem">PathItem</a>, <a href="#components">Components</a>, <a href="#tag">Tag</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#webhook">Webhook</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-16" tabindex="-1">Properties <a class="header-anchor" href="#properties-16" aria-hidden="true">#</a></h4><hr><dl><dt><strong>openapi</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The semantic version number of the OpenAPI Specification version that the OpenAPI document uses.<br><br> The openapi field should be used by tooling specifications and clients to interpret the OpenAPI document.<br><br> A version specified via `Generator::setVersion()` will overwrite this value.<br><br> This is not related to the API info::version string.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>A declaration of which security mechanisms can be used across the API.<br><br> The list of values includes alternative security requirement objects that can be used.<br> Only one of the security requirement objects need to be satisfied to authorize a request.<br> Individual operations can override this definition.<br> To make security optional, an empty security requirement `({})` can be included in the array.</p></dd></dl><h4 id="reference-10" tabindex="-1">Reference <a class="header-anchor" href="#reference-10" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#openapi-object" target="_blank" rel="noopener noreferrer">OAI OpenApi Object</a></li></ul><h3 id="options" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Options.php" target="_blank" rel="noopener noreferrer">Options</a> <a class="header-anchor" href="#options" aria-hidden="true">#</a></h3><h4 id="allowed-in-19" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-19" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-20" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-20" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-17" tabindex="-1">Properties <a class="header-anchor" href="#properties-17" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="parameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Parameter.php" target="_blank" rel="noopener noreferrer">Parameter</a> <a class="header-anchor" href="#parameter" aria-hidden="true">#</a></h3><p>Describes a single operation parameter.</p><p>A unique parameter is defined by a combination of a name and location.</p><h4 id="allowed-in-20" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-20" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-21" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-21" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-18" tabindex="-1">Properties <a class="header-anchor" href="#properties-18" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>parameter</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The location of the parameter.<br><br> Possible values are &quot;query&quot;, &quot;header&quot;, &quot;path&quot; or &quot;cookie&quot;.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>example</strong></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>matrix</strong></dt><dd><p>Path-style parameters defined by RFC6570.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.7">RFC6570</a></p></dd><dt><strong>label</strong></dt><dd><p>Label style parameters defined by RFC6570.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.5">RFC6570</a></p></dd><dt><strong>form</strong></dt><dd><p>Form style parameters defined by RFC6570.<br><br> This option replaces collectionFormat with a csv (when explode is false) or multi (when explode is true) value from OpenAPI 2.0.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.8">RFC6570</a></p></dd><dt><strong>simple</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Simple style parameters defined by RFC6570.<br><br> This option replaces collectionFormat with a csv value from OpenAPI 2.0.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc6570#section-3.2.2">RFC6570</a></p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>deepObject</strong></dt><dd><p>Provides a simple way of rendering nested objects using form parameters.</p></dd></dl><h4 id="reference-11" tabindex="-1">Reference <a class="header-anchor" href="#reference-11" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-object" target="_blank" rel="noopener noreferrer">OAA Parameter Object</a></li></ul><h3 id="patch" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Patch.php" target="_blank" rel="noopener noreferrer">Patch</a> <a class="header-anchor" href="#patch" aria-hidden="true">#</a></h3><h4 id="allowed-in-21" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-21" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-22" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-22" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-19" tabindex="-1">Properties <a class="header-anchor" href="#properties-19" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="pathitem" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/PathItem.php" target="_blank" rel="noopener noreferrer">PathItem</a> <a class="header-anchor" href="#pathitem" aria-hidden="true">#</a></h3><p>Describes the operations available on a single path.</p><p>A Path Item may be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer, but they will not know which operations and parameters are available.</p><h4 id="allowed-in-22" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-22" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-23" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-23" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-20" tabindex="-1">Properties <a class="header-anchor" href="#properties-20" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional, string summary, intended to apply to all operations in this path.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional, string description, intended to apply to all operations in this path.</p></dd><dt><strong>path</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Key for the Path Object (OpenApi-&gt;paths array).</p></dd></dl><h4 id="reference-12" tabindex="-1">Reference <a class="header-anchor" href="#reference-12" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#path-item-object" target="_blank" rel="noopener noreferrer">OAI Path Item Object</a></li></ul><h3 id="pathparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/PathParameter.php" target="_blank" rel="noopener noreferrer">PathParameter</a> <a class="header-anchor" href="#pathparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\Request</code> path parameter.</p><h4 id="allowed-in-23" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-23" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-24" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-24" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-21" tabindex="-1">Properties <a class="header-anchor" href="#properties-21" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;path&#39; as the default location.</p></dd><dt><strong>required</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="post" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Post.php" target="_blank" rel="noopener noreferrer">Post</a> <a class="header-anchor" href="#post" aria-hidden="true">#</a></h3><h4 id="allowed-in-24" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-24" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-25" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-25" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-22" tabindex="-1">Properties <a class="header-anchor" href="#properties-22" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="property" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Property.php" target="_blank" rel="noopener noreferrer">Property</a> <a class="header-anchor" href="#property" aria-hidden="true">#</a></h3><h4 id="allowed-in-25" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-25" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#property">Property</a>, <a href="#items">Items</a></p><h4 id="nested-elements-26" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-26" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-23" tabindex="-1">Properties <a class="header-anchor" href="#properties-23" aria-hidden="true">#</a></h4><hr><dl><dt><strong>property</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Schema-&gt;properties array.</p></dd></dl><h3 id="put" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Put.php" target="_blank" rel="noopener noreferrer">Put</a> <a class="header-anchor" href="#put" aria-hidden="true">#</a></h3><h4 id="allowed-in-26" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-26" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-27" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-27" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-24" tabindex="-1">Properties <a class="header-anchor" href="#properties-24" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="queryparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/QueryParameter.php" target="_blank" rel="noopener noreferrer">QueryParameter</a> <a class="header-anchor" href="#queryparameter" aria-hidden="true">#</a></h3><p>A <code>@OA\Request</code> query parameter.</p><h4 id="allowed-in-27" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-27" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-28" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-28" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-25" tabindex="-1">Properties <a class="header-anchor" href="#properties-25" aria-hidden="true">#</a></h4><hr><dl><dt><strong>in</strong></dt><dd><p>This takes &#39;query&#39; as the default location.</p></dd></dl><h3 id="requestbody" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/RequestBody.php" target="_blank" rel="noopener noreferrer">RequestBody</a> <a class="header-anchor" href="#requestbody" aria-hidden="true">#</a></h3><p>Describes a single request body.</p><h4 id="allowed-in-28" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-28" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#delete">Delete</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#patch">Patch</a>, <a href="#post">Post</a>, <a href="#trace">Trace</a>, <a href="#put">Put</a></p><h4 id="nested-elements-29" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-29" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-26" tabindex="-1">Properties <a class="header-anchor" href="#properties-26" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to a request body.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>request</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Components-&gt;requestBodies array.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd></dl><h4 id="reference-13" tabindex="-1">Reference <a class="header-anchor" href="#reference-13" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#requestBodyObject" target="_blank" rel="noopener noreferrer">OAI Request Body Object</a></li></ul><h3 id="response" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Response.php" target="_blank" rel="noopener noreferrer">Response</a> <a class="header-anchor" href="#response" aria-hidden="true">#</a></h3><p>Describes a single response from an API Operation, including design-time, static links to operations based on the response.</p><h4 id="allowed-in-29" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-29" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#patch">Patch</a>, <a href="#delete">Delete</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-30" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-30" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#header">Header</a>, <a href="#link">Link</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-27" tabindex="-1">Properties <a class="header-anchor" href="#properties-27" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to a response.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>response</strong> : <span style="font-family:monospace;">string|int</span></dt><dd><p>The key into Operations-&gt;responses array.<br><br> A HTTP status code or <code>default</code>.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description of the response.<br><br> CommonMark syntax may be used for rich text representation.</p></dd></dl><h4 id="reference-14" tabindex="-1">Reference <a class="header-anchor" href="#reference-14" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#response-object" target="_blank" rel="noopener noreferrer">OAI Response Object</a></li></ul><h3 id="schema" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Schema.php" target="_blank" rel="noopener noreferrer">Schema</a> <a class="header-anchor" href="#schema" aria-hidden="true">#</a></h3><p>The definition of input and output data types.</p><p>These types can be objects, but also primitives and arrays.</p><p>This object is based on the <a href="http://json-schema.org" target="_blank" rel="noopener noreferrer">JSON Schema Specification</a> and uses a predefined subset of it. On top of this subset, there are extensions provided by this specification to allow for more complete documentation.</p><h4 id="allowed-in-30" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-30" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#header">Header</a></p><h4 id="nested-elements-31" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-31" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#examples">Examples</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-28" tabindex="-1">Properties <a class="header-anchor" href="#properties-28" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">bool|int|float</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">bool|int|float</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum&gt;|class-string</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>multipleOf</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>A numeric instance is valid against &quot;multipleOf&quot; if the result of the division of the instance by this<br> property&#39;s value is an integer.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>example</strong></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Attributes\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Attributes\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Attributes\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>not</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.29.</p></dd><dt><strong>additionalItems</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.10.</p></dd><dt><strong>contains</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.14.</p></dd><dt><strong>patternProperties</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.19.</p></dd><dt><strong>dependencies</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.21.</p></dd><dt><strong>propertyNames</strong></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#rfc.section.6.22.</p></dd><dt><strong>const</strong></dt><dd><p>http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.</p></dd></dl><h4 id="reference-15" tabindex="-1">Reference <a class="header-anchor" href="#reference-15" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#schemaObject" target="_blank" rel="noopener noreferrer">OAI Schema Object</a></li><li><a href="http://json-schema.org/" target="_blank" rel="noopener noreferrer">JSON Schema</a></li></ul><h3 id="securityscheme" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/SecurityScheme.php" target="_blank" rel="noopener noreferrer">SecurityScheme</a> <a class="header-anchor" href="#securityscheme" aria-hidden="true">#</a></h3><h4 id="allowed-in-31" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-31" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a></p><h4 id="nested-elements-32" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-32" aria-hidden="true">#</a></h4><hr><p><a href="#flow">Flow</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-29" tabindex="-1">Properties <a class="header-anchor" href="#properties-29" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object</span></dt><dd><p>The relative or absolute path to a security scheme.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>securityScheme</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into OpenApi-&gt;security array.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;</span></dt><dd><p>The type of the security scheme.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description for security scheme.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the header or query parameter to be used.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Required The location of the API key.</p></dd><dt><strong>bearerFormat</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A hint to the client to identify how the bearer token is formatted.<br><br> Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.</p></dd><dt><strong>scheme</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the HTTP Authorization scheme.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc7235#section-5.1">RFC7235</a></p></dd><dt><strong>openIdConnectUrl</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.</p></dd></dl><h4 id="reference-16" tabindex="-1">Reference <a class="header-anchor" href="#reference-16" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#securitySchemeObject" target="_blank" rel="noopener noreferrer">OAI Security Scheme Object</a>.</li></ul><h3 id="server" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Server.php" target="_blank" rel="noopener noreferrer">Server</a> <a class="header-anchor" href="#server" aria-hidden="true">#</a></h3><p>An object representing a server.</p><h4 id="allowed-in-32" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-32" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#link">Link</a></p><h4 id="nested-elements-33" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-33" aria-hidden="true">#</a></h4><hr><p><a href="#servervariable">ServerVariable</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-30" tabindex="-1">Properties <a class="header-anchor" href="#properties-30" aria-hidden="true">#</a></h4><hr><dl><dt><strong>url</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An URL to the target host.<br><br> This URL supports Server Variables and may be relative,<br> to indicate that the host location is relative to the location where the OpenAPI document is being served.<br> Variable substitutions will be made when a variable is named in {brackets}.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional string describing the host designated by the URL.<br><br> CommonMark syntax may be used for rich text representation.</p></dd></dl><h4 id="reference-17" tabindex="-1">Reference <a class="header-anchor" href="#reference-17" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-object" target="_blank" rel="noopener noreferrer">OAI Server Object</a></li></ul><h3 id="servervariable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/ServerVariable.php" target="_blank" rel="noopener noreferrer">ServerVariable</a> <a class="header-anchor" href="#servervariable" aria-hidden="true">#</a></h3><p>An object representing a server variable for server URL template substitution.</p><h4 id="allowed-in-33" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-33" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a></p><h4 id="nested-elements-34" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-34" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-31" tabindex="-1">Properties <a class="header-anchor" href="#properties-31" aria-hidden="true">#</a></h4><hr><dl><dt><strong>serverVariable</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The key into Server-&gt;variables array.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum&gt;|class-string</span></dt><dd><p>An enumeration of values to be used if the substitution options are from a limited set.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The default value to use for substitution, and to send, if an alternate value is not supplied.<br><br> Unlike the Schema Object&#39;s default, this value must be provided by the consumer.</p></dd><dt><strong>variables</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>A map between a variable name and its value.<br><br> The value is used for substitution in the server&#39;s URL template.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>An optional description for the server variable.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd></dl><h4 id="reference-18" tabindex="-1">Reference <a class="header-anchor" href="#reference-18" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#server-variable-object" target="_blank" rel="noopener noreferrer">OAI Server Variable Object</a></li></ul><h3 id="tag" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Tag.php" target="_blank" rel="noopener noreferrer">Tag</a> <a class="header-anchor" href="#tag" aria-hidden="true">#</a></h3><h4 id="allowed-in-34" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-34" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-35" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-35" aria-hidden="true">#</a></h4><hr><p><a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-32" tabindex="-1">Properties <a class="header-anchor" href="#properties-32" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The name of the tag.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>A short description for the tag. GFM syntax can be used for rich text representation.</p></dd></dl><h4 id="reference-19" tabindex="-1">Reference <a class="header-anchor" href="#reference-19" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#tagObject" target="_blank" rel="noopener noreferrer">OAI Tag Object</a>.</li></ul><h3 id="trace" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Trace.php" target="_blank" rel="noopener noreferrer">Trace</a> <a class="header-anchor" href="#trace" aria-hidden="true">#</a></h3><h4 id="allowed-in-35" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-35" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-36" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-36" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-33" tabindex="-1">Properties <a class="header-anchor" href="#properties-33" aria-hidden="true">#</a></h4><hr><dl><dt><strong>method</strong></dt><dd><p>No details available.</p></dd></dl><h3 id="webhook" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Webhook.php" target="_blank" rel="noopener noreferrer">Webhook</a> <a class="header-anchor" href="#webhook" aria-hidden="true">#</a></h3><p>Acts like a <code>PathItem</code> with the main difference being that it requires <code>webhook</code> instead of <code>path</code>.</p><h4 id="allowed-in-36" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-36" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-37" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-37" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="properties-34" tabindex="-1">Properties <a class="header-anchor" href="#properties-34" aria-hidden="true">#</a></h4><hr><dl><dt><strong>webhook</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Key for the webhooks map.</p></dd></dl><h3 id="xml" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/Xml.php" target="_blank" rel="noopener noreferrer">Xml</a> <a class="header-anchor" href="#xml" aria-hidden="true">#</a></h3><h4 id="allowed-in-37" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-37" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#schema">Schema</a>, <a href="#items">Items</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-38" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-38" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="properties-35" tabindex="-1">Properties <a class="header-anchor" href="#properties-35" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>Replaces the name of the element/attribute used for the described schema property.<br><br> When defined within the Items Object (items), it will affect the name of the individual XML elements within the list.<br> When defined alongside type being array (outside the items), it will affect the wrapping element<br> and only if wrapped is <code>true</code>.<br><br> If wrapped is <code>false</code>, it will be ignored.</p></dd><dt><strong>namespace</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The URL of the namespace definition. Value SHOULD be in the form of a URL.</p></dd><dt><strong>prefix</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The prefix to be used for the name.</p></dd><dt><strong>attribute</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>Declares whether the property definition translates to an attribute instead of an element.<br><br> Default value is <code>false</code>.</p></dd><dt><strong>wrapped</strong> : <span style="font-family:monospace;">bool</span></dt><dd><p>MAY be used only for an array definition.<br><br> Signifies whether the array is wrapped (for example <code>&lt;books&gt;&lt;book/&gt;&lt;book/&gt;&lt;/books&gt;</code>)<br> or unwrapped (<code>&lt;book/&gt;&lt;book/&gt;</code>).<br><br> Default value is false. The definition takes effect only when defined alongside type being array (outside the items).</p></dd></dl><h4 id="reference-20" tabindex="-1">Reference <a class="header-anchor" href="#reference-20" aria-hidden="true">#</a></h4><hr><ul><li><a href="https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md#xmlObject" target="_blank" rel="noopener noreferrer">OAI XML Object</a>.</li></ul><h3 id="xmlcontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Annotations/XmlContent.php" target="_blank" rel="noopener noreferrer">XmlContent</a> <a class="header-anchor" href="#xmlcontent" aria-hidden="true">#</a></h3><p>Shorthand for a xml response.</p><p>Use as <code>@OA\Schema</code> inside a <code>Response</code> and <code>MediaType</code>-&gt;<code>&#39;application/xml&#39;</code> will be generated.</p><h4 id="nested-elements-39" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-39" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/reference/attributes" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Attributes</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/reference/generator" data-v-e65a9748><span class="text" data-v-e65a9748>Generator</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/reference/attributes.html b/reference/attributes.html
new file mode 100644
index 00000000..5ef34472
--- /dev/null
+++ b/reference/attributes.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Attribute Reference | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/reference_attributes.md.0f7b8389.lean.js">
+    
+    <meta name="twitter:title" content="Attribute Reference | Swagger-PHP">
+  <meta property="og:title" content="Attribute Reference | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Reference</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/reference/attributes">Attributes</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#attributes">Attributes</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#additionalproperties">AdditionalProperties</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#attachable">Attachable</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#components">Components</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#contact">Contact</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#cookieparameter">CookieParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#delete">Delete</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#discriminator">Discriminator</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#examples">Examples</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#externaldocumentation">ExternalDocumentation</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#flow">Flow</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#get">Get</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#head">Head</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#header">Header</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#headerparameter">HeaderParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#info">Info</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#items">Items</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#jsoncontent">JsonContent</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#license">License</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#link">Link</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mediatype">MediaType</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#openapi">OpenApi</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#options">Options</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#parameter">Parameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#patch">Patch</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#pathitem">PathItem</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#pathparameter">PathParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#post">Post</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#property">Property</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#put">Put</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#queryparameter">QueryParameter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#requestbody">RequestBody</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#response">Response</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#schema">Schema</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#securityscheme">SecurityScheme</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#server">Server</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#servervariable">ServerVariable</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#tag">Tag</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#trace">Trace</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#webhook">Webhook</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#xml">Xml</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#xmlcontent">XmlContent</a><!----></li></ul></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/annotations">Annotations</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Api</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/generator">Generator</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/processors">Processors</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="attribute-reference" tabindex="-1">Attribute Reference <a class="header-anchor" href="#attribute-reference" aria-hidden="true">#</a></h1><p>This page is generated automatically from the <code>swagger-php</code> sources.</p><p>For improvements head over to <a href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer">GitHub</a> and create a PR 😉</p><p>In addition to this page, there are also a number of <a href="https://github.com/zircote/swagger-php/tree/master/Examples#readme" target="_blank" rel="noopener noreferrer">examples</a> which might help you out.</p><h2 id="attributes" tabindex="-1">Attributes <a class="header-anchor" href="#attributes" aria-hidden="true">#</a></h2><h3 id="additionalproperties" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/AdditionalProperties.php" target="_blank" rel="noopener noreferrer">AdditionalProperties</a> <a class="header-anchor" href="#additionalproperties" aria-hidden="true">#</a></h3><h4 id="allowed-in" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#additionalproperties">AdditionalProperties</a></p><h4 id="nested-elements" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters" tabindex="-1">Parameters <a class="header-anchor" href="#parameters" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="attachable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Attachable.php" target="_blank" rel="noopener noreferrer">Attachable</a> <a class="header-anchor" href="#attachable" aria-hidden="true">#</a></h3><h4 id="allowed-in-1" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-1" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#components">Components</a>, <a href="#contact">Contact</a>, <a href="#delete">Delete</a>, <a href="#discriminator">Discriminator</a>, <a href="#examples">Examples</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#flow">Flow</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#header">Header</a>, <a href="#info">Info</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#license">License</a>, <a href="#link">Link</a>, <a href="#mediatype">MediaType</a>, <a href="#openapi">OpenApi</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#patch">Patch</a>, <a href="#pathitem">PathItem</a>, <a href="#pathparameter">PathParameter</a>, <a href="#post">Post</a>, <a href="#property">Property</a>, <a href="#put">Put</a>, <a href="#requestbody">RequestBody</a>, <a href="#response">Response</a>, <a href="#schema">Schema</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#server">Server</a>, <a href="#servervariable">ServerVariable</a>, <a href="#tag">Tag</a>, <a href="#trace">Trace</a>, <a href="#webhook">Webhook</a>, <a href="#xml">Xml</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="parameters-1" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-1" aria-hidden="true">#</a></h4><hr><dl><dt><strong>properties</strong> : <span style="font-family:monospace;">array</span></dt><dd><p>No details available.</p></dd></dl><h3 id="components" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Components.php" target="_blank" rel="noopener noreferrer">Components</a> <a class="header-anchor" href="#components" aria-hidden="true">#</a></h3><h4 id="allowed-in-2" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-2" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-1" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-1" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#requestbody">RequestBody</a>, <a href="#examples">Examples</a>, <a href="#header">Header</a>, <a href="#securityscheme">SecurityScheme</a>, <a href="#link">Link</a>, <a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-2" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-2" aria-hidden="true">#</a></h4><hr><dl><dt><strong>schemas</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;|null</span></dt><dd><p>Reusable Schemas.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]|null</span></dt><dd><p>Reusable Responses.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]|null</span></dt><dd><p>Reusable Parameters.</p></dd><dt><strong>requestBodies</strong> : <span style="font-family:monospace;">RequestBody[]|null</span></dt><dd><p>Reusable Request Bodies.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;|null</span></dt><dd><p>Reusable Examples.</p></dd><dt><strong>headers</strong> : <span style="font-family:monospace;">Header[]|null</span></dt><dd><p>Reusable Headers.</p></dd><dt><strong>securitySchemes</strong> : <span style="font-family:monospace;">SecurityScheme[]|null</span></dt><dd><p>Reusable Security Schemes.</p></dd><dt><strong>links</strong> : <span style="font-family:monospace;">Link[]|null</span></dt><dd><p>Reusable Links.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Reusable Callbacks.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="contact" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Contact.php" target="_blank" rel="noopener noreferrer">Contact</a> <a class="header-anchor" href="#contact" aria-hidden="true">#</a></h3><h4 id="allowed-in-3" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-3" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-2" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-2" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-3" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-3" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The identifying name of the contact person/organization.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL pointing to the contact information.</p></dd><dt><strong>email</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The email address of the contact person/organization.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="cookieparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/CookieParameter.php" target="_blank" rel="noopener noreferrer">CookieParameter</a> <a class="header-anchor" href="#cookieparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-4" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-4" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-3" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-3" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-4" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-4" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;cookie&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="delete" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Delete.php" target="_blank" rel="noopener noreferrer">Delete</a> <a class="header-anchor" href="#delete" aria-hidden="true">#</a></h3><h4 id="allowed-in-5" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-5" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-4" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-4" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-5" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-5" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="discriminator" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Discriminator.php" target="_blank" rel="noopener noreferrer">Discriminator</a> <a class="header-anchor" href="#discriminator" aria-hidden="true">#</a></h3><h4 id="allowed-in-6" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-6" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-5" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-5" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-6" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-6" aria-hidden="true">#</a></h4><hr><dl><dt><strong>propertyName</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the property in the payload that will hold the discriminator value.</p></dd><dt><strong>mapping</strong> : <span style="font-family:monospace;">string[]|null</span></dt><dd><p>An object to hold mappings between payload values and schema names or references.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="examples" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Examples.php" target="_blank" rel="noopener noreferrer">Examples</a> <a class="header-anchor" href="#examples" aria-hidden="true">#</a></h3><h4 id="allowed-in-7" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-7" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#schema">Schema</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-6" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-6" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-7" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-7" aria-hidden="true">#</a></h4><hr><dl><dt><strong>example</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into `#/components/examples`.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Short description for the example.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>value</strong> : <span style="font-family:monospace;">array|string|int|null</span></dt><dd><p>Embedded literal example.<br><br> The value field and externalValue field are mutually exclusive.<br><br> To represent examples of media types that cannot naturally be represented<br> in JSON or YAML, use a string value to contain the example, escaping where necessary.</p></dd><dt><strong>externalValue</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL that points to the literal example.<br><br> This provides the capability to reference examples that cannot easily be included<br> in JSON or YAML documents.<br><br> The value field and externalValue field are mutually exclusive.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to an example.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="externaldocumentation" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/ExternalDocumentation.php" target="_blank" rel="noopener noreferrer">ExternalDocumentation</a> <a class="header-anchor" href="#externaldocumentation" aria-hidden="true">#</a></h3><h4 id="allowed-in-8" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-8" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#tag">Tag</a>, <a href="#schema">Schema</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#property">Property</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#items">Items</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-7" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-7" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-8" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-8" aria-hidden="true">#</a></h4><hr><dl><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description of the target documentation. GFM syntax can be used for rich text representation.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL for the target documentation.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="flow" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Flow.php" target="_blank" rel="noopener noreferrer">Flow</a> <a class="header-anchor" href="#flow" aria-hidden="true">#</a></h3><h4 id="allowed-in-9" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-9" aria-hidden="true">#</a></h4><hr><p><a href="#securityscheme">SecurityScheme</a></p><h4 id="nested-elements-8" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-8" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-9" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-9" aria-hidden="true">#</a></h4><hr><dl><dt><strong>authorizationUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The authorization url to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>tokenUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The token URL to be used for this flow.<br><br> This must be in the form of an url.</p></dd><dt><strong>refreshUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL to be used for obtaining refresh tokens.<br><br> This must be in the form of an url.</p></dd><dt><strong>flow</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Flow name.<br><br> One of [&#39;implicit&#39;, &#39;password&#39;, &#39;authorizationCode&#39;, &#39;clientCredentials&#39;].</p></dd><dt><strong>scopes</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>The available scopes for the OAuth2 security scheme.<br><br> A map between the scope name and a short description for it.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="get" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Get.php" target="_blank" rel="noopener noreferrer">Get</a> <a class="header-anchor" href="#get" aria-hidden="true">#</a></h3><h4 id="allowed-in-10" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-10" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-9" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-9" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-10" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-10" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="head" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Head.php" target="_blank" rel="noopener noreferrer">Head</a> <a class="header-anchor" href="#head" aria-hidden="true">#</a></h3><h4 id="allowed-in-11" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-11" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-10" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-10" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-11" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-11" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="header" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Header.php" target="_blank" rel="noopener noreferrer">Header</a> <a class="header-anchor" href="#header" aria-hidden="true">#</a></h3><h4 id="allowed-in-12" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-12" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-11" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-11" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-12" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-12" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>header</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>No details available.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>No details available.</p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Schema|null</span></dt><dd><p>Schema object.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="headerparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/HeaderParameter.php" target="_blank" rel="noopener noreferrer">HeaderParameter</a> <a class="header-anchor" href="#headerparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-13" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-13" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-12" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-12" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-13" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-13" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;header&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="info" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Info.php" target="_blank" rel="noopener noreferrer">Info</a> <a class="header-anchor" href="#info" aria-hidden="true">#</a></h3><h4 id="allowed-in-14" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-14" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-13" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-13" aria-hidden="true">#</a></h4><hr><p><a href="#contact">Contact</a>, <a href="#license">License</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-14" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-14" aria-hidden="true">#</a></h4><hr><dl><dt><strong>version</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description of the application.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The title of the application.</p></dd><dt><strong>termsOfService</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL to the Terms of Service for the API.<br><br> Must be in the format of an url.</p></dd><dt><strong>contact</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Contact|null</span></dt><dd><p>The contact information for the exposed API.</p></dd><dt><strong>license</strong> : <span style="font-family:monospace;">OpenApi\Attributes\License|null</span></dt><dd><p>The license information for the exposed API.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="items" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Items.php" target="_blank" rel="noopener noreferrer">Items</a> <a class="header-anchor" href="#items" aria-hidden="true">#</a></h3><h4 id="allowed-in-15" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-15" aria-hidden="true">#</a></h4><hr><p><a href="#property">Property</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#items">Items</a></p><h4 id="nested-elements-14" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-14" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-15" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-15" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="jsoncontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/JsonContent.php" target="_blank" rel="noopener noreferrer">JsonContent</a> <a class="header-anchor" href="#jsoncontent" aria-hidden="true">#</a></h3><h4 id="nested-elements-15" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-15" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-16" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-16" aria-hidden="true">#</a></h4><hr><dl><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the schema.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="license" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/License.php" target="_blank" rel="noopener noreferrer">License</a> <a class="header-anchor" href="#license" aria-hidden="true">#</a></h3><h4 id="allowed-in-16" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-16" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a></p><h4 id="nested-elements-16" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-16" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-17" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-17" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The license name used for the API.</p></dd><dt><strong>identifier</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An SPDX license expression for the API. The `identifier` field is mutually exclusive of the `url` field.</p></dd><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL to the license used for the API. This MUST be in the form of a URL.<br><br> The `url` field is mutually exclusive of the `identifier` field.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="link" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Link.php" target="_blank" rel="noopener noreferrer">Link</a> <a class="header-anchor" href="#link" aria-hidden="true">#</a></h3><h4 id="allowed-in-17" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-17" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#response">Response</a></p><h4 id="nested-elements-17" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-17" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-18" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-18" aria-hidden="true">#</a></h4><hr><dl><dt><strong>link</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into MediaType-&gt;links array.</p></dd><dt><strong>operationRef</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A relative or absolute reference to an OA operation.<br><br> This field is mutually exclusive of the <code>operationId</code> field, and must point to an Operation object.<br><br> Relative values may be used to locate an existing Operation object in the OpenAPI definition.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of an existing, resolvable OA operation, as defined with a unique <code>operationId</code>.<br><br> This field is mutually exclusive of the <code>operationRef</code> field.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map representing parameters to pass to an operation as specified with operationId or identified via<br> operationRef.<br><br> The key is the parameter name to be used, whereas the value can be a constant or an expression to<br> be evaluated and passed to the linked operation.<br> The parameter name can be qualified using the parameter location [{in}.]{name} for operations<br> that use the same parameter name in different locations (e.g. path.id).</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A literal value or {expression} to use as a request body when calling the target operation.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description of the link.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>server</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Server|null</span></dt><dd><p>A server object to be used by the target operation.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="mediatype" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/MediaType.php" target="_blank" rel="noopener noreferrer">MediaType</a> <a class="header-anchor" href="#mediatype" aria-hidden="true">#</a></h3><h4 id="allowed-in-18" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-18" aria-hidden="true">#</a></h4><hr><p><a href="#response">Response</a>, <a href="#requestbody">RequestBody</a></p><h4 id="nested-elements-18" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-18" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-19" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-19" aria-hidden="true">#</a></h4><hr><dl><dt><strong>mediaType</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Operation-&gt;content array.</p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Schema|null</span></dt><dd><p>The schema defining the type used for the request body.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example object should be in the correct format as specified by the media type.<br> The example object is mutually exclusive of the examples object.<br><br> Furthermore, if referencing a schema which contains an example,<br> the example value shall override the example provided by the schema.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the media type.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>encoding</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;</span></dt><dd><p>A map between a property name and its encoding information.<br><br> The key, being the property name, must exist in the schema as a property.<br><br> The encoding object shall only apply to requestBody objects when the media type is multipart or<br> application/x-www-form-urlencoded.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="openapi" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/OpenApi.php" target="_blank" rel="noopener noreferrer">OpenApi</a> <a class="header-anchor" href="#openapi" aria-hidden="true">#</a></h3><h4 id="nested-elements-19" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-19" aria-hidden="true">#</a></h4><hr><p><a href="#info">Info</a>, <a href="#server">Server</a>, <a href="#pathitem">PathItem</a>, <a href="#components">Components</a>, <a href="#tag">Tag</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#webhook">Webhook</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-20" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-20" aria-hidden="true">#</a></h4><hr><dl><dt><strong>openapi</strong> : <span style="font-family:monospace;">string</span></dt><dd><p>The semantic version number of the OpenAPI Specification version that the OpenAPI document uses.<br><br> The openapi field should be used by tooling specifications and clients to interpret the OpenAPI document.<br><br> A version specified via `Generator::setVersion()` will overwrite this value.<br><br> This is not related to the API info::version string.</p></dd><dt><strong>info</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Info|null</span></dt><dd><p>Provides metadata about the API. The metadata may be used by tooling as required.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]|null</span></dt><dd><p>An array of <code>@Server</code> objects, which provide connectivity information to a target server.<br><br> If not provided, or is an empty array, the default value would be a Server Object with an url value of <code>/</code>.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used across the API.<br><br> The list of values includes alternative security requirement objects that can be used.<br> Only one of the security requirement objects need to be satisfied to authorize a request.<br> Individual operations can override this definition.<br> To make security optional, an empty security requirement `({})` can be included in the array.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">Tag[]|null</span></dt><dd><p>A list of tags used by the specification with additional metadata.<br><br> The order of the tags can be used to reflect on their order by the parsing tools.<br> Not all tags that are used by the Operation Object must be declared.<br> The tags that are not declared may be organized randomly or based on the tools&#39; logic.<br> Each tag name in the list must be unique.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation.</p></dd><dt><strong>paths</strong> : <span style="font-family:monospace;">PathItem[]|null</span></dt><dd><p>The available paths and operations for the API.</p></dd><dt><strong>components</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Components|null</span></dt><dd><p>An element to hold various components for the specification.</p></dd><dt><strong>webhooks</strong> : <span style="font-family:monospace;">Webhook[]|null</span></dt><dd><p>The available webhooks for the API.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="options" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Options.php" target="_blank" rel="noopener noreferrer">Options</a> <a class="header-anchor" href="#options" aria-hidden="true">#</a></h3><h4 id="allowed-in-19" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-19" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-20" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-20" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-21" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-21" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="parameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Parameter.php" target="_blank" rel="noopener noreferrer">Parameter</a> <a class="header-anchor" href="#parameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-20" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-20" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-21" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-21" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-22" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-22" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The location of the parameter.<br><br> Possible values are &quot;query&quot;, &quot;header&quot;, &quot;path&quot; or &quot;cookie&quot;.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="patch" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Patch.php" target="_blank" rel="noopener noreferrer">Patch</a> <a class="header-anchor" href="#patch" aria-hidden="true">#</a></h3><h4 id="allowed-in-21" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-21" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-22" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-22" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-23" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-23" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="pathitem" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathItem.php" target="_blank" rel="noopener noreferrer">PathItem</a> <a class="header-anchor" href="#pathitem" aria-hidden="true">#</a></h3><h4 id="allowed-in-22" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-22" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-23" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-23" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-24" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-24" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key for the Path Object (OpenApi-&gt;paths array).</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string summary, intended to apply to all operations in this path.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string description, intended to apply to all operations in this path.</p></dd><dt><strong>get</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Get|null</span></dt><dd><p>A definition of a GET operation on this path.</p></dd><dt><strong>put</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Put|null</span></dt><dd><p>A definition of a PUT operation on this path.</p></dd><dt><strong>post</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Post|null</span></dt><dd><p>A definition of a POST operation on this path.</p></dd><dt><strong>delete</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Delete|null</span></dt><dd><p>A definition of a DELETE operation on this path.</p></dd><dt><strong>options</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Options|null</span></dt><dd><p>A definition of a OPTIONS operation on this path.</p></dd><dt><strong>head</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Head|null</span></dt><dd><p>A definition of a HEAD operation on this path.</p></dd><dt><strong>patch</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Patch|null</span></dt><dd><p>A definition of a PATCH operation on this path.</p></dd><dt><strong>trace</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Trace|null</span></dt><dd><p>A definition of a TRACE operation on this path.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]|null</span></dt><dd><p>An alternative server array to service all operations in this path.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]|null</span></dt><dd><p>A list of parameters that are applicable for all the operations described under this path.<br><br> These parameters can be overridden at the operation level, but cannot be removed there.<br> The list must not include duplicated parameters.<br> A unique parameter is defined by a combination of a name and location.<br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s components/parameters.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="pathparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/PathParameter.php" target="_blank" rel="noopener noreferrer">PathParameter</a> <a class="header-anchor" href="#pathparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-23" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-23" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-24" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-24" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-25" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-25" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;path&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>No details available.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="post" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Post.php" target="_blank" rel="noopener noreferrer">Post</a> <a class="header-anchor" href="#post" aria-hidden="true">#</a></h3><h4 id="allowed-in-24" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-24" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-25" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-25" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-26" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-26" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="property" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Property.php" target="_blank" rel="noopener noreferrer">Property</a> <a class="header-anchor" href="#property" aria-hidden="true">#</a></h3><h4 id="allowed-in-25" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-25" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#jsoncontent">JsonContent</a>, <a href="#xmlcontent">XmlContent</a>, <a href="#property">Property</a>, <a href="#items">Items</a></p><h4 id="nested-elements-26" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-26" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-27" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-27" aria-hidden="true">#</a></h4><hr><dl><dt><strong>property</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Schema-&gt;properties array.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="put" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Put.php" target="_blank" rel="noopener noreferrer">Put</a> <a class="header-anchor" href="#put" aria-hidden="true">#</a></h3><h4 id="allowed-in-26" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-26" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-27" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-27" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-28" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-28" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="queryparameter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/QueryParameter.php" target="_blank" rel="noopener noreferrer">QueryParameter</a> <a class="header-anchor" href="#queryparameter" aria-hidden="true">#</a></h3><h4 id="allowed-in-27" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-27" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-28" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-28" aria-hidden="true">#</a></h4><hr><p><a href="#schema">Schema</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-29" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-29" aria-hidden="true">#</a></h4><hr><dl><dt><strong>parameter</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into <code>Components::parameters</code> or <code>PathItem::parameters</code> array.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The (case-sensitive) name of the parameter.<br><br> If in is &quot;path&quot;, the name field must correspond to the associated path segment from the path field in the Paths Object.<br><br> If in is &quot;header&quot; and the name field is &quot;Accept&quot;, &quot;Content-Type&quot; or &quot;Authorization&quot;, the parameter definition shall be ignored.<br> For all other cases, the name corresponds to the parameter name used by the in property.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>This takes &#39;query&#39; as the default location.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a parameter is deprecated and should be transitioned out of usage.</p></dd><dt><strong>allowEmptyValue</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Sets the ability to pass empty-valued parameters.<br><br> This is valid only for query parameters and allows sending a parameter with an empty value.<br><br> Default value is false.<br><br> If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue shall be ignored.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Schema|null</span></dt><dd><p>The schema defining the type used for the parameter.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Example of the media type.<br><br> The example should match the specified schema and encoding properties if present.<br> The example object is mutually exclusive of the examples object.<br> Furthermore, if referencing a schema which contains an example, the example value shall override the example provided by the schema.<br> To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the parameter.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType&gt;|JsonContent|XmlContent|Attachable|null</span></dt><dd><p>A map containing the representations for the parameter.<br><br> The key is the media type and the value describes it.<br> The map must only contain one entry.</p></dd><dt><strong>style</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Describes how the parameter value will be serialized depending on the type of the parameter value.<br><br> Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.</p></dd><dt><strong>explode</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map.<br><br> For other types of parameters this property has no effect.<br><br> When style is form, the default value is true.<br> For all other styles, the default value is false.</p></dd><dt><strong>allowReserved</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether the parameter value should allow reserved characters, as defined by RFC3986 :/?#[]@!$&amp;&#39;()*+,;= to be included without percent-encoding.<br><br> This property only applies to parameters with an in value of query.<br><br> The default value is false.</p></dd><dt><strong>spaceDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Space separated array values.<br><br> This option replaces collectionFormat equal to ssv from OpenAPI 2.0.</p></dd><dt><strong>pipeDelimited</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>Pipe separated array values.<br><br> This option replaces collectionFormat equal to pipes from OpenAPI 2.0.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="requestbody" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/RequestBody.php" target="_blank" rel="noopener noreferrer">RequestBody</a> <a class="header-anchor" href="#requestbody" aria-hidden="true">#</a></h3><h4 id="allowed-in-28" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-28" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#delete">Delete</a>, <a href="#get">Get</a>, <a href="#head">Head</a>, <a href="#operation">Operation</a>, <a href="#options">Options</a>, <a href="#patch">Patch</a>, <a href="#post">Post</a>, <a href="#trace">Trace</a>, <a href="#put">Put</a></p><h4 id="nested-elements-29" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-29" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-30" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-30" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to a request body.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>request</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;requestBodies array.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A brief description of the parameter.<br><br> This could contain examples of use.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Determines whether this parameter is mandatory.<br><br> If the parameter location is &quot;path&quot;, this property is required and its value must be true.<br> Otherwise, the property may be included and its default value is false.</p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">array&lt;MediaType|JsonContent|XmlContent&gt;|MediaType|XmlContent|Attachable|null</span></dt><dd><p>The content of the request body.<br><br> The key is a media type or media type range and the value describes it. For requests that match multiple keys,<br> only the most specific key is applicable. e.g. text/plain overrides text/*.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="response" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Response.php" target="_blank" rel="noopener noreferrer">Response</a> <a class="header-anchor" href="#response" aria-hidden="true">#</a></h3><h4 id="allowed-in-29" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-29" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#patch">Patch</a>, <a href="#delete">Delete</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a></p><h4 id="nested-elements-30" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-30" aria-hidden="true">#</a></h4><hr><p><a href="#mediatype">MediaType</a>, <a href="#header">Header</a>, <a href="#link">Link</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-31" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-31" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to a response.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>response</strong> : <span style="font-family:monospace;">string|int|null</span></dt><dd><p>The key into Operations-&gt;responses array.<br><br> A HTTP status code or <code>default</code>.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description of the response.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>headers</strong> : <span style="font-family:monospace;">Header[]</span></dt><dd><p>Maps a header name to its definition.<br><br> RFC7230 states header names are case insensitive.<br><br> If a response header is defined with the name &quot;Content-Type&quot;, it shall be ignored.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc7230#page-22">RFC7230</a></p></dd><dt><strong>content</strong> : <span style="font-family:monospace;">MediaType|JsonContent|XmlContent|Attachable|array&lt;MediaType|Attachable&gt;</span></dt><dd><p>A map containing descriptions of potential response payloads.<br><br> The key is a media type or media type range and the value describes it.<br><br> For responses that match multiple keys, only the most specific key is applicable;<br> e.g. <code>text/plain</code> overrides <code>text/*</code>.</p></dd><dt><strong>links</strong> : <span style="font-family:monospace;">Link[]</span></dt><dd><p>A map of operations links that can be followed from the response.<br><br> The key of the map is a short name for the link, following the naming constraints of the names for Component<br> Objects.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="schema" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Schema.php" target="_blank" rel="noopener noreferrer">Schema</a> <a class="header-anchor" href="#schema" aria-hidden="true">#</a></h3><h4 id="allowed-in-30" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-30" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#mediatype">MediaType</a>, <a href="#header">Header</a></p><h4 id="nested-elements-31" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-31" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#examples">Examples</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-32" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-32" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the schema.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>const</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>http://json-schema.org/draft/2020-12/json-schema-validation.html#rfc.section.6.1.3.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="securityscheme" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/SecurityScheme.php" target="_blank" rel="noopener noreferrer">SecurityScheme</a> <a class="header-anchor" href="#securityscheme" aria-hidden="true">#</a></h3><h4 id="allowed-in-31" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-31" aria-hidden="true">#</a></h4><hr><p><a href="#components">Components</a></p><h4 id="nested-elements-32" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-32" aria-hidden="true">#</a></h4><hr><p><a href="#flow">Flow</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-33" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-33" aria-hidden="true">#</a></h4><hr><dl><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to a security scheme.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>securityScheme</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into OpenApi-&gt;security array.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the security scheme.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description for security scheme.</p></dd><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the header or query parameter to be used.</p></dd><dt><strong>in</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Required The location of the API key.</p></dd><dt><strong>bearerFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A hint to the client to identify how the bearer token is formatted.<br><br> Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.</p></dd><dt><strong>scheme</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the HTTP Authorization scheme.</p><p><i>See</i>: <a href="https://tools.ietf.org/html/rfc7235#section-5.1">RFC7235</a></p></dd><dt><strong>openIdConnectUrl</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.</p></dd><dt><strong>flows</strong> : <span style="font-family:monospace;">Flow[]</span></dt><dd><p>The flow used by the OAuth2 security scheme.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="server" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Server.php" target="_blank" rel="noopener noreferrer">Server</a> <a class="header-anchor" href="#server" aria-hidden="true">#</a></h3><h4 id="allowed-in-32" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-32" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a>, <a href="#pathitem">PathItem</a>, <a href="#operation">Operation</a>, <a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#trace">Trace</a>, <a href="#link">Link</a></p><h4 id="nested-elements-33" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-33" aria-hidden="true">#</a></h4><hr><p><a href="#servervariable">ServerVariable</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-34" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-34" aria-hidden="true">#</a></h4><hr><dl><dt><strong>url</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An URL to the target host.<br><br> This URL supports Server Variables and may be relative,<br> to indicate that the host location is relative to the location where the OpenAPI document is being served.<br> Variable substitutions will be made when a variable is named in {brackets}.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional string describing the host designated by the URL.<br><br> CommonMark syntax may be used for rich text representation.</p></dd><dt><strong>variables</strong> : <span style="font-family:monospace;">ServerVariable[]</span></dt><dd><p>A map between a variable name and its value.<br><br> The value is used for substitution in the server&#39;s URL template.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="servervariable" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/ServerVariable.php" target="_blank" rel="noopener noreferrer">ServerVariable</a> <a class="header-anchor" href="#servervariable" aria-hidden="true">#</a></h3><h4 id="allowed-in-33" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-33" aria-hidden="true">#</a></h4><hr><p><a href="#server">Server</a></p><h4 id="nested-elements-34" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-34" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-35" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-35" aria-hidden="true">#</a></h4><hr><dl><dt><strong>serverVariable</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Server-&gt;variables array.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional description for the server variable.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The default value to use for substitution, and to send, if an alternate value is not supplied.<br><br> Unlike the Schema Object&#39;s default, this value must be provided by the consumer.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>An enumeration of values to be used if the substitution options are from a limited set.</p></dd><dt><strong>variables</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map between a variable name and its value.<br><br> The value is used for substitution in the server&#39;s URL template.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="tag" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Tag.php" target="_blank" rel="noopener noreferrer">Tag</a> <a class="header-anchor" href="#tag" aria-hidden="true">#</a></h3><h4 id="allowed-in-34" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-34" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-35" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-35" aria-hidden="true">#</a></h4><hr><p><a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-36" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-36" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The name of the tag.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short description for the tag. GFM syntax can be used for rich text representation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this tag.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="trace" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Trace.php" target="_blank" rel="noopener noreferrer">Trace</a> <a class="header-anchor" href="#trace" aria-hidden="true">#</a></h3><h4 id="allowed-in-35" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-35" aria-hidden="true">#</a></h4><hr><p><a href="#pathitem">PathItem</a></p><h4 id="nested-elements-36" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-36" aria-hidden="true">#</a></h4><hr><p><a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#response">Response</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#server">Server</a>, <a href="#requestbody">RequestBody</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-37" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-37" aria-hidden="true">#</a></h4><hr><dl><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key in the OpenApi &quot;Paths Object&quot; for this operation.</p></dd><dt><strong>operationId</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Unique string used to identify the operation.<br><br> The id must be unique among all operations described in the API.<br> Tools and libraries may use the operationId to uniquely identify an operation, therefore, it is recommended to<br> follow common programming naming conventions.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A verbose explanation of the operation behavior.<br><br> CommonMark syntax MAY be used for rich text representation.</p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A short summary of what the operation does.</p></dd><dt><strong>security</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A declaration of which security mechanisms can be used for this operation.<br><br> The list of values includes alternative security requirement objects that can be used.<br><br> Only one of the security requirement objects need to be satisfied to authorize a request.<br><br> This definition overrides any declared top-level security.<br> To remove a top-level security declaration, an empty array can be used.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]</span></dt><dd><p>An alternative server array to service this operation.<br><br> If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by<br> this value.</p></dd><dt><strong>requestBody</strong> : <span style="font-family:monospace;">OpenApi\Attributes\RequestBody|null</span></dt><dd><p>The request body applicable for this operation.<br><br> The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly<br> defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody shall be ignored<br> by consumers.</p></dd><dt><strong>tags</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>A list of tags for API documentation control.<br><br> Tags can be used for logical grouping of operations by resources or any other qualifier.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]</span></dt><dd><p>A list of parameters that are applicable for this operation.<br><br> If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.<br> The list must not include duplicated parameters.<br><br> A unique parameter is defined by a combination of a name and location.<br><br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s<br> components/parameters.</p></dd><dt><strong>responses</strong> : <span style="font-family:monospace;">Response[]</span></dt><dd><p>The list of possible responses as they are returned from executing this operation.</p></dd><dt><strong>callbacks</strong> : <span style="font-family:monospace;">array|null</span></dt><dd><p>A map of possible out-of band callbacks related to the parent operation.<br><br> The key is a unique identifier for the Callback Object.<br><br> Each value in the map is a Callback Object that describes a request that may be initiated by the API provider<br> and the expected responses. The key value used to identify the callback object is an expression, evaluated at<br> runtime, that identifies a URL to use for the callback operation.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this operation.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares this operation to be deprecated.<br><br> Consumers should refrain from usage of the declared operation.<br><br> Default value is false.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="webhook" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Webhook.php" target="_blank" rel="noopener noreferrer">Webhook</a> <a class="header-anchor" href="#webhook" aria-hidden="true">#</a></h3><h4 id="allowed-in-36" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-36" aria-hidden="true">#</a></h4><hr><p><a href="#openapi">OpenApi</a></p><h4 id="nested-elements-37" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-37" aria-hidden="true">#</a></h4><hr><p><a href="#get">Get</a>, <a href="#post">Post</a>, <a href="#put">Put</a>, <a href="#delete">Delete</a>, <a href="#patch">Patch</a>, <a href="#trace">Trace</a>, <a href="#head">Head</a>, <a href="#options">Options</a>, <a href="#parameter">Parameter</a>, <a href="#pathparameter">PathParameter</a>, <a href="#server">Server</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-38" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-38" aria-hidden="true">#</a></h4><hr><dl><dt><strong>webhook</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key for the webhooks map.</p></dd><dt><strong>path</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Key for the Path Object (OpenApi-&gt;paths array).</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>No details available.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>summary</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string summary, intended to apply to all operations in this path.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>An optional, string description, intended to apply to all operations in this path.</p></dd><dt><strong>get</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Get|null</span></dt><dd><p>A definition of a GET operation on this path.</p></dd><dt><strong>put</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Put|null</span></dt><dd><p>A definition of a PUT operation on this path.</p></dd><dt><strong>post</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Post|null</span></dt><dd><p>A definition of a POST operation on this path.</p></dd><dt><strong>delete</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Delete|null</span></dt><dd><p>A definition of a DELETE operation on this path.</p></dd><dt><strong>options</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Options|null</span></dt><dd><p>A definition of a OPTIONS operation on this path.</p></dd><dt><strong>head</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Head|null</span></dt><dd><p>A definition of a HEAD operation on this path.</p></dd><dt><strong>patch</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Patch|null</span></dt><dd><p>A definition of a PATCH operation on this path.</p></dd><dt><strong>trace</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Trace|null</span></dt><dd><p>A definition of a TRACE operation on this path.</p></dd><dt><strong>servers</strong> : <span style="font-family:monospace;">Server[]|null</span></dt><dd><p>An alternative server array to service all operations in this path.</p></dd><dt><strong>parameters</strong> : <span style="font-family:monospace;">Parameter[]|null</span></dt><dd><p>A list of parameters that are applicable for all the operations described under this path.<br><br> These parameters can be overridden at the operation level, but cannot be removed there.<br> The list must not include duplicated parameters.<br> A unique parameter is defined by a combination of a name and location.<br> The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object&#39;s components/parameters.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="xml" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/Xml.php" target="_blank" rel="noopener noreferrer">Xml</a> <a class="header-anchor" href="#xml" aria-hidden="true">#</a></h3><h4 id="allowed-in-37" tabindex="-1">Allowed in <a class="header-anchor" href="#allowed-in-37" aria-hidden="true">#</a></h4><hr><p><a href="#additionalproperties">AdditionalProperties</a>, <a href="#schema">Schema</a>, <a href="#property">Property</a>, <a href="#schema">Schema</a>, <a href="#items">Items</a>, <a href="#xmlcontent">XmlContent</a></p><h4 id="nested-elements-38" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-38" aria-hidden="true">#</a></h4><hr><p><a href="#attachable">Attachable</a></p><h4 id="parameters-39" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-39" aria-hidden="true">#</a></h4><hr><dl><dt><strong>name</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Replaces the name of the element/attribute used for the described schema property.<br><br> When defined within the Items Object (items), it will affect the name of the individual XML elements within the list.<br> When defined alongside type being array (outside the items), it will affect the wrapping element<br> and only if wrapped is <code>true</code>.<br><br> If wrapped is <code>false</code>, it will be ignored.</p></dd><dt><strong>namespace</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The URL of the namespace definition. Value SHOULD be in the form of a URL.</p></dd><dt><strong>prefix</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The prefix to be used for the name.</p></dd><dt><strong>attribute</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares whether the property definition translates to an attribute instead of an element.<br><br> Default value is <code>false</code>.</p></dd><dt><strong>wrapped</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>MAY be used only for an array definition.<br><br> Signifies whether the array is wrapped (for example <code>&lt;books&gt;&lt;book/&gt;&lt;book/&gt;&lt;/books&gt;</code>)<br> or unwrapped (<code>&lt;book/&gt;&lt;book/&gt;</code>).<br><br> Default value is false. The definition takes effect only when defined alongside type being array (outside the items).</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl><h3 id="xmlcontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Attributes/XmlContent.php" target="_blank" rel="noopener noreferrer">XmlContent</a> <a class="header-anchor" href="#xmlcontent" aria-hidden="true">#</a></h3><h4 id="nested-elements-39" tabindex="-1">Nested elements <a class="header-anchor" href="#nested-elements-39" aria-hidden="true">#</a></h4><hr><p><a href="#discriminator">Discriminator</a>, <a href="#items">Items</a>, <a href="#property">Property</a>, <a href="#externaldocumentation">ExternalDocumentation</a>, <a href="#xml">Xml</a>, <a href="#additionalproperties">AdditionalProperties</a>, <a href="#examples">Examples</a>, <a href="#attachable">Attachable</a></p><h4 id="parameters-40" tabindex="-1">Parameters <a class="header-anchor" href="#parameters-40" aria-hidden="true">#</a></h4><hr><dl><dt><strong>examples</strong> : <span style="font-family:monospace;">array&lt;Examples&gt;</span></dt><dd><p>Examples of the schema.<br><br> Each example should contain a value in the correct format as specified in the parameter encoding.<br> The examples object is mutually exclusive of the example object.<br> Furthermore, if referencing a schema which contains an example, the examples value shall override the example provided by the schema.</p></dd><dt><strong>ref</strong> : <span style="font-family:monospace;">string|class-string|object|null</span></dt><dd><p>The relative or absolute path to the endpoint.</p><p><i>See</i>: <a href="https://swagger.io/docs/specification/using-ref/">Using refs</a></p></dd><dt><strong>schema</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The key into Components-&gt;schemas array.</p></dd><dt><strong>title</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Can be used to decorate a user interface with information about the data produced by this user interface.<br><br> Preferably short; use <code>description</code> for more details.</p></dd><dt><strong>description</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A description will provide explanation about the purpose of the instance described by this schema.</p></dd><dt><strong>maxProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is less than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>minProperties</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of properties allowed in an object instance.<br> An object instance is valid against this property if its number of properties is greater than, or equal to, the<br> value of this attribute.</p></dd><dt><strong>required</strong> : <span style="font-family:monospace;">string[]</span></dt><dd><p>An object instance is valid against this property if its property set contains all elements in this property&#39;s<br> array value.</p></dd><dt><strong>properties</strong> : <span style="font-family:monospace;">Property[]</span></dt><dd><p>A collection of properties to define for an object.<br><br> Each property is represented as an instance of the <a href="#property">Property</a> class.</p></dd><dt><strong>type</strong> : <span style="font-family:monospace;">string|non-empty-array&lt;string&gt;|null</span></dt><dd><p>The type of the schema/property.<br><br> OpenApi v3.0: The value MUST be one of &quot;string&quot;, &quot;number&quot;, &quot;integer&quot;, &quot;boolean&quot;, &quot;array&quot; or &quot;object&quot;.<br><br> Since OpenApi v3.1 an array of types may be used.</p></dd><dt><strong>format</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>The extending format for the previously mentioned type. See Data Type Formats for further details.</p></dd><dt><strong>items</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Items|null</span></dt><dd><p>Required if type is &quot;array&quot;. Describes the type of items in the array.</p></dd><dt><strong>collectionFormat</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>Determines the format of the array if type array is used.<br><br> Possible values are:<br> - csv: comma separated values foo,bar.<br> - ssv: space separated values foo bar.<br> - tsv: tab separated values foo\tbar.<br> - pipes: pipe separated values foo|bar.<br> - multi: corresponds to multiple parameter instances instead of multiple values for a single instance<br> foo=bar&amp;foo=baz. This is valid only for parameters of type <code>query</code> or <code>formData</code>. Default<br> value is csv.</p></dd><dt><strong>default</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>Sets a default value to the parameter. The type of the value depends on the defined type.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor101">JSON schema validation</a></p></dd><dt><strong>maximum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The maximum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>exclusiveMaximum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the maximum value is excluded from the set of valid values.<br><br> When set to true, the maximum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor17">JSON schema validation</a></p></dd><dt><strong>minimum</strong> : <span style="font-family:monospace;">int|float</span></dt><dd><p>The minimum value allowed for a numeric property. This value must be a number.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>exclusiveMinimum</strong> : <span style="font-family:monospace;">int|float|bool|null</span></dt><dd><p>A boolean indicating whether the minimum value is excluded from the set of valid values.<br><br> When set to true, the minimum value is excluded, and when false or not specified, it is included.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor21">JSON schema validation</a></p></dd><dt><strong>maxLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum length of a string property.<br><br> A string instance is valid against this property if its length is less than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor26">JSON schema validation</a></p></dd><dt><strong>minLength</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum length of a string property.<br><br> A string instance is valid against this property if its length is greater than, or equal to, the value of this<br> attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor29">JSON schema validation</a></p></dd><dt><strong>maxItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The maximum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is less than, or equal to, the value of<br> this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor42">JSON schema validation</a></p></dd><dt><strong>minItems</strong> : <span style="font-family:monospace;">int|null</span></dt><dd><p>The minimum number of items allowed in an array property.<br><br> An array instance is valid against this property if its number of items is greater than, or equal to, the value<br> of this attribute.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor45">JSON schema validation</a></p></dd><dt><strong>uniqueItems</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>A boolean value indicating whether all items in an array property must be unique.<br><br> If this attribute is set to true, then all items in the array must be unique.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor49">JSON schema validation</a></p></dd><dt><strong>pattern</strong> : <span style="font-family:monospace;">string|null</span></dt><dd><p>A string instance is considered valid if the regular expression matches the instance successfully.</p></dd><dt><strong>enum</strong> : <span style="font-family:monospace;">array&lt;string|int|float|bool|\UnitEnum|null&gt;|class-string|null</span></dt><dd><p>A collection of allowable values for a property.<br><br> A property instance is valid against this attribute if its value is one of the values specified in this<br> collection.</p><p><i>See</i>: <a href="http://json-schema.org/latest/json-schema-validation.html#anchor76">JSON schema validation</a></p></dd><dt><strong>discriminator</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Discriminator|null</span></dt><dd><p>Adds support for polymorphism.<br><br> The discriminator is an object name that is used to differentiate between other schemas which may satisfy the<br> payload description. See Composition and Inheritance for more details.</p></dd><dt><strong>readOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;read only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br><br> This means that it may be sent as part of a response but should not be sent as part of the request.<br> If the property is marked as readOnly being true and is in the required list, the required will take effect on<br> the response only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>writeOnly</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Declares the property as &quot;write only&quot;.<br><br> Relevant only for Schema &quot;properties&quot; definitions.<br> Therefore, it may be sent as part of a request but should not be sent as part of the response.<br> If the property is marked as writeOnly being true and is in the required list, the required will take effect on<br> the request only. A property must not be marked as both readOnly and writeOnly being true. Default value is<br> false.</p></dd><dt><strong>xml</strong> : <span style="font-family:monospace;">OpenApi\Attributes\Xml|null</span></dt><dd><p>This may be used only on properties schemas.<br><br> It has no effect on root schemas.<br> Adds additional metadata to describe the XML representation of this property.</p></dd><dt><strong>externalDocs</strong> : <span style="font-family:monospace;">OpenApi\Attributes\ExternalDocumentation|null</span></dt><dd><p>Additional external documentation for this schema.</p></dd><dt><strong>example</strong> : <span style="font-family:monospace;">mixed|null</span></dt><dd><p>A free-form property to include an example of an instance for this schema.<br><br> To represent examples that cannot naturally be represented in JSON or YAML, a string value can be used to<br> contain the example with escaping where necessary.</p></dd><dt><strong>nullable</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Allows sending a null value for the defined schema.<br> Default value is false.<br><br> This must not be used when using OpenApi version 3.1,<br> instead make the &quot;type&quot; property an array and add &quot;null&quot; as a possible type.</p></dd><dt><strong>deprecated</strong> : <span style="font-family:monospace;">bool|null</span></dt><dd><p>Specifies that a schema is deprecated and should be transitioned out of usage.<br> Default value is false.</p></dd><dt><strong>allOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against all schemas<br> defined by this property&#39;s value.</p></dd><dt><strong>anyOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against at least one<br> schema defined by this property&#39;s value.</p></dd><dt><strong>oneOf</strong> : <span style="font-family:monospace;">array&lt;Schema|\OpenApi\Annotations\Schema&gt;</span></dt><dd><p>An instance validates successfully against this property if it validates successfully against exactly one schema<br> defined by this property&#39;s value.</p></dd><dt><strong>additionalProperties</strong> : <span style="font-family:monospace;">OpenApi\Attributes\AdditionalProperties|bool|null</span></dt><dd><p>http://json-schema.org/latest/json-schema-validation.html#anchor64.</p></dd><dt><strong>x</strong> : <span style="font-family:monospace;">array&lt;string,mixed&gt;|null</span></dt><dd><p>While the OpenAPI Specification tries to accommodate most use cases, additional data can be added to extend the specification at certain points.<br> For further details see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specificationExtensions<br> The keys inside the array will be prefixed with `x-`.</p></dd><dt><strong>attachables</strong> : <span style="font-family:monospace;">Attachable[]|null</span></dt><dd><p>Arbitrary attachables for this annotation.<br> These will be ignored but can be used for custom processing.</p></dd></dl></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><!----></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/reference/annotations" data-v-e65a9748><span class="text" data-v-e65a9748>Annotations</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/reference/generator.html b/reference/generator.html
new file mode 100644
index 00000000..6df2a89a
--- /dev/null
+++ b/reference/generator.html
@@ -0,0 +1,101 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Using the Generator | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/reference_generator.md.857d4ce7.lean.js">
+    
+    <meta name="twitter:title" content="Using the Generator | Swagger-PHP">
+  <meta property="og:title" content="Using the Generator | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Reference</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/annotations">Annotations</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Api</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/reference/generator">Generator</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#introduction">Introduction</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#the-openapi-scan-function">The \OpenApi\scan() function</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#the-openapi-generator-class">The \OpenApi\Generator class</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/processors">Processors</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="using-the-generator" tabindex="-1">Using the <code>Generator</code> <a class="header-anchor" href="#using-the-generator" aria-hidden="true">#</a></h1><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-hidden="true">#</a></h2><p>The <code>Generator</code> class provides an object-oriented way to use <code>swagger-php</code> and all its aspects in a single place.</p><h2 id="the-openapi-scan-function" tabindex="-1">The <code>\OpenApi\scan()</code> function <a class="header-anchor" href="#the-openapi-scan-function" aria-hidden="true">#</a></h2><p>For a long time the <code>\OpenApi\scan()</code> function was the main entry point into using swagger-php from PHP code.</p><div class="language-php"><pre><code><span class="token comment">/**
+  * Scan the filesystem for OpenAPI annotations and build openapi-documentation.
+  *
+  * @param array|Finder|string $directory The directory(s) or filename(s)
+  * @param array               $options
+  *                                       exclude: string|array $exclude The directory(s) or filename(s) to exclude (as absolute or relative paths)
+  *                                       pattern: string       $pattern File pattern(s) to scan (default: *.php)
+  *                                       analyser: defaults to StaticAnalyser
+  *                                       analysis: defaults to a new Analysis
+  *                                       processors: defaults to the registered processors in Analysis
+  *
+  * @return OpenApi
+  */</span>
+  <span class="token keyword">function</span> <span class="token function-definition function">scan</span><span class="token punctuation">(</span><span class="token variable">$directory</span><span class="token punctuation">,</span> <span class="token variable">$options</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Using it looked typically something like this:</p><div class="language-php"><pre><code><span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token function"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>scan</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;exclude&#39;</span> <span class="token operator">=&gt;</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;tests&#39;</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">&#39;pattern&#39;</span> <span class="token operator">=&gt;</span> <span class="token string single-quoted-string">&#39;*.php&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><p>The two configuration options for the underlying Doctrine doc-block parser <code>aliases</code> and <code>namespaces</code> are not part of this function and need to be set separately.</p><p>Being static this means setting them back is the callers responsibility and there is also the fact that some Doctrine configuration currently can not be reverted easily.</p><p>Therefore, having a single side effect free way of using swagger-php seemed like a good idea...</p><h2 id="the-openapi-generator-class" tabindex="-1">The <code>\OpenApi\Generator</code> class <a class="header-anchor" href="#the-openapi-generator-class" aria-hidden="true">#</a></h2><p>The <code>Generator</code> class can be used in object-oriented (and fluent) style which allows for easy customization if needed.</p><p>In that case to actually process the given input files the <strong>non-static</strong> method <code>generate()</code> is to be used.</p><p>Full example of using the <code>Generator</code> class to generate OpenApi specs.</p><div class="language-php"><pre><code><span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$validate</span> <span class="token operator">=</span> <span class="token constant boolean">true</span><span class="token punctuation">;</span>
+<span class="token variable">$logger</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\</span>Psr<span class="token punctuation">\</span>Log<span class="token punctuation">\</span>NullLogger</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+<span class="token variable">$processors</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token comment">/* my processors */</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
+<span class="token variable">$finder</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\</span>Symfony<span class="token punctuation">\</span>Component<span class="token punctuation">\</span>Finder<span class="token punctuation">\</span>Finder</span><span class="token operator">::</span><span class="token function">create</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">files</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">name</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;*.php&#39;</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">in</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Generator</span><span class="token punctuation">(</span><span class="token variable">$logger</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setProcessorPipeline</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Pipeline</span><span class="token punctuation">(</span><span class="token variable">$processors</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setAliases</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;MY&#39;</span> <span class="token operator">=&gt;</span> <span class="token string single-quoted-string">&#39;My\Annotations&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setNamespaces</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;My\\Annotations\\&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setAnalyser</span><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Analysers<span class="token punctuation">\</span>TokenAnalyser</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">setVersion</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Annotations<span class="token punctuation">\</span>OpenApi</span><span class="token operator">::</span><span class="token constant">VERSION_3_0_0</span><span class="token punctuation">)</span>
+            <span class="token operator">-&gt;</span><span class="token function">generate</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path1/to/project&#39;</span><span class="token punctuation">,</span> <span class="token variable">$finder</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Analysis</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token variable">$validate</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><p><code>Aliases</code> and <code>namespaces</code> are additional options that allow to customize the parsing of docblocks.</p><p>Defaults:</p><ul><li><p><strong>aliases</strong>: <code>[&#39;oa&#39; =&gt; &#39;OpenApi\\Annotations&#39;]</code></p><p>Aliases help the underlying <code>doctrine annotations library</code> to parse annotations. Effectively they avoid having to write <code>use OpenApi\Annotations as OA;</code> in your code and make <code>@OA\property(..)</code> annotations still work.</p></li><li><p><strong>namespaces</strong>: <code>[&#39;OpenApi\\Annotations\\&#39;]</code></p><p>Namespaces control which annotation namespaces can be autoloaded automatically. Under the hood this is handled by registering a custom loader with the <code>doctrine annotation library</code>.</p></li></ul><p>Advantages:</p><ul><li>The <code>Generator</code> code will handle configuring things as before in a single place</li><li>Static settings will be reverted to the default once finished</li><li>The get/set methods allow for using type hints</li><li>Static configuration is deprecated and can be removed at some point without code changes</li><li>Build in support for PSR logger</li><li>Support for <a href="https://symfony.com/doc/current/components/finder.html" target="_blank" rel="noopener noreferrer">Symfony Finder</a>, <code>\SplInfo</code> and file/directory names (`string) as source.</li></ul><p>The minimum code required, using the <code>generate()</code> method, looks quite similar to the old <code>scan()</code> code:</p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * Generate OpenAPI spec by scanning the given source files.
+     *
+     * @param iterable      $sources  PHP source files to scan.
+     *                                Supported sources:
+     *                                * string - file / directory name
+     *                                * \SplFileInfo
+     *                                * \Symfony\Component\Finder\Finder
+     * @param null|Analysis $analysis custom analysis instance
+     * @param bool          $validate flag to enable/disable validation of the returned spec
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">generate</span><span class="token punctuation">(</span><span class="token keyword type-hint">iterable</span> <span class="token variable">$sources</span><span class="token punctuation">,</span> <span class="token operator">?</span><span class="token class-name type-declaration">Analysis</span> <span class="token variable">$analysis</span> <span class="token operator">=</span> <span class="token constant">null</span><span class="token punctuation">,</span> <span class="token keyword type-hint">bool</span> <span class="token variable">$validate</span> <span class="token operator">=</span> <span class="token constant boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token class-name class-name-fully-qualified return-type"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>OpenApi</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><div class="language-php"><pre><code><span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name class-name-fully-qualified"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Generator</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token operator">-&gt;</span><span class="token function">generate</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path1/to/project&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><p>For those that want to type even less and keep using a plain array to configure <code>swagger-php</code> there is also a static version:</p><div class="language-php"><pre><code><span class="token php language-php"><span class="token delimiter important">&lt;?php</span>
+<span class="token keyword">require</span><span class="token punctuation">(</span><span class="token string double-quoted-string">&quot;vendor/autoload.php&quot;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Generator</span><span class="token operator">::</span><span class="token function">scan</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;/path/to/project&#39;</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token function">header</span><span class="token punctuation">(</span><span class="token string single-quoted-string">&#39;Content-Type: application/x-yaml&#39;</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+<span class="token keyword">echo</span> <span class="token variable">$openapi</span><span class="token operator">-&gt;</span><span class="token function">toYaml</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</span></code></pre></div><p><strong>Note:</strong> While using the same name as the old <code>scan()</code> function, the <code>Generator::scan</code> method is not 100% backwards compatible.</p><div class="language-php"><pre><code>    <span class="token comment">/**
+     * Static  wrapper around `Generator::generate()`.
+     *
+     * @param iterable $sources PHP source files to scan.
+     *                          Supported sources:
+     *                          * string
+     *                          * \SplFileInfo
+     *                          * \Symfony\Component\Finder\Finder
+     * @param array    $options
+     *                          aliases:    null|array                    Defaults to `[&#39;oa&#39; =&gt; &#39;OpenApi\\Annotations&#39;]`.
+     *                          namespaces: null|array                    Defaults to `[&#39;OpenApi\\Annotations\\&#39;]`.
+     *                          analyser:   null|AnalyserInterface        Defaults to a new `ReflectionAnalyser` supporting both docblocks and attributes.
+     *                          analysis:   null|Analysis                 Defaults to a new `Analysis`.
+     *                          processors: null|array                    Defaults to `Analysis::processors()`.
+     *                          logger:     null|\Psr\Log\LoggerInterface If not set logging will use \OpenApi\Logger as before.
+     *                          validate:   bool                          Defaults to `true`.
+     *                          version:    string                        Defaults to `\OpenApi\Annotations\OpenApi::VERSION_3_0_0`. Alternatives are: `\OpenApi\Annotations\OpenApi::VERSION_3_1_0`.
+     */</span>
+    <span class="token keyword">public</span> <span class="token keyword">static</span> <span class="token keyword">function</span> <span class="token function-definition function">scan</span><span class="token punctuation">(</span><span class="token keyword type-hint">iterable</span> <span class="token variable">$sources</span><span class="token punctuation">,</span> <span class="token keyword type-hint">array</span> <span class="token variable">$options</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token class-name return-type">OpenApi</span> <span class="token punctuation">{</span> <span class="token comment">/* ... */</span> <span class="token punctuation">}</span>
+</code></pre></div><p>Most notably the <code>exclude</code> and <code>pattern</code> keys are no longer supported. Instead, a Symfony <code>Finder</code> instance can be passed in as source directly (same as with <code>Generator::generate()</code>).</p><p>If needed, the <code>\OpenApi\Util</code> class provides a builder method that allows to keep the status-quo</p><div class="language-php"><pre><code><span class="token variable">$exclude</span> <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;tests&#39;</span><span class="token punctuation">]</span><span class="token punctuation">;</span>
+<span class="token variable">$pattern</span> <span class="token operator">=</span> <span class="token string single-quoted-string">&#39;*.php&#39;</span><span class="token punctuation">;</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Generator</span><span class="token operator">::</span><span class="token function">scan</span><span class="token punctuation">(</span><span class="token class-name class-name-fully-qualified static-context"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>Util</span><span class="token operator">::</span><span class="token function">finder</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">,</span> <span class="token variable">$exclude</span><span class="token punctuation">,</span> <span class="token variable">$pattern</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+
+<span class="token comment">// same as</span>
+
+<span class="token variable">$openapi</span> <span class="token operator">=</span> <span class="token function"><span class="token punctuation">\</span>OpenApi<span class="token punctuation">\</span>scan</span><span class="token punctuation">(</span><span class="token constant">__DIR__</span><span class="token punctuation">,</span> <span class="token punctuation">[</span><span class="token string single-quoted-string">&#39;exclude&#39;</span> <span class="token operator">=&gt;</span> <span class="token variable">$exclude</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">&#39;pattern&#39;</span> <span class="token operator">=&gt;</span> <span class="token variable">$pattern</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/reference/annotations" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Annotations</span></a></div><div class="next" data-v-e65a9748><a class="link" href="/swagger-php/reference/processors" data-v-e65a9748><span class="text" data-v-e65a9748>Processors</span><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-next" data-v-e65a9748><path d="M19.9,12.4c0.1-0.2,0.1-0.5,0-0.8c-0.1-0.1-0.1-0.2-0.2-0.3l-7-7c-0.4-0.4-1-0.4-1.4,0s-0.4,1,0,1.4l5.3,5.3H5c-0.6,0-1,0.4-1,1s0.4,1,1,1h11.6l-5.3,5.3c-0.4,0.4-0.4,1,0,1.4c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3l7-7C19.8,12.6,19.9,12.5,19.9,12.4z"></path></svg></a></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/reference/index.html b/reference/index.html
new file mode 100644
index 00000000..ef667ddf
--- /dev/null
+++ b/reference/index.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Reference | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/reference_index.md.05295186.lean.js">
+    
+    <meta name="twitter:title" content="Reference | Swagger-PHP">
+  <meta property="og:title" content="Reference | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Reference</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/annotations">Annotations</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Api</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/generator">Generator</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/processors">Processors</a><!----></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="reference" tabindex="-1">Reference <a class="header-anchor" href="#reference" aria-hidden="true">#</a></h1><p>In total there are a number of different aspects to using <code>swagger-php</code>. Depending on how custom your requirements are this might be limited to just annotating your code and using the command line tool.</p><p>However, <code>swagger-php</code> offers more.</p><ul><li><p><a href="./attributes.html">Attributes</a></p><p>The new way of adding meta-data to your codebase. Requires PHP 8.1</p></li><li><p><a href="./annotations.html">Docblock annotations</a></p><p>The &#39;traditional&#39; way of documenting your API.</p></li><li><p>The <a href="./generator.html"><code>Generator</code></a></p><p>The <code>\OpenAPI\Generator</code> class is the main entry point to programmatically generate OpenAPI documents from your code.</p></li><li><p><a href="./processors.html">Processors</a></p><p><code>swagger-php</code> comes with a list of pre-defined processors that convert the raw data to a complete OpenAPI document. Custom processors can be added or existing removed to tweak swagger-php` to your requirements.</p></li></ul></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><!----><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/reference/processors.html b/reference/processors.html
new file mode 100644
index 00000000..d4e9fa5c
--- /dev/null
+++ b/reference/processors.html
@@ -0,0 +1,33 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Processor Reference | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/reference_processors.md.40e47002.lean.js">
+    
+    <meta name="twitter:title" content="Processor Reference | Swagger-PHP">
+  <meta property="og:title" content="Processor Reference | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item active" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><ul class="sidebar-links" data-v-17c48e2f><!--[--><li class="sidebar-link"><p class="sidebar-link-item">Reference</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/attributes">Attributes</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/annotations">Annotations</a><!----></li></ul></li><li class="sidebar-link"><p class="sidebar-link-item">Api</p><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="/swagger-php/reference/generator">Generator</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item active" href="/swagger-php/reference/processors">Processors</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#processor-configuration">Processor Configuration</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#command-line">Command line</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#programmatically-with-php">Programmatically with PHP</a><!----></li></ul></li><li class="sidebar-link"><a class="sidebar-link-item" href="#default-processors">Default Processors</a><ul class="sidebar-links"><li class="sidebar-link"><a class="sidebar-link-item" href="#docblockdescriptions">DocBlockDescriptions</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mergeintoopenapi">MergeIntoOpenApi</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mergeintocomponents">MergeIntoComponents</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#expandclasses">ExpandClasses</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#expandinterfaces">ExpandInterfaces</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#expandtraits">ExpandTraits</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#expandenums">ExpandEnums</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#augmentschemas">AugmentSchemas</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#augmentrequestbody">AugmentRequestBody</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#augmentproperties">AugmentProperties</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#buildpaths">BuildPaths</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#augmentparameters">AugmentParameters</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#augmentrefs">AugmentRefs</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mergejsoncontent">MergeJsonContent</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#mergexmlcontent">MergeXmlContent</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#operationid">OperationId</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#augmenttags">AugmentTags</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#cleanunmerged">CleanUnmerged</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#pathfilter">PathFilter</a><!----></li><li class="sidebar-link"><a class="sidebar-link-item" href="#cleanunusedcomponents">CleanUnusedComponents</a><!----></li></ul></li></ul></li></ul></li><!--]--></ul><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="processor-reference" tabindex="-1">Processor Reference <a class="header-anchor" href="#processor-reference" aria-hidden="true">#</a></h1><p>This page is generated automatically from the <code>swagger-php</code> sources.</p><p>For improvements head over to <a href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer">GitHub</a> and create a PR 😉</p><p><em>Processors are listed in the default order of execution.</em></p><h2 id="processor-configuration" tabindex="-1">Processor Configuration <a class="header-anchor" href="#processor-configuration" aria-hidden="true">#</a></h2><h3 id="command-line" tabindex="-1">Command line <a class="header-anchor" href="#command-line" aria-hidden="true">#</a></h3><p>The <code>-c</code> option allows to specify a name/value pair with the name consisting of the processor name (starting lowercase) and option name separated by a dot (<code>.</code>).</p><div class="language-shell"><pre><code><span class="token operator">&gt;</span> ./bin/openapi <span class="token parameter variable">-c</span> <span class="token assign-left variable">operatinId.hash</span><span class="token operator">=</span>true // <span class="token punctuation">..</span>.
+<span class="token operator">&gt;</span> ./bin/openapi <span class="token parameter variable">-c</span> pathFilter.tags<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token operator">=</span>/pets/ <span class="token parameter variable">-c</span> pathFilter.tags<span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token operator">=</span>/store/ // <span class="token punctuation">..</span>.
+</code></pre></div><h3 id="programmatically-with-php" tabindex="-1">Programmatically with PHP <a class="header-anchor" href="#programmatically-with-php" aria-hidden="true">#</a></h3><p>Configuration can be set using the <code>Generator::setConfig()</code> method. Keys can either be the same as on the command line or be broken down into nested arrays.</p><div class="language-php"><pre><code><span class="token punctuation">(</span><span class="token keyword">new</span> <span class="token class-name">Generator</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
+    <span class="token operator">-&gt;</span><span class="token function">setConfig</span><span class="token punctuation">(</span><span class="token punctuation">[</span>
+        <span class="token string single-quoted-string">&#39;operationId.hash&#39;</span> <span class="token operator">=&gt;</span> <span class="token constant boolean">true</span><span class="token punctuation">,</span>
+        <span class="token string single-quoted-string">&#39;pathFilter&#39;</span> <span class="token operator">=&gt;</span> <span class="token punctuation">[</span>
+            <span class="token string single-quoted-string">&#39;tags&#39;</span> <span class="token operator">=&gt;</span> <span class="token punctuation">[</span>
+                <span class="token string single-quoted-string">&#39;/pets/&#39;</span><span class="token punctuation">,</span>
+                <span class="token string single-quoted-string">&#39;/store/&#39;</span><span class="token punctuation">,</span>
+            <span class="token punctuation">]</span><span class="token punctuation">,</span>
+        <span class="token punctuation">]</span><span class="token punctuation">,</span>
+    <span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
+</code></pre></div><h2 id="default-processors" tabindex="-1">Default Processors <a class="header-anchor" href="#default-processors" aria-hidden="true">#</a></h2><h3 id="docblockdescriptions" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/DocBlockDescriptions.php" target="_blank" rel="noopener noreferrer">DocBlockDescriptions</a> <a class="header-anchor" href="#docblockdescriptions" aria-hidden="true">#</a></h3><p>Checks if the annotation has a summary and/or description property and uses the text in the comment block (above the annotations) as summary and/or description.</p><p>Use <code>null</code>, for example: <code>@Annotation(description=null)</code>, if you don&#39;t want the annotation to have a description.</p><h3 id="mergeintoopenapi" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeIntoOpenApi.php" target="_blank" rel="noopener noreferrer">MergeIntoOpenApi</a> <a class="header-anchor" href="#mergeintoopenapi" aria-hidden="true">#</a></h3><p>Merge all @OA\OpenApi annotations into one.</p><h3 id="mergeintocomponents" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeIntoComponents.php" target="_blank" rel="noopener noreferrer">MergeIntoComponents</a> <a class="header-anchor" href="#mergeintocomponents" aria-hidden="true">#</a></h3><p>Merge reusable annotation into @OA\Schemas.</p><h3 id="expandclasses" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandClasses.php" target="_blank" rel="noopener noreferrer">ExpandClasses</a> <a class="header-anchor" href="#expandclasses" aria-hidden="true">#</a></h3><p>Iterate over the chain of ancestors of a schema and:</p><ul><li>if the ancestor has a schema =&gt; inherit from the ancestor if it has a schema (allOf) and stop.</li><li>else =&gt; merge ancestor properties into the schema.</li></ul><h3 id="expandinterfaces" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandInterfaces.php" target="_blank" rel="noopener noreferrer">ExpandInterfaces</a> <a class="header-anchor" href="#expandinterfaces" aria-hidden="true">#</a></h3><p>Look at all (direct) interfaces for a schema and:</p><ul><li>merge interfaces annotations/methods into the schema if the interface does not have a schema itself</li><li>inherit from the interface if it has a schema (allOf).</li></ul><h3 id="expandtraits" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandTraits.php" target="_blank" rel="noopener noreferrer">ExpandTraits</a> <a class="header-anchor" href="#expandtraits" aria-hidden="true">#</a></h3><p>Look at all (direct) traits for a schema and:</p><ul><li>merge trait annotations/methods/properties into the schema if the trait does not have a schema itself</li><li>inherit from the trait if it has a schema (allOf).</li></ul><h3 id="expandenums" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/ExpandEnums.php" target="_blank" rel="noopener noreferrer">ExpandEnums</a> <a class="header-anchor" href="#expandenums" aria-hidden="true">#</a></h3><p>Expands PHP enums.</p><p>Determines <code>schema</code>, <code>enum</code> and <code>type</code>.</p><h3 id="augmentschemas" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentSchemas.php" target="_blank" rel="noopener noreferrer">AugmentSchemas</a> <a class="header-anchor" href="#augmentschemas" aria-hidden="true">#</a></h3><p>Use the Schema context to extract useful information and inject that into the annotation.</p><p>Merges properties.</p><h3 id="augmentrequestbody" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentRequestBody.php" target="_blank" rel="noopener noreferrer">AugmentRequestBody</a> <a class="header-anchor" href="#augmentrequestbody" aria-hidden="true">#</a></h3><p>Use the RequestBody context to extract useful information and inject that into the annotation.</p><h3 id="augmentproperties" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentProperties.php" target="_blank" rel="noopener noreferrer">AugmentProperties</a> <a class="header-anchor" href="#augmentproperties" aria-hidden="true">#</a></h3><p>Use the property context to extract useful information and inject that into the annotation.</p><h3 id="buildpaths" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/BuildPaths.php" target="_blank" rel="noopener noreferrer">BuildPaths</a> <a class="header-anchor" href="#buildpaths" aria-hidden="true">#</a></h3><p>Build the openapi-&gt;paths using the detected <code>@OA\PathItem</code> and <code>@OA\Operation</code> (<code>@OA\Get</code>, <code>@OA\Post</code>, etc).</p><h3 id="augmentparameters" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentParameters.php" target="_blank" rel="noopener noreferrer">AugmentParameters</a> <a class="header-anchor" href="#augmentparameters" aria-hidden="true">#</a></h3><p>Augments shared and operations parameters from docblock comments.</p><h4 id="config-settings" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings" aria-hidden="true">#</a></h4><dl><dt><strong>augmentParameters.augmentOperationParameters</strong> : <span style="font-family:monospace;">bool</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">true</span></dt><dd><p>If set to <code>true</code> try to find operation parameter descriptions in the operation docblock.</p></dd></dl><h3 id="augmentrefs" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentRefs.php" target="_blank" rel="noopener noreferrer">AugmentRefs</a> <a class="header-anchor" href="#augmentrefs" aria-hidden="true">#</a></h3><h3 id="mergejsoncontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeJsonContent.php" target="_blank" rel="noopener noreferrer">MergeJsonContent</a> <a class="header-anchor" href="#mergejsoncontent" aria-hidden="true">#</a></h3><p>Split JsonContent into Schema and MediaType.</p><h3 id="mergexmlcontent" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/MergeXmlContent.php" target="_blank" rel="noopener noreferrer">MergeXmlContent</a> <a class="header-anchor" href="#mergexmlcontent" aria-hidden="true">#</a></h3><p>Split XmlContent into Schema and MediaType.</p><h3 id="operationid" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/OperationId.php" target="_blank" rel="noopener noreferrer">OperationId</a> <a class="header-anchor" href="#operationid" aria-hidden="true">#</a></h3><p>Generate the OperationId based on the context of the OpenApi annotation.</p><h4 id="config-settings-1" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings-1" aria-hidden="true">#</a></h4><dl><dt><strong>operationId.hash</strong> : <span style="font-family:monospace;">bool</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">true</span></dt><dd><p>If set to <code>true</code> generate ids (md5) instead of clear text operation ids.</p></dd></dl><h3 id="augmenttags" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/AugmentTags.php" target="_blank" rel="noopener noreferrer">AugmentTags</a> <a class="header-anchor" href="#augmenttags" aria-hidden="true">#</a></h3><p>Ensures that all tags used on operations also exist in the global <code>tags</code> list.</p><h3 id="cleanunmerged" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/CleanUnmerged.php" target="_blank" rel="noopener noreferrer">CleanUnmerged</a> <a class="header-anchor" href="#cleanunmerged" aria-hidden="true">#</a></h3><h3 id="pathfilter" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/PathFilter.php" target="_blank" rel="noopener noreferrer">PathFilter</a> <a class="header-anchor" href="#pathfilter" aria-hidden="true">#</a></h3><p>Allows to filter endpoints based on tags and/or path.</p><p>If no <code>tags</code> or <code>paths</code> filters are set, no filtering is performed. All filter (regular) expressions must be enclosed within delimiter characters as they are used as-is.</p><h4 id="config-settings-2" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings-2" aria-hidden="true">#</a></h4><dl><dt><strong>pathFilter.tags</strong> : <span style="font-family:monospace;">array</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">[]</span></dt><dd><p>A list of regular expressions to match <code>tags</code> to include.</p></dd></dl><dl><dt><strong>pathFilter.paths</strong> : <span style="font-family:monospace;">array</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">[]</span></dt><dd><p>A list of regular expressions to match <code>paths</code> to include.</p></dd></dl><h3 id="cleanunusedcomponents" tabindex="-1"><a href="https://github.com/zircote/swagger-php/tree/master/src/Processors/CleanUnusedComponents.php" target="_blank" rel="noopener noreferrer">CleanUnusedComponents</a> <a class="header-anchor" href="#cleanunusedcomponents" aria-hidden="true">#</a></h3><p>Tracks the use of all <code>Components</code> and removed unused schemas.</p><h4 id="config-settings-3" tabindex="-1">Config settings <a class="header-anchor" href="#config-settings-3" aria-hidden="true">#</a></h4><dl><dt><strong>cleanUnusedComponents.enabled</strong> : <span style="font-family:monospace;">bool</span></dt><dt><strong>default</strong> : <span style="font-family:monospace;">false</span></dt><dd><p>Enables/disables the <code>CleanUnusedComponents</code> processor.</p></dd></dl></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><div class="next-and-prev-link" data-v-8fcebc32 data-v-e65a9748><div class="container" data-v-e65a9748><div class="prev" data-v-e65a9748><a class="link" href="/swagger-php/reference/generator" data-v-e65a9748><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 24 24" class="icon icon-prev" data-v-e65a9748><path d="M19,11H7.4l5.3-5.3c0.4-0.4,0.4-1,0-1.4s-1-0.4-1.4,0l-7,7c-0.1,0.1-0.2,0.2-0.2,0.3c-0.1,0.2-0.1,0.5,0,0.8c0.1,0.1,0.1,0.2,0.2,0.3l7,7c0.2,0.2,0.5,0.3,0.7,0.3s0.5-0.1,0.7-0.3c0.4-0.4,0.4-1,0-1.4L7.4,13H19c0.6,0,1-0.4,1-1S19.6,11,19,11z"></path></svg><span class="text" data-v-e65a9748>Generator</span></a></div><div class="next" data-v-e65a9748><!----></div></div></div><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/related-projects.html b/related-projects.html
new file mode 100644
index 00000000..e757c114
--- /dev/null
+++ b/related-projects.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Related projects | Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/related-projects.md.cb587093.lean.js">
+    
+    <meta name="twitter:title" content="Related projects | Swagger-PHP">
+  <meta property="og:title" content="Related projects | Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="no-sidebar theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><!----><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><h1 id="related-projects" tabindex="-1">Related projects <a class="header-anchor" href="#related-projects" aria-hidden="true">#</a></h1><table><thead><tr><th>Project</th><th>Description</th></tr></thead><tbody><tr><td><a href="https://swagger.io/tools/swagger-ui/" target="_blank" rel="noopener noreferrer">Swagger UI</a></td><td>The webinterface for reading the generated documentation</td></tr><tr><td><a href="https://bfanger.nl/swagger-explained/" target="_blank" rel="noopener noreferrer">Swagger Explained</a></td><td>Browse the spec by using an swagger.json.</td></tr><tr><td><a href="https://github.com/DerManoMann/silex2swagger" target="_blank" rel="noopener noreferrer">silex2swagger</a></td><td>Generate swagger documentation from Silex Annotations</td></tr><tr><td><a href="https://github.com/lichunqiang/yii2-swagger" target="_blank" rel="noopener noreferrer">yii2-swagger</a></td><td>swagger-php integration with yii2</td></tr><tr><td><a href="https://github.com/DarkaOnLine/SwaggerLume" target="_blank" rel="noopener noreferrer">Lumen swagger</a></td><td>swagger-php integration with lumen/laravel</td></tr><tr><td><a href="https://github.com/nelmio/NelmioApiDocBundle" target="_blank" rel="noopener noreferrer">NelmioApiDocBundle</a></td><td>Symfony bundle on top of swagger-php</td></tr><tr><td><a href="https://github.com/kevupton/auto-swagger-ui" target="_blank" rel="noopener noreferrer">auto-swagger-ui</a></td><td>Automatically add swagger ui and json to your application</td></tr><tr><td><a href="https://github.com/DerManoMann/openapi-router" target="_blank" rel="noopener noreferrer">openapi-router</a></td><td>Configure framework routes from OpenApi annotations</td></tr><tr><td><a href="https://github.com/DerManoMann/openapi-verifier" target="_blank" rel="noopener noreferrer">openapi-verifier</a></td><td>Verify response against OpenAPI specification in PHPUnit</td></tr><tr><td><a href="https://github.com/Mermade/openapi-filter" target="_blank" rel="noopener noreferrer">openapi-filter</a></td><td>Filter internal paths, operations, parameters, etc</td></tr><tr><td><a href="https://github.com/Tobion/OpenAPI-Symfony-Routing" target="_blank" rel="noopener noreferrer">OpenAPI-Symfony-Routing</a></td><td>Load routes in Symfony based on OpenAPI annotations</td></tr><tr><td><a href="https://kizu514.com/swagit.php" target="_blank" rel="noopener noreferrer">Swag It PHP</a></td><td>Convert JSON to PHP Swagger annotations</td></tr><tr><td><a href="https://github.com/DarkaOnLine/L5-Swagger" target="_blank" rel="noopener noreferrer">Laravel Swagger</a></td><td>OpenApi or Swagger integration to Laravel</td></tr><tr><td><a href="https://github.com/DerManoMann/openapi-extras" target="_blank" rel="noopener noreferrer">openapi-extras</a></td><td>Extra annotations for swagger-php</td></tr><tr><td><a href="https://github.com/MattyRad/openapi-serialize" target="_blank" rel="noopener noreferrer">openapi-serialize</a></td><td>Serialize an object using swagger-php</td></tr></tbody></table><p>Is a related project missing? Create a pull request!</p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><!----><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/snippets/preamble_annotations.html b/snippets/preamble_annotations.html
new file mode 100644
index 00000000..afbbd685
--- /dev/null
+++ b/snippets/preamble_annotations.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/snippets_preamble_annotations.md.bb82314f.lean.js">
+    
+    <meta name="twitter:title" content="Swagger-PHP">
+  <meta property="og:title" content="Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><!----><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><p>In addition to this page, there are also a number of <a href="https://github.com/zircote/swagger-php/tree/master/Examples#readme" target="_blank" rel="noopener noreferrer">examples</a> which might help you out.</p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><!----><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/snippets/preamble_attributes.html b/snippets/preamble_attributes.html
new file mode 100644
index 00000000..2978c2fc
--- /dev/null
+++ b/snippets/preamble_attributes.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/snippets_preamble_attributes.md.b131e034.lean.js">
+    
+    <meta name="twitter:title" content="Swagger-PHP">
+  <meta property="og:title" content="Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><!----><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><p>In addition to this page, there are also a number of <a href="https://github.com/zircote/swagger-php/tree/master/Examples#readme" target="_blank" rel="noopener noreferrer">examples</a> which might help you out.</p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><!----><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file
diff --git a/snippets/preamble_processors.html b/snippets/preamble_processors.html
new file mode 100644
index 00000000..891a676a
--- /dev/null
+++ b/snippets/preamble_processors.html
@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en-US">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Swagger-PHP</title>
+    <meta name="description" content="Generate OpenAPI documentation for your RESTful API.">
+    <link rel="stylesheet" href="/swagger-php/assets/style.29d805fc.css">
+    <link rel="modulepreload" href="/swagger-php/assets/app.850f5e05.js">
+    <link rel="modulepreload" href="/swagger-php/assets/snippets_preamble_processors.md.309ada33.lean.js">
+    
+    <meta name="twitter:title" content="Swagger-PHP">
+  <meta property="og:title" content="Swagger-PHP">
+  </head>
+  <body>
+    <div id="app"><!--[--><div class="theme"><header class="nav-bar" data-v-40587210><div class="sidebar-button" data-v-40587210><svg class="icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z" class></path></svg></div><a class="nav-bar-title" href="/swagger-php/" aria-label="Swagger-PHP, back to home" data-v-40587210 data-v-016a8bd8><!----> Swagger-PHP</a><div class="flex-grow" data-v-40587210></div><div class="nav" data-v-40587210><nav class="nav-links" data-v-40587210 data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav></div><!--[--><!--]--></header><aside class="sidebar" data-v-17c48e2f><nav class="nav-links nav" data-v-17c48e2f data-v-35b91e7e><!--[--><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/guide/" data-v-49fe041d>User Guide <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item" href="/swagger-php/reference/" data-v-49fe041d>Reference <!----></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://learn.openapis.org/" target="_blank" rel="noopener noreferrer" data-v-49fe041d>OpenApi <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php/releases" target="_blank" rel="noopener noreferrer" data-v-49fe041d>Releases <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div><!--]--><!----><div class="item" data-v-35b91e7e><div class="nav-link" data-v-35b91e7e data-v-49fe041d><a class="item isExternal" href="https://github.com/zircote/swagger-php" target="_blank" rel="noopener noreferrer" data-v-49fe041d>GitHub <svg class="icon outbound" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewbox="0 0 100 100" width="15" height="15" data-v-49fe041d><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div></div></nav><!--[--><!--]--><!----><!--[--><!--]--></aside><div class="sidebar-mask"></div><main class="page" data-v-8fcebc32><div class="container" data-v-8fcebc32><!--[--><!--]--><div style="position:relative;" class="content" data-v-8fcebc32><div><p><em>Processors are listed in the default order of execution.</em></p></div></div><footer class="page-footer" data-v-8fcebc32 data-v-b65b4b36><div class="edit" data-v-b65b4b36><div class="edit-link" data-v-b65b4b36 data-v-55695e90><!----></div></div><div class="updated" data-v-b65b4b36><!----></div></footer><!----><!--[--><!--]--></div></main></div><!----><!--]--></div>
+    <script>__VP_HASH_MAP__ = JSON.parse("{\"guide_annotations.md\":\"8cc52798\",\"guide_attributes.md\":\"3e0b725a\",\"guide_common-techniques.md\":\"e2af46b9\",\"guide_cookbook.md\":\"2d416869\",\"guide_faq.md\":\"b1f45c64\",\"guide_generating-openapi-documents.md\":\"9bb1fdd6\",\"guide_index.md\":\"29bf901a\",\"guide_installation.md\":\"34074778\",\"guide_migrating-to-v3.md\":\"549bb338\",\"guide_migrating-to-v4.md\":\"714a0f1b\",\"guide_required-elements.md\":\"ef909293\",\"guide_under-the-hood.md\":\"58a1fa15\",\"index.md\":\"56757007\",\"reference_annotations.md\":\"93df9735\",\"reference_attributes.md\":\"0f7b8389\",\"reference_generator.md\":\"857d4ce7\",\"reference_index.md\":\"05295186\",\"reference_processors.md\":\"40e47002\",\"related-projects.md\":\"cb587093\",\"snippets_preamble_annotations.md\":\"bb82314f\",\"snippets_preamble_attributes.md\":\"b131e034\",\"snippets_preamble_processors.md\":\"309ada33\"}")</script>
+    <script type="module" async src="/swagger-php/assets/app.850f5e05.js"></script>
+    
+  </body>
+</html>
\ No newline at end of file