effect 4.0.0-beta.70 → 4.0.0-beta.72

package/dist/unstable/httpapi/HttpApiSchema.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSchema.js","names":["constVoid","Schema","AST","Transformation","hasBody","statusCodeByLiteral","Continue","SwitchingProtocols","Processing","EarlyHints","OK","Ok","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","ImUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","PayloadTooLarge","UriTooLong","UnsupportedMediaType","RangeNotSatisfiable","ExpectationFailed","ImATeapot","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","TooEarly","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired","status","code","statusCode","self","annotate","httpApiStatus","Empty","Void","pipe","asNoContent","options","decodeTo","toType","transform","decode","encode","MultipartTypeId","asMultipart","brand","_tag","mode","contentType","defaultContentType","limits","MultipartStreamTypeId","asMultipartStream","asNonMultipartEncoding","asJson","asFormUrlEncoded","asText","asUint8Array","isNoContent","ast","isVoid","encoded","toEncoded","target","encoding","to","undefined","resolveHttpApiEncoding","resolveAt","resolveHttpApiStatus","defaultJsonEncoding","defaultUrlEncodedEncoding","getEncoding","getPayloadEncoding","method","getResponseEncoding","out","Error","getStatusSuccess","getStatusError"],"sources":["../../../src/unstable/httpapi/HttpApiSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwCA,SAASA,SAAS,QAAsB,mBAAmB;AAC3D,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,GAAG,MAAM,oBAAoB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAC/D,SAASC,OAAO,QAAyB,uBAAuB;AA+ChE,MAAMC,mBAAmB,GAAG;EAC1BC,QAAQ,EAAE,GAAG;EACbC,kBAAkB,EAAE,GAAG;EACvBC,UAAU,EAAE,GAAG;EACfC,UAAU,EAAE,GAAG;EACfC,EAAE,EAAE,GAAG;EACPC,EAAE,EAAE,GAAG;EACPC,OAAO,EAAE,GAAG;EACZC,QAAQ,EAAE,GAAG;EACbC,2BAA2B,EAAE,GAAG;EAChCC,SAAS,EAAE,GAAG;EACdC,YAAY,EAAE,GAAG;EACjBC,cAAc,EAAE,GAAG;EACnBC,WAAW,EAAE,GAAG;EAChBC,eAAe,EAAE,GAAG;EACpBC,MAAM,EAAE,GAAG;EACXC,eAAe,EAAE,GAAG;EACpBC,gBAAgB,EAAE,GAAG;EACrBC,KAAK,EAAE,GAAG;EACVC,QAAQ,EAAE,GAAG;EACbC,WAAW,EAAE,GAAG;EAChBC,iBAAiB,EAAE,GAAG;EACtBC,iBAAiB,EAAE,GAAG;EACtBC,UAAU,EAAE,GAAG;EACfC,YAAY,EAAE,GAAG;EACjBC,eAAe,EAAE,GAAG;EACpBC,SAAS,EAAE,GAAG;EACdC,QAAQ,EAAE,GAAG;EACbC,gBAAgB,EAAE,GAAG;EACrBC,aAAa,EAAE,GAAG;EAClBC,2BAA2B,EAAE,GAAG;EAChCC,cAAc,EAAE,GAAG;EACnBC,QAAQ,EAAE,GAAG;EACbC,IAAI,EAAE,GAAG;EACTC,cAAc,EAAE,GAAG;EACnBC,kBAAkB,EAAE,GAAG;EACvBC,eAAe,EAAE,GAAG;EACpBC,UAAU,EAAE,GAAG;EACfC,oBAAoB,EAAE,GAAG;EACzBC,mBAAmB,EAAE,GAAG;EACxBC,iBAAiB,EAAE,GAAG;EACtBC,SAAS,EAAE,GAAG;EACdC,kBAAkB,EAAE,GAAG;EACvBC,mBAAmB,EAAE,GAAG;EACxBC,MAAM,EAAE,GAAG;EACXC,gBAAgB,EAAE,GAAG;EACrBC,QAAQ,EAAE,GAAG;EACbC,eAAe,EAAE,GAAG;EACpBC,oBAAoB,EAAE,GAAG;EACzBC,eAAe,EAAE,GAAG;EACpBC,2BAA2B,EAAE,GAAG;EAChCC,0BAA0B,EAAE,GAAG;EAC/BC,mBAAmB,EAAE,GAAG;EACxBC,cAAc,EAAE,GAAG;EACnBC,UAAU,EAAE,GAAG;EACfC,kBAAkB,EAAE,GAAG;EACvBC,cAAc,EAAE,GAAG;EACnBC,uBAAuB,EAAE,GAAG;EAC5BC,qBAAqB,EAAE,GAAG;EAC1BC,mBAAmB,EAAE,GAAG;EACxBC,YAAY,EAAE,GAAG;EACjBC,WAAW,EAAE,GAAG;EAChBC,6BAA6B,EAAE;CACvB;AAwBV,OAAM,SAAUC,MAAMA,CAACC,IAA4B;EACjD,MAAMC,UAAU,GAAG,OAAOD,IAAI,KAAK,QAAQ,GAAGhE,mBAAmB,CAACgE,IAAI,CAAC,GAAGA,IAAI;EAC9E,OAA8BE,IAAO,IAAkB;IACrD,OAAOA,IAAI,CAACC,QAAQ,CAAC;MAAEC,aAAa,EAAEH;IAAU,CAAE,CAAC;EACrD,CAAC;AACH;AAEA;;;;;;;;;AASA,OAAO,MAAMI,KAAK,GAAIL,IAAY,IAAkBpE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CAACR,MAAM,CAACC,IAAI,CAAC,CAAC;AAUlF;;;;;;;AAOA,OAAO,MAAMtD,SAAS,gBAAc2D,KAAK,CAAC,GAAG,CAAC;AAU9C;;;;;;;AAOA,OAAO,MAAM9D,OAAO,gBAAY8D,KAAK,CAAC,GAAG,CAAC;AAU1C;;;;;;;AAOA,OAAO,MAAM7D,QAAQ,gBAAa6D,KAAK,CAAC,GAAG,CAAC;AAU5C;;;;;;;;;;;;;;AAcA,OAAM,SAAUG,WAAWA,CAAuBC,OAEjD;EACC,OAAQP,IAAO,IAAoB;IACjC,OAAOtE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CACrB3E,MAAM,CAAC8E,QAAQ,CACb9E,MAAM,CAAC+E,MAAM,CAACT,IAAI,CAAC,EACnBpE,cAAc,CAAC8E,SAAS,CAAC;MACvBC,MAAM,EAAEJ,OAAO,CAACI,MAAM;MACtBC,MAAM,EAAEnF;KACT,CAAC,CACH,CACF;EACH,CAAC;AACH;AAEA;;;;;;AAMA,OAAO,MAAMoF,eAAe,GAAG,yCAAyC;AAkBxE;;;;;;;;AAQA,OAAM,SAAUC,WAAWA,CAACP,OAAuC;EACjE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACF,eAAe,CAAC,CAAC,CAACZ,QAAQ,CAAC;IAChD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,UAAU;MAChBC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA;;;;;;AAMA,OAAO,MAAMc,qBAAqB,GAAG,+CAA+C;AAkBpF;;;;;;;;AAQA,OAAM,SAAUC,iBAAiBA,CAACf,OAAuC;EACvE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACM,qBAAqB,CAAC,CAAC,CAACpB,QAAQ,CAAC;IACtD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,QAAQ;MACdC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA,SAASgB,sBAAsBA,CAAuBvB,IAAO,EAAEO,OAG9D;EACC,OAAOP,IAAI,CAACC,QAAQ,CAAC;IACnB,kBAAkB,EAAE;MAClBe,IAAI,EAAET,OAAO,CAACS,IAAI;MAClBE,WAAW,EAAEX,OAAO,CAACW,WAAW,IAAIC,kBAAkB,CAACZ,OAAO,CAACS,IAAI;;GAEtE,CAAC;AACJ;AAEA,SAASG,kBAAkBA,CAACH,IAAsB;EAChD,QAAQA,IAAI;IACV,KAAK,WAAW;MACd,OAAO,qBAAqB;IAC9B,KAAK,MAAM;MACT,OAAO,kBAAkB;IAC3B,KAAK,gBAAgB;MACnB,OAAO,mCAAmC;IAC5C,KAAK,YAAY;MACf,OAAO,0BAA0B;IACnC,KAAK,MAAM;MACT,OAAO,YAAY;EACvB;AACF;AAEA;;;;;;AAMA,OAAM,SAAUQ,MAAMA,CAACjB,OAEtB;EACC,OAA8BP,IAAO,IAAKuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AACtG;AAEA;;;;;;;;;;AAUA,OAAM,SAAUkB,gBAAgBA,CAAClB,OAEhC;EACC,OACEP,IAAO,IACJuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,gBAAgB;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC3E;AAEA;;;;;;;;;;AAUA,OAAM,SAAUmB,MAAMA,CAACnB,OAEtB;EACC,OAA6DP,IAAO,IAClEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC9D;AAEA;;;;;;;;;;AAUA,OAAM,SAAUoB,YAAYA,CAACpB,OAE5B;EACC,OAAiEP,IAAO,IACtEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,YAAY;IAAE,GAAGT;EAAO,CAAE,CAAC;AACpE;AACA;;;;;;;;;;;AAWA,OAAO,MAAMqB,WAAW,GAAIC,GAAY,IAAa;EACnD,IAAIlG,GAAG,CAACmG,MAAM,CAACD,GAAG,CAAC,EAAE,OAAO,IAAI;EAChC,MAAME,OAAO,GAAGpG,GAAG,CAACqG,SAAS,CAACH,GAAG,CAAC;EAClC,IAAIlG,GAAG,CAACmG,MAAM,CAACC,OAAO,CAAC,EAAE,OAAO,IAAI;EACpC,MAAME,MAAM,GAAGJ,GAAG,CAACK,QAAQ,GAAG,CAAC,CAAC,CAACC,EAAE;EACnC,IAAIF,MAAM,KAAKG,SAAS,EAAE,OAAO,KAAK;EACtC,OAAOzG,GAAG,CAACmG,MAAM,CAACG,MAAM,CAAC;AAC3B,CAAC;AAED,MAAMI,sBAAsB,gBAAG1G,GAAG,CAAC2G,SAAS,CAAW,kBAAkB,CAAC;AAE1E,MAAMC,oBAAoB,gBAAG5G,GAAG,CAAC2G,SAAS,CAAS,eAAe,CAAC;AAEnE,MAAME,mBAAmB,GAAa;EACpCxB,IAAI,EAAE,MAAM;EACZE,WAAW,EAAE;CACd;AACD,MAAMuB,yBAAyB,GAAa;EAC1CzB,IAAI,EAAE,gBAAgB;EACtBE,WAAW,EAAE;CACd;AAED,SAASwB,WAAWA,CAACb,GAAY;EAC/B,OAAOQ,sBAAsB,CAACR,GAAG,CAAC,IAAIW,mBAAmB;AAC3D;AAEA;AACA,OAAM,SAAUG,kBAAkBA,CAACd,GAAY,EAAEe,MAAkB;EACjE,MAAMV,QAAQ,GAAGG,sBAAsB,CAACR,GAAG,CAAC;EAC5C,IAAIK,QAAQ,EAAE,OAAOA,QAAQ;EAC7B,OAAOrG,OAAO,CAAC+G,MAAM,CAAC,GAAGJ,mBAAmB,GAAGC,yBAAyB;AAC1E;AAEA;AACA,OAAM,SAAUI,mBAAmBA,CAAChB,GAAY;EAC9C,MAAMiB,GAAG,GAAGJ,WAAW,CAACb,GAAG,CAAC;EAC5B,IAAIiB,GAAG,CAAC9B,IAAI,KAAK,WAAW,EAAE;IAC5B,MAAM,IAAI+B,KAAK,CAAC,wCAAwC,CAAC;EAC3D;EACA,OAAOD,GAAG;AACZ;AAEA;AACA,OAAM,SAAUE,gBAAgBA,CAAChD,IAAa;EAC5C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C;AAEA;AACA,OAAM,SAAUiD,cAAcA,CAACjD,IAAa;EAC1C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C","ignoreList":[]}
+{"version":3,"file":"HttpApiSchema.js","names":["constVoid","Schema","AST","Transformation","hasBody","statusCodeByLiteral","Continue","SwitchingProtocols","Processing","EarlyHints","OK","Ok","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","ImUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","TemporaryRedirect","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","PayloadTooLarge","UriTooLong","UnsupportedMediaType","RangeNotSatisfiable","ExpectationFailed","ImATeapot","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","TooEarly","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired","status","code","statusCode","self","annotate","httpApiStatus","Empty","Void","pipe","asNoContent","options","decodeTo","toType","transform","decode","encode","MultipartTypeId","asMultipart","brand","_tag","mode","contentType","defaultContentType","limits","MultipartStreamTypeId","asMultipartStream","asNonMultipartEncoding","asJson","asFormUrlEncoded","asText","asUint8Array","isNoContent","ast","isVoid","encoded","toEncoded","target","encoding","to","undefined","resolveHttpApiEncoding","resolveAt","resolveHttpApiStatus","defaultJsonEncoding","defaultUrlEncodedEncoding","getEncoding","getPayloadEncoding","method","getResponseEncoding","out","Error","getStatusSuccess","getStatusError"],"sources":["../../../src/unstable/httpapi/HttpApiSchema.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2CA,SAASA,SAAS,QAAsB,mBAAmB;AAC3D,OAAO,KAAKC,MAAM,MAAM,iBAAiB;AACzC,OAAO,KAAKC,GAAG,MAAM,oBAAoB;AACzC,OAAO,KAAKC,cAAc,MAAM,+BAA+B;AAC/D,SAASC,OAAO,QAAyB,uBAAuB;AA+ChE,MAAMC,mBAAmB,GAAG;EAC1BC,QAAQ,EAAE,GAAG;EACbC,kBAAkB,EAAE,GAAG;EACvBC,UAAU,EAAE,GAAG;EACfC,UAAU,EAAE,GAAG;EACfC,EAAE,EAAE,GAAG;EACPC,EAAE,EAAE,GAAG;EACPC,OAAO,EAAE,GAAG;EACZC,QAAQ,EAAE,GAAG;EACbC,2BAA2B,EAAE,GAAG;EAChCC,SAAS,EAAE,GAAG;EACdC,YAAY,EAAE,GAAG;EACjBC,cAAc,EAAE,GAAG;EACnBC,WAAW,EAAE,GAAG;EAChBC,eAAe,EAAE,GAAG;EACpBC,MAAM,EAAE,GAAG;EACXC,eAAe,EAAE,GAAG;EACpBC,gBAAgB,EAAE,GAAG;EACrBC,KAAK,EAAE,GAAG;EACVC,QAAQ,EAAE,GAAG;EACbC,WAAW,EAAE,GAAG;EAChBC,iBAAiB,EAAE,GAAG;EACtBC,iBAAiB,EAAE,GAAG;EACtBC,UAAU,EAAE,GAAG;EACfC,YAAY,EAAE,GAAG;EACjBC,eAAe,EAAE,GAAG;EACpBC,SAAS,EAAE,GAAG;EACdC,QAAQ,EAAE,GAAG;EACbC,gBAAgB,EAAE,GAAG;EACrBC,aAAa,EAAE,GAAG;EAClBC,2BAA2B,EAAE,GAAG;EAChCC,cAAc,EAAE,GAAG;EACnBC,QAAQ,EAAE,GAAG;EACbC,IAAI,EAAE,GAAG;EACTC,cAAc,EAAE,GAAG;EACnBC,kBAAkB,EAAE,GAAG;EACvBC,eAAe,EAAE,GAAG;EACpBC,UAAU,EAAE,GAAG;EACfC,oBAAoB,EAAE,GAAG;EACzBC,mBAAmB,EAAE,GAAG;EACxBC,iBAAiB,EAAE,GAAG;EACtBC,SAAS,EAAE,GAAG;EACdC,kBAAkB,EAAE,GAAG;EACvBC,mBAAmB,EAAE,GAAG;EACxBC,MAAM,EAAE,GAAG;EACXC,gBAAgB,EAAE,GAAG;EACrBC,QAAQ,EAAE,GAAG;EACbC,eAAe,EAAE,GAAG;EACpBC,oBAAoB,EAAE,GAAG;EACzBC,eAAe,EAAE,GAAG;EACpBC,2BAA2B,EAAE,GAAG;EAChCC,0BAA0B,EAAE,GAAG;EAC/BC,mBAAmB,EAAE,GAAG;EACxBC,cAAc,EAAE,GAAG;EACnBC,UAAU,EAAE,GAAG;EACfC,kBAAkB,EAAE,GAAG;EACvBC,cAAc,EAAE,GAAG;EACnBC,uBAAuB,EAAE,GAAG;EAC5BC,qBAAqB,EAAE,GAAG;EAC1BC,mBAAmB,EAAE,GAAG;EACxBC,YAAY,EAAE,GAAG;EACjBC,WAAW,EAAE,GAAG;EAChBC,6BAA6B,EAAE;CACvB;AAwBV,OAAM,SAAUC,MAAMA,CAACC,IAA4B;EACjD,MAAMC,UAAU,GAAG,OAAOD,IAAI,KAAK,QAAQ,GAAGhE,mBAAmB,CAACgE,IAAI,CAAC,GAAGA,IAAI;EAC9E,OAA8BE,IAAO,IAAkB;IACrD,OAAOA,IAAI,CAACC,QAAQ,CAAC;MAAEC,aAAa,EAAEH;IAAU,CAAE,CAAC;EACrD,CAAC;AACH;AAEA;;;;;;;;;AASA,OAAO,MAAMI,KAAK,GAAIL,IAAY,IAAkBpE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CAACR,MAAM,CAACC,IAAI,CAAC,CAAC;AAUlF;;;;;;AAMA,OAAO,MAAMtD,SAAS,gBAAc2D,KAAK,CAAC,GAAG,CAAC;AAU9C;;;;;;AAMA,OAAO,MAAM9D,OAAO,gBAAY8D,KAAK,CAAC,GAAG,CAAC;AAU1C;;;;;;AAMA,OAAO,MAAM7D,QAAQ,gBAAa6D,KAAK,CAAC,GAAG,CAAC;AAU5C;;;;;;;;;;;;;;AAcA,OAAM,SAAUG,WAAWA,CAAuBC,OAEjD;EACC,OAAQP,IAAO,IAAoB;IACjC,OAAOtE,MAAM,CAAC0E,IAAI,CAACC,IAAI,CACrB3E,MAAM,CAAC8E,QAAQ,CACb9E,MAAM,CAAC+E,MAAM,CAACT,IAAI,CAAC,EACnBpE,cAAc,CAAC8E,SAAS,CAAC;MACvBC,MAAM,EAAEJ,OAAO,CAACI,MAAM;MACtBC,MAAM,EAAEnF;KACT,CAAC,CACH,CACF;EACH,CAAC;AACH;AAEA;;;;;;AAMA,OAAO,MAAMoF,eAAe,GAAG,yCAAyC;AAkBxE;;;;;;;;AAQA,OAAM,SAAUC,WAAWA,CAACP,OAAuC;EACjE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACF,eAAe,CAAC,CAAC,CAACZ,QAAQ,CAAC;IAChD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,UAAU;MAChBC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA;;;;;;AAMA,OAAO,MAAMc,qBAAqB,GAAG,+CAA+C;AAkBpF;;;;;;;;AAQA,OAAM,SAAUC,iBAAiBA,CAACf,OAAuC;EACvE,OAA8BP,IAAO,IACnCA,IAAI,CAACK,IAAI,CAAC3E,MAAM,CAACqF,KAAK,CAACM,qBAAqB,CAAC,CAAC,CAACpB,QAAQ,CAAC;IACtD,kBAAkB,EAAE;MAClBe,IAAI,EAAE,WAAW;MACjBC,IAAI,EAAE,QAAQ;MACdC,WAAW,EAAEC,kBAAkB,CAAC,WAAW,CAAC;MAC5CC,MAAM,EAAEb;;GAEX,CAAC;AACN;AAEA,SAASgB,sBAAsBA,CAAuBvB,IAAO,EAAEO,OAG9D;EACC,OAAOP,IAAI,CAACC,QAAQ,CAAC;IACnB,kBAAkB,EAAE;MAClBe,IAAI,EAAET,OAAO,CAACS,IAAI;MAClBE,WAAW,EAAEX,OAAO,CAACW,WAAW,IAAIC,kBAAkB,CAACZ,OAAO,CAACS,IAAI;;GAEtE,CAAC;AACJ;AAEA,SAASG,kBAAkBA,CAACH,IAAsB;EAChD,QAAQA,IAAI;IACV,KAAK,WAAW;MACd,OAAO,qBAAqB;IAC9B,KAAK,MAAM;MACT,OAAO,kBAAkB;IAC3B,KAAK,gBAAgB;MACnB,OAAO,mCAAmC;IAC5C,KAAK,YAAY;MACf,OAAO,0BAA0B;IACnC,KAAK,MAAM;MACT,OAAO,YAAY;EACvB;AACF;AAEA;;;;;;AAMA,OAAM,SAAUQ,MAAMA,CAACjB,OAEtB;EACC,OAA8BP,IAAO,IAAKuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AACtG;AAEA;;;;;;;;;;AAUA,OAAM,SAAUkB,gBAAgBA,CAAClB,OAEhC;EACC,OACEP,IAAO,IACJuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,gBAAgB;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC3E;AAEA;;;;;;;;;;AAUA,OAAM,SAAUmB,MAAMA,CAACnB,OAEtB;EACC,OAA6DP,IAAO,IAClEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,MAAM;IAAE,GAAGT;EAAO,CAAE,CAAC;AAC9D;AAEA;;;;;;;;;;AAUA,OAAM,SAAUoB,YAAYA,CAACpB,OAE5B;EACC,OAAiEP,IAAO,IACtEuB,sBAAsB,CAACvB,IAAI,EAAE;IAAEgB,IAAI,EAAE,YAAY;IAAE,GAAGT;EAAO,CAAE,CAAC;AACpE;AACA;;;;;;;;;;;AAWA,OAAO,MAAMqB,WAAW,GAAIC,GAAY,IAAa;EACnD,IAAIlG,GAAG,CAACmG,MAAM,CAACD,GAAG,CAAC,EAAE,OAAO,IAAI;EAChC,MAAME,OAAO,GAAGpG,GAAG,CAACqG,SAAS,CAACH,GAAG,CAAC;EAClC,IAAIlG,GAAG,CAACmG,MAAM,CAACC,OAAO,CAAC,EAAE,OAAO,IAAI;EACpC,MAAME,MAAM,GAAGJ,GAAG,CAACK,QAAQ,GAAG,CAAC,CAAC,CAACC,EAAE;EACnC,IAAIF,MAAM,KAAKG,SAAS,EAAE,OAAO,KAAK;EACtC,OAAOzG,GAAG,CAACmG,MAAM,CAACG,MAAM,CAAC;AAC3B,CAAC;AAED,MAAMI,sBAAsB,gBAAG1G,GAAG,CAAC2G,SAAS,CAAW,kBAAkB,CAAC;AAE1E,MAAMC,oBAAoB,gBAAG5G,GAAG,CAAC2G,SAAS,CAAS,eAAe,CAAC;AAEnE,MAAME,mBAAmB,GAAa;EACpCxB,IAAI,EAAE,MAAM;EACZE,WAAW,EAAE;CACd;AACD,MAAMuB,yBAAyB,GAAa;EAC1CzB,IAAI,EAAE,gBAAgB;EACtBE,WAAW,EAAE;CACd;AAED,SAASwB,WAAWA,CAACb,GAAY;EAC/B,OAAOQ,sBAAsB,CAACR,GAAG,CAAC,IAAIW,mBAAmB;AAC3D;AAEA;AACA,OAAM,SAAUG,kBAAkBA,CAACd,GAAY,EAAEe,MAAkB;EACjE,MAAMV,QAAQ,GAAGG,sBAAsB,CAACR,GAAG,CAAC;EAC5C,IAAIK,QAAQ,EAAE,OAAOA,QAAQ;EAC7B,OAAOrG,OAAO,CAAC+G,MAAM,CAAC,GAAGJ,mBAAmB,GAAGC,yBAAyB;AAC1E;AAEA;AACA,OAAM,SAAUI,mBAAmBA,CAAChB,GAAY;EAC9C,MAAMiB,GAAG,GAAGJ,WAAW,CAACb,GAAG,CAAC;EAC5B,IAAIiB,GAAG,CAAC9B,IAAI,KAAK,WAAW,EAAE;IAC5B,MAAM,IAAI+B,KAAK,CAAC,wCAAwC,CAAC;EAC3D;EACA,OAAOD,GAAG;AACZ;AAEA;AACA,OAAM,SAAUE,gBAAgBA,CAAChD,IAAa;EAC5C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C;AAEA;AACA,OAAM,SAAUiD,cAAcA,CAACjD,IAAa;EAC1C,OAAOuC,oBAAoB,CAACvC,IAAI,CAAC,IAAI,GAAG;AAC1C","ignoreList":[]}

package/dist/unstable/httpapi/HttpApiSecurity.d.ts

@@ -1,28 +1,40 @@
 /**
- * The `HttpApiSecurity` module defines the security scheme values used by
- * declarative HTTP APIs.
- *
- * Use these constructors when an API group or endpoint needs authentication
- * middleware for bearer tokens, API keys, or HTTP Basic credentials. The values
- * are intentionally small declarations: `HttpApiMiddleware.Service` attaches
- * them to middleware, `HttpApiBuilder` decodes the matching credential shape from
- * each request, and OpenAPI generation emits the corresponding
- * `components.securitySchemes` and operation security requirements.
- *
- * Common uses include modeling `Authorization: Bearer ...` tokens, Basic
- * username/password credentials, and API keys passed through headers, query
- * parameters, or cookies. Bearer tokens and API-key values are exposed to
- * middleware as `Redacted` values; Basic credentials expose the username with a
- * redacted password. Cookie API keys can also be written to responses with
- * `HttpApiBuilder.securitySetCookie`.
- *
- * A security scheme does not authenticate by itself: middleware must reject empty
- * or invalid credentials. Bearer and Basic schemes read the `Authorization`
- * header, while API-key headers use HTTP header name normalization and API-key
- * query or cookie names are matched exactly. OpenAPI annotations such as
- * descriptions and bearer formats affect generated documentation only; they do
+ * Defines security scheme declarations for declarative HTTP APIs.
+ *
+ * Security schemes describe where credentials are read from and which credential
+ * type is passed to security middleware. They are consumed by
+ * `HttpApiMiddleware.Service`, `HttpApiBuilder`, generated clients, and OpenAPI
+ * generation, but they do not authenticate requests by themselves.
+ *
+ * **Mental model**
+ *
+ * Create a scheme with {@link bearer}, {@link apiKey}, or {@link basic}, attach
+ * it to middleware, and let the HTTP API builder decode the matching credential
+ * shape from each request. OpenAPI generation emits the same declaration as
+ * `components.securitySchemes` plus operation security requirements.
+ *
+ * **Common tasks**
+ *
+ * Use {@link bearer} for `Authorization: Bearer ...` tokens, {@link basic} for
+ * HTTP Basic username/password credentials, and {@link apiKey} for keys passed
+ * through headers, query parameters, or cookies. Use {@link annotate} or
+ * {@link annotateMerge} to add documentation metadata for generated OpenAPI
+ * descriptions.
+ *
+ * **Gotchas**
+ *
+ * Middleware must reject empty or invalid credentials. Bearer tokens and API-key
+ * values are delivered as `Redacted` values; Basic credentials expose the
+ * username and redact the password. Bearer and Basic schemes read the
+ * `Authorization` header, API-key headers use HTTP header name normalization,
+ * and API-key query or cookie names are matched exactly. OpenAPI annotations do
  * not change runtime decoding.
  *
+ * **See also**
+ *
+ * `HttpApiMiddleware` for implementing security checks and `HttpApiBuilder` for
+ * installing middleware and setting API-key cookies on responses.
+ *
  * @since 4.0.0
  */
 import * as Context from "../../Context.ts";
@@ -107,9 +119,16 @@ export interface Credentials {
  *
  * **When to use**
  *
+ * Use to require `Authorization: Bearer ...` credentials for an HTTP API group
+ * or endpoint.
+ *
+ * **Details**
+ *
  * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
  * security scheme.
  *
+ * @see {@link apiKey} for an API-key security scheme
+ * @see {@link basic} for an HTTP Basic security scheme
  * @category constructors
  * @since 4.0.0
  */
@@ -119,14 +138,19 @@ export declare const bearer: Bearer;
  *
  * **When to use**
  *
- * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
- * security scheme.
+ * Use to require API key credentials passed through a header, query parameter,
+ * or cookie.
  *
  * **Details**
  *
+ * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
+ * security scheme.
+ *
  * Use `HttpApiBuilder.securitySetCookie` to set the correct cookie in a
  * handler. By default, `in` is `"header"`.
  *
+ * @see {@link bearer} for a Bearer token security scheme
+ * @see {@link basic} for an HTTP Basic security scheme
  * @category constructors
  * @since 4.0.0
  */
@@ -139,9 +163,15 @@ export declare const apiKey: (options: {
  *
  * **When to use**
  *
+ * Use to require HTTP Basic username/password credentials.
+ *
+ * **Details**
+ *
  * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
  * security scheme.
  *
+ * @see {@link bearer} for a Bearer token security scheme
+ * @see {@link apiKey} for an API-key security scheme
  * @category constructors
  * @since 4.0.0
  */

package/dist/unstable/httpapi/HttpApiSecurity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSecurity.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,QAAA,MAAM,MAAM,oCAAoC,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AAErD;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC;;;;;OAKG;IACH,UAAiB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;QAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;SAC1B,CAAA;QACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC7C;IAED;;;;;OAKG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;CACvF;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AASD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,MAAM,EAAE,MAGnB,CAAA;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,MAAM,GAAI,SAAS;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;CACxD,KAAG,MAMA,CAAA;AAEJ;;;;;;;;;;GAUG;AACH,eAAO,MAAM,KAAK,EAAE,KAGlB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B;;;;;OAKG;IACH,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IAC/E;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAQ5E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IACvF;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAA;CAQpF,CAAA"}
+{"version":3,"file":"HttpApiSecurity.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAE3C,OAAO,EAAE,KAAK,QAAQ,EAAiB,MAAM,mBAAmB,CAAA;AAChE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAE/C,QAAA,MAAM,MAAM,oCAAoC,CAAA;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAA;AAErD;;;;GAIG;AACH,MAAM,CAAC,OAAO,WAAW,eAAe,CAAC;IACvC;;;;;OAKG;IACH,UAAiB,KAAK,CAAC,GAAG,CAAC,CAAC,CAAE,SAAQ,QAAQ;QAC5C,QAAQ,CAAC,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC,CAAC,CAAA;SAC1B,CAAA;QACD,QAAQ,CAAC,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;KAC7C;IAED;;;;;OAKG;IACH,KAAY,IAAI,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,KAAK,CAAC,MAAM,GAAG,CAAC,GAAG,GAAG,GAAG,KAAK,CAAA;CACvF;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;CACxB;AAED;;;;;GAKG;AACH,MAAM,WAAW,MAAO,SAAQ,eAAe,CAAC,KAAK,CAAC,QAAQ,CAAC;IAC7D,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,QAAQ,CAAC,EAAE,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAA;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe,CAAC,KAAK,CAAC,WAAW,CAAC;IAC/D,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAA;CAC5B;AASD;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,MAAM,EAAE,MAGnB,CAAA;AAEF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,MAAM,GAAI,SAAS;IAC9B,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,SAAS,CAAA;CACxD,KAAG,MAMA,CAAA;AAEJ;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,KAAK,EAAE,KAGlB,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,aAAa,EAAE;IAC1B;;;;;OAKG;IACH,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IAC/E;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAA;CAQ5E,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,EAAE;IACrB;;;;;OAKG;IACH,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAC,SAAS,eAAe,EAAE,IAAI,EAAE,CAAC,KAAK,CAAC,CAAA;IACvF;;;;;OAKG;IACH,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAAA;CAQpF,CAAA"}

package/dist/unstable/httpapi/HttpApiSecurity.js

@@ -1,28 +1,40 @@
 /**
- * The `HttpApiSecurity` module defines the security scheme values used by
- * declarative HTTP APIs.
- *
- * Use these constructors when an API group or endpoint needs authentication
- * middleware for bearer tokens, API keys, or HTTP Basic credentials. The values
- * are intentionally small declarations: `HttpApiMiddleware.Service` attaches
- * them to middleware, `HttpApiBuilder` decodes the matching credential shape from
- * each request, and OpenAPI generation emits the corresponding
- * `components.securitySchemes` and operation security requirements.
- *
- * Common uses include modeling `Authorization: Bearer ...` tokens, Basic
- * username/password credentials, and API keys passed through headers, query
- * parameters, or cookies. Bearer tokens and API-key values are exposed to
- * middleware as `Redacted` values; Basic credentials expose the username with a
- * redacted password. Cookie API keys can also be written to responses with
- * `HttpApiBuilder.securitySetCookie`.
- *
- * A security scheme does not authenticate by itself: middleware must reject empty
- * or invalid credentials. Bearer and Basic schemes read the `Authorization`
- * header, while API-key headers use HTTP header name normalization and API-key
- * query or cookie names are matched exactly. OpenAPI annotations such as
- * descriptions and bearer formats affect generated documentation only; they do
+ * Defines security scheme declarations for declarative HTTP APIs.
+ *
+ * Security schemes describe where credentials are read from and which credential
+ * type is passed to security middleware. They are consumed by
+ * `HttpApiMiddleware.Service`, `HttpApiBuilder`, generated clients, and OpenAPI
+ * generation, but they do not authenticate requests by themselves.
+ *
+ * **Mental model**
+ *
+ * Create a scheme with {@link bearer}, {@link apiKey}, or {@link basic}, attach
+ * it to middleware, and let the HTTP API builder decode the matching credential
+ * shape from each request. OpenAPI generation emits the same declaration as
+ * `components.securitySchemes` plus operation security requirements.
+ *
+ * **Common tasks**
+ *
+ * Use {@link bearer} for `Authorization: Bearer ...` tokens, {@link basic} for
+ * HTTP Basic username/password credentials, and {@link apiKey} for keys passed
+ * through headers, query parameters, or cookies. Use {@link annotate} or
+ * {@link annotateMerge} to add documentation metadata for generated OpenAPI
+ * descriptions.
+ *
+ * **Gotchas**
+ *
+ * Middleware must reject empty or invalid credentials. Bearer tokens and API-key
+ * values are delivered as `Redacted` values; Basic credentials expose the
+ * username and redact the password. Bearer and Basic schemes read the
+ * `Authorization` header, API-key headers use HTTP header name normalization,
+ * and API-key query or cookie names are matched exactly. OpenAPI annotations do
  * not change runtime decoding.
  *
+ * **See also**
+ *
+ * `HttpApiMiddleware` for implementing security checks and `HttpApiBuilder` for
+ * installing middleware and setting API-key cookies on responses.
+ *
  * @since 4.0.0
  */
 import * as Context from "../../Context.js";
@@ -40,9 +52,16 @@ const Proto = {
  *
  * **When to use**
  *
+ * Use to require `Authorization: Bearer ...` credentials for an HTTP API group
+ * or endpoint.
+ *
+ * **Details**
+ *
  * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
  * security scheme.
  *
+ * @see {@link apiKey} for an API-key security scheme
+ * @see {@link basic} for an HTTP Basic security scheme
  * @category constructors
  * @since 4.0.0
  */
@@ -55,14 +74,19 @@ export const bearer = /*#__PURE__*/Object.assign(/*#__PURE__*/Object.create(Prot
  *
  * **When to use**
  *
- * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
- * security scheme.
+ * Use to require API key credentials passed through a header, query parameter,
+ * or cookie.
  *
  * **Details**
  *
+ * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
+ * security scheme.
+ *
  * Use `HttpApiBuilder.securitySetCookie` to set the correct cookie in a
  * handler. By default, `in` is `"header"`.
  *
+ * @see {@link bearer} for a Bearer token security scheme
+ * @see {@link basic} for an HTTP Basic security scheme
  * @category constructors
  * @since 4.0.0
  */
@@ -77,9 +101,15 @@ export const apiKey = options => Object.assign(Object.create(Proto), {
  *
  * **When to use**
  *
+ * Use to require HTTP Basic username/password credentials.
+ *
+ * **Details**
+ *
  * Use `HttpApiBuilder.middlewareSecurity` to implement API middleware for this
  * security scheme.
  *
+ * @see {@link bearer} for a Bearer token security scheme
+ * @see {@link apiKey} for an API-key security scheme
  * @category constructors
  * @since 4.0.0
  */

package/dist/unstable/httpapi/HttpApiSecurity.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSecurity.js","names":["Context","dual","pipeArguments","TypeId","Proto","pipe","arguments","bearer","Object","assign","create","_tag","annotations","empty","apiKey","options","key","in","basic","annotateMerge","self","merge","annotate","service","value","add"],"sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,SAASC,IAAI,QAAQ,mBAAmB;AACxC,SAAwBC,aAAa,QAAQ,mBAAmB;AAIhE,MAAMC,MAAM,GAAG,iCAAiC;AAiFhD,MAAMC,KAAK,GAAG;EACZ,CAACD,MAAM,GAAGA,MAAM;EAChBE,IAAIA,CAAA;IACF,OAAOH,aAAa,CAAC,IAAI,EAAEI,SAAS,CAAC;EACvC;CACD;AAED;;;;;;;;;;;AAWA,OAAO,MAAMC,MAAM,gBAAWC,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAChEO,IAAI,EAAE,QAAQ;EACdC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;AAgBA,OAAO,MAAMC,MAAM,GAAIC,OAGtB,IACCP,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClCO,IAAI,EAAE,QAAQ;EACdK,GAAG,EAAED,OAAO,CAACC,GAAG;EAChBC,EAAE,EAAEF,OAAO,CAACE,EAAE,IAAI,QAAQ;EAC1BL,WAAW,EAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEJ;;;;;;;;;;;AAWA,OAAO,MAAMK,KAAK,gBAAUV,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAC9DO,IAAI,EAAE,OAAO;EACbC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMM,aAAa,gBAetBlB,IAAI,CACN,CAAC,EACD,CAA+BmB,IAAO,EAAER,WAA+B,KACrEJ,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACqB,KAAK,CAACD,IAAI,CAACR,WAAW,EAAEA,WAAW;CACzD,CAAC,CACL;AAED;;;;;;AAMA,OAAO,MAAMU,QAAQ,gBAejBrB,IAAI,CACN,CAAC,EACD,CAAkCmB,IAAO,EAAEG,OAA0B,EAAEC,KAAQ,KAC7EhB,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACyB,GAAG,CAACL,IAAI,CAACR,WAAW,EAAEW,OAAO,EAAEC,KAAK;CAC1D,CAAC,CACL","ignoreList":[]}
+{"version":3,"file":"HttpApiSecurity.js","names":["Context","dual","pipeArguments","TypeId","Proto","pipe","arguments","bearer","Object","assign","create","_tag","annotations","empty","apiKey","options","key","in","basic","annotateMerge","self","merge","annotate","service","value","add"],"sources":["../../../src/unstable/httpapi/HttpApiSecurity.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuCA,OAAO,KAAKA,OAAO,MAAM,kBAAkB;AAC3C,SAASC,IAAI,QAAQ,mBAAmB;AACxC,SAAwBC,aAAa,QAAQ,mBAAmB;AAIhE,MAAMC,MAAM,GAAG,iCAAiC;AAiFhD,MAAMC,KAAK,GAAG;EACZ,CAACD,MAAM,GAAGA,MAAM;EAChBE,IAAIA,CAAA;IACF,OAAOH,aAAa,CAAC,IAAI,EAAEI,SAAS,CAAC;EACvC;CACD;AAED;;;;;;;;;;;;;;;;;;AAkBA,OAAO,MAAMC,MAAM,gBAAWC,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAChEO,IAAI,EAAE,QAAQ;EACdC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;AAqBA,OAAO,MAAMC,MAAM,GAAIC,OAGtB,IACCP,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClCO,IAAI,EAAE,QAAQ;EACdK,GAAG,EAAED,OAAO,CAACC,GAAG;EAChBC,EAAE,EAAEF,OAAO,CAACE,EAAE,IAAI,QAAQ;EAC1BL,WAAW,EAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEJ;;;;;;;;;;;;;;;;;AAiBA,OAAO,MAAMK,KAAK,gBAAUV,MAAM,CAACC,MAAM,cAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAC9DO,IAAI,EAAE,OAAO;EACbC,WAAW,eAAEZ,OAAO,CAACa,KAAK;CAC3B,CAAC;AAEF;;;;;;AAMA,OAAO,MAAMM,aAAa,gBAetBlB,IAAI,CACN,CAAC,EACD,CAA+BmB,IAAO,EAAER,WAA+B,KACrEJ,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACqB,KAAK,CAACD,IAAI,CAACR,WAAW,EAAEA,WAAW;CACzD,CAAC,CACL;AAED;;;;;;AAMA,OAAO,MAAMU,QAAQ,gBAejBrB,IAAI,CACN,CAAC,EACD,CAAkCmB,IAAO,EAAEG,OAA0B,EAAEC,KAAQ,KAC7EhB,MAAM,CAACC,MAAM,CAACD,MAAM,CAACE,MAAM,CAACN,KAAK,CAAC,EAAE;EAClC,GAAGgB,IAAI;EACPR,WAAW,EAAEZ,OAAO,CAACyB,GAAG,CAACL,IAAI,CAACR,WAAW,EAAEW,OAAO,EAAEC,KAAK;CAC1D,CAAC,CACL","ignoreList":[]}

package/dist/unstable/httpapi/HttpApiSwagger.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSwagger.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"names":[],"mappings":"AAuBA,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAA;AAEnD,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAoCtD;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACtE,KAAK,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;CACzC,KACA,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAI7C,CAAA"}
+{"version":3,"file":"HttpApiSwagger.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"names":[],"mappings":"AAmCA,OAAO,KAAK,KAAK,KAAK,MAAM,gBAAgB,CAAA;AAC5C,OAAO,KAAK,UAAU,MAAM,uBAAuB,CAAA;AAEnD,OAAO,KAAK,KAAK,OAAO,MAAM,cAAc,CAAA;AAC5C,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;AAoCtD;;;;;;GAMG;AACH,eAAO,MAAM,KAAK,GAAI,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACtE,KAAK,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,EAChC,UAAU;IACR,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,MAAM,EAAE,GAAG,SAAS,CAAA;CACzC,KACA,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,UAAU,CAAC,UAAU,CAI7C,CAAA"}

package/dist/unstable/httpapi/HttpApiSwagger.js

@@ -1,22 +1,34 @@
 /**
- * Serves Swagger UI for an `HttpApi` by rendering the OpenAPI document generated
- * from the API directly into an HTML page.
+ * Swagger documentation UI for declarative `HttpApi` contracts.
  *
- * Use this module when you want a lightweight documentation route for a running
- * `HttpApi`, typically in development, staging, internal consoles, or public API
- * reference pages where Swagger UI's exploration and request-building tools are
- * preferred. The exported `layer` adds a `GET` route to an `HttpRouter`,
- * defaults the mount path to `/docs`, and leaves API implementation and server
- * wiring to `HttpApiBuilder` and the surrounding router layers.
+ * This module mounts a browser-based Swagger UI route on an `HttpRouter`. The
+ * page renders the OpenAPI document derived from the supplied `HttpApi`, so a
+ * running application can expose interactive API documentation without writing a
+ * separate OpenAPI file.
  *
- * The page is self-contained: `OpenApi.fromApi` derives the specification from
- * the API's groups, endpoints, schemas, and OpenAPI annotations, then the JSON
- * is embedded into the HTML served to the browser. No separate `/openapi.json`
- * endpoint is installed by this module, so clients or documentation pipelines
- * that need the raw spec should use `OpenApi.fromApi` directly or expose a JSON
- * route elsewhere. If the docs are public, mount the layer behind the same
- * routing, security, or environment controls you want for the UI; generated
- * server URLs and operation metadata come from the API's OpenAPI annotations.
+ * **Mental model**
+ *
+ * {@link layer} registers one `GET` route, defaulting to `/docs`. When that
+ * route is requested, the module derives the OpenAPI document with
+ * `OpenApi.fromApi`, embeds it into an HTML page, and boots the bundled Swagger
+ * UI script in the browser. API implementation, middleware, and server wiring
+ * stay with the surrounding `HttpApi` and router layers.
+ *
+ * **Common tasks**
+ *
+ * - Use {@link layer} to mount Swagger UI for an `HttpApi`
+ * - Set `path` when the documentation route should be mounted somewhere other
+ *   than `/docs`
+ * - Add OpenAPI annotations to the API definition so the generated UI has the
+ *   desired titles, descriptions, servers, security schemes, and operation
+ *   metadata
+ *
+ * **Gotchas**
+ *
+ * The mounted route serves HTML, not a raw OpenAPI JSON endpoint. Clients,
+ * gateways, and documentation pipelines that need the specification directly
+ * should derive it separately with `OpenApi.fromApi` or expose a JSON route from
+ * the surrounding API server.
  *
  * @since 4.0.0
  */

package/dist/unstable/httpapi/HttpApiSwagger.js.map

@@ -1 +1 @@
-{"version":3,"file":"HttpApiSwagger.js","names":["Effect","HttpRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","response","html","escape","info","title","css","escapeJson","javascript","succeed","layer","use","fnUntraced","router","handler","add","path"],"sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;AAsBA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,UAAU,MAAM,uBAAuB;AACnD,OAAO,KAAKC,kBAAkB,MAAM,+BAA+B;AAGnE,OAAO,KAAKC,IAAI,MAAM,oBAAoB;AAC1C,OAAO,KAAKC,QAAQ,MAAM,8BAA8B;AACxD,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC,MAAMC,WAAW,GAAwDC,OAExE,IAAI;EACH,MAAMC,IAAI,GAAGH,OAAO,CAACI,OAAO,CAACF,OAAO,CAACG,GAAG,CAAC;EACzC,MAAMC,QAAQ,GAAGT,kBAAkB,CAACU,IAAI,CAAC;;;;;WAKhCT,IAAI,CAACU,MAAM,CAACL,IAAI,CAACM,IAAI,CAACC,KAAK,CAAC;WAC5BX,QAAQ,CAACY,GAAG;;;;;MAKjBb,IAAI,CAACc,UAAU,CAACT,IAAI,CAAC;;;MAGrBJ,QAAQ,CAACc,UAAU;;;;;;;;;QASjB,CAAC;EACP,OAAOlB,MAAM,CAACmB,OAAO,CAACR,QAAQ,CAAC;AACjC,CAAC;AAED;;;;;;;AAOA,OAAO,MAAMS,KAAK,GAAGA,CACnBV,GAAgC,EAChCH,OAEC,KAEDN,UAAU,CAACoB,GAAG,CAACrB,MAAM,CAACsB,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGlB,WAAW,CAAC;IAAEI;EAAG,CAAE,CAAC;EACpC,OAAOa,MAAM,CAACE,GAAG,CAAC,KAAK,EAAElB,OAAO,EAAEmB,IAAI,IAAI,OAAO,EAAEF,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC","ignoreList":[]}
+{"version":3,"file":"HttpApiSwagger.js","names":["Effect","HttpRouter","HttpServerResponse","Html","internal","OpenApi","makeHandler","options","spec","fromApi","api","response","html","escape","info","title","css","escapeJson","javascript","succeed","layer","use","fnUntraced","router","handler","add","path"],"sources":["../../../src/unstable/httpapi/HttpApiSwagger.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkCA,OAAO,KAAKA,MAAM,MAAM,iBAAiB;AAEzC,OAAO,KAAKC,UAAU,MAAM,uBAAuB;AACnD,OAAO,KAAKC,kBAAkB,MAAM,+BAA+B;AAGnE,OAAO,KAAKC,IAAI,MAAM,oBAAoB;AAC1C,OAAO,KAAKC,QAAQ,MAAM,8BAA8B;AACxD,OAAO,KAAKC,OAAO,MAAM,cAAc;AAEvC,MAAMC,WAAW,GAAwDC,OAExE,IAAI;EACH,MAAMC,IAAI,GAAGH,OAAO,CAACI,OAAO,CAACF,OAAO,CAACG,GAAG,CAAC;EACzC,MAAMC,QAAQ,GAAGT,kBAAkB,CAACU,IAAI,CAAC;;;;;WAKhCT,IAAI,CAACU,MAAM,CAACL,IAAI,CAACM,IAAI,CAACC,KAAK,CAAC;WAC5BX,QAAQ,CAACY,GAAG;;;;;MAKjBb,IAAI,CAACc,UAAU,CAACT,IAAI,CAAC;;;MAGrBJ,QAAQ,CAACc,UAAU;;;;;;;;;QASjB,CAAC;EACP,OAAOlB,MAAM,CAACmB,OAAO,CAACR,QAAQ,CAAC;AACjC,CAAC;AAED;;;;;;;AAOA,OAAO,MAAMS,KAAK,GAAGA,CACnBV,GAAgC,EAChCH,OAEC,KAEDN,UAAU,CAACoB,GAAG,CAACrB,MAAM,CAACsB,UAAU,CAAC,WAAUC,MAAM;EAC/C,MAAMC,OAAO,GAAGlB,WAAW,CAAC;IAAEI;EAAG,CAAE,CAAC;EACpC,OAAOa,MAAM,CAACE,GAAG,CAAC,KAAK,EAAElB,OAAO,EAAEmB,IAAI,IAAI,OAAO,EAAEF,OAAO,CAAC;AAC7D,CAAC,CAAC,CAAC","ignoreList":[]}

package/dist/unstable/httpapi/HttpApiTest.d.ts

@@ -16,7 +16,7 @@ import type * as HttpApiGroup from "./HttpApiGroup.ts";
  * Handlers for the selected groups are taken from the environment; unselected
  * groups are wired with placeholder handlers that fail if called.
  *
- * @category Testing
+ * @category testing
  * @since 4.0.0
  */
 export declare const groups: <ApiId extends string, Groups extends HttpApiGroup.Any, const Names extends ReadonlyArray<HttpApiGroup.Name<Groups>>, SelectedGroups = Extract<Groups, {

package/dist/unstable/httpapi/HttpApiTest.js

@@ -38,7 +38,7 @@ import * as HttpApiClient from "./HttpApiClient.js";
  * Handlers for the selected groups are taken from the environment; unselected
  * groups are wired with placeholder handlers that fail if called.
  *
- * @category Testing
+ * @category testing
  * @since 4.0.0
  */
 export const groups = /*#__PURE__*/Effect.fnUntraced(function* (api, groupNames, options) {

package/dist/unstable/httpapi/OpenApi.d.ts

@@ -103,7 +103,13 @@ declare const Override_base: Context.ServiceClass<Override, "effect/httpapi/Open
 export declare class Override extends Override_base {
 }
 /**
- * OpenAPI annotation reference that excludes an annotated group or endpoint from the generated specification.
+ * Annotation that excludes an annotated group or endpoint from the generated
+ * OpenAPI specification.
+ *
+ * **When to use**
+ *
+ * Use to hide internal, experimental, or otherwise undocumented HTTP API groups
+ * and endpoints from generated OpenAPI output.
  *
  * @category annotations
  * @since 4.0.0

package/dist/unstable/httpapi/OpenApi.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenApi.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/OpenApi.ts"],"names":[],"mappings":"AAiCA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAI3C,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAA;AAMjD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;;AAKtD;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,eAA0E;CAAG;;AAE7G;;;;;GAKG;AACH,qBAAa,KAAM,SAAQ,UAAgE;CAAG;;AAE9F;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,YAAoE;CAAG;;AAEpG;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,gBAA4E;CAAG;;AAEhH;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,YAAgF;CAAG;;AAEhH;;;;;GAKG;AACH,qBAAa,YACX,SAAQ,iBAA+F;CACvG;;AAEF;;;;;GAKG;AACH,qBAAa,OACX,SAAQ,YAA8F;CACtG;;AAEF;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAAkE;CAAG;;AAEjG;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,YAAoE;CAAG;;AAEpG;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,eAA2E;CAAG;;AAE9G;;;;;GAKG;AACH,qBAAa,QAAS,SAAQ,aAAuF;CAAG;AAExH;;;;;GAKG;AACH,eAAO,MAAM,OAAO,4BAElB,CAAA;gHAec,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;AAb3D;;;;;;;;;;GAUG;AACH,qBAAa,SAAU,SAAQ,cAGQ;CAAG;AAqB1C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,CACxB,OAAO,EAAE;IACP,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAA;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;CAC7F,KACE,OAAO,CAAC,OAAO,CAAC,KAAK,CAcxB,CAAA;AAoBF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACxE,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,GAC/B,WAAW,CAqTb;AAkKD;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,eAAe,CAAA;IACrB,KAAK,EAAE,gBAAgB,CAAA;IACvB,UAAU,EAAE,iBAAiB,CAAA;IAC7B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;IAC3B,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,kBAAkB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;CACtD;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAElE;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC7B,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,CAAA;AAEX;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,qBAAqB,CAAC,CAAC,EAAE,oBAAoB;CACpD,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAEtE;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;KAC9B,CAAC,IAAI,MAAM,GAAG,oBAAoB;CACpC,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,UAAU,CAAC,WAAW,CAAA;IAC/B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAA;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACjC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,CAAA;AAE/B;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAEtE;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACvC,SAAS,EAAE,oBAAoB,CAAA;IAC/B,4EAA4E;IAC5E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC3B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC"}
+{"version":3,"file":"OpenApi.d.ts","sourceRoot":"","sources":["../../../src/unstable/httpapi/OpenApi.ts"],"names":[],"mappings":"AA6CA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAA;AACnD,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAA;AAI3C,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAA;AAMjD,OAAO,KAAK,OAAO,MAAM,cAAc,CAAA;AAEvC,OAAO,KAAK,KAAK,YAAY,MAAM,mBAAmB,CAAA;;AAKtD;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,eAA0E;CAAG;;AAE7G;;;;;GAKG;AACH,qBAAa,KAAM,SAAQ,UAAgE;CAAG;;AAE9F;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,YAAoE;CAAG;;AAEpG;;;;;GAKG;AACH,qBAAa,WAAY,SAAQ,gBAA4E;CAAG;;AAEhH;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,YAAgF;CAAG;;AAEhH;;;;;GAKG;AACH,qBAAa,YACX,SAAQ,iBAA+F;CACvG;;AAEF;;;;;GAKG;AACH,qBAAa,OACX,SAAQ,YAA8F;CACtG;;AAEF;;;;;GAKG;AACH,qBAAa,MAAO,SAAQ,WAAkE;CAAG;;AAEjG;;;;;GAKG;AACH,qBAAa,OAAQ,SAAQ,YAAoE;CAAG;;AAEpG;;;;;GAKG;AACH,qBAAa,UAAW,SAAQ,eAA2E;CAAG;;AAE9G;;;;;GAKG;AACH,qBAAa,QAAS,SAAQ,aAAuF;CAAG;AAExH;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,OAAO,4BAElB,CAAA;gHAec,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;AAb3D;;;;;;;;;;GAUG;AACH,qBAAa,SAAU,SAAQ,cAGQ;CAAG;AAqB1C;;;;;GAKG;AACH,eAAO,MAAM,WAAW,EAAE,CACxB,OAAO,EAAE;IACP,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACxC,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,SAAS,CAAA;IACjD,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACzC,QAAQ,CAAC,YAAY,CAAC,EAAE,uBAAuB,GAAG,SAAS,CAAA;IAC3D,QAAQ,CAAC,OAAO,CAAC,EAAE,aAAa,CAAC,iBAAiB,CAAC,GAAG,SAAS,CAAA;IAC/D,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAA;IACvD,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,SAAS,CAAA;CAC7F,KACE,OAAO,CAAC,OAAO,CAAC,KAAK,CAcxB,CAAA;AAoBF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,MAAM,SAAS,YAAY,CAAC,GAAG,EACxE,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,CAAC,GAC/B,WAAW,CAqTb;AAkKD;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,IAAI,EAAE,eAAe,CAAA;IACrB,KAAK,EAAE,gBAAgB,CAAA;IACvB,UAAU,EAAE,iBAAiB,CAAA;IAC7B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,IAAI,EAAE,KAAK,CAAC,cAAc,CAAC,CAAA;IAC3B,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;CACnC;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;IACf,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,kBAAkB,CAAA;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACtC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,EAAE,MAAM,CAAA;IACZ,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAA;IACX,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,CAAA;CACtD;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAElE;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC7B,KAAK,GACL,KAAK,GACL,MAAM,GACN,QAAQ,GACR,SAAS,GACT,MAAM,GACN,OAAO,GACP,OAAO,CAAA;AAEX;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;KAC/B,CAAC,IAAI,qBAAqB,CAAC,CAAC,EAAE,oBAAoB;CACpD,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAA;IAC1C,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,OAAO,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAA;AAEtE;;;;;GAKG;AACH,MAAM,MAAM,kBAAkB,GAAG;KAC9B,CAAC,IAAI,MAAM,GAAG,oBAAoB;CACpC,CAAA;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,WAAW,EAAE,MAAM,CAAA;IACnB,OAAO,CAAC,EAAE,kBAAkB,CAAA;CAC7B;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,UAAU,CAAC,UAAU,CAAA;CAC9B;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,kBAAkB,CAAA;IAC3B,QAAQ,EAAE,IAAI,CAAA;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,UAAU,CAAC,WAAW,CAAA;IAC/B,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAA;CACvD;AAED;;;;;GAKG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAA;IACnC,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAA;IACvB,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAA;IACjC,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,GAC7B,yBAAyB,GACzB,2BAA2B,CAAA;AAE/B;;;;;GAKG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAA;AAEtE;;;;;GAKG;AACH,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAA;IACvC,SAAS,EAAE,oBAAoB,CAAA;IAC/B,4EAA4E;IAC5E,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;IAC3B,QAAQ,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAA;IAC3C,WAAW,CAAC,EAAE,sBAAsB,CAAA;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,YAAY,CAAC,EAAE,uBAAuB,CAAA;CACvC"}

package/dist/unstable/httpapi/OpenApi.js

@@ -1,32 +1,44 @@
 /**
- * The `OpenApi` module converts declarative `HttpApi` definitions into
- * OpenAPI 3.1 specifications and provides annotations for shaping the
- * generated document.
+ * OpenAPI 3.1 generation for declarative `HttpApi` contracts.
  *
- * Use this module when you need to publish an `HttpApi` contract to tooling
- * such as Swagger UI, Scalar, client generators, API gateways, or documentation
- * pipelines. `fromApi` reflects the API's groups and endpoints into tags,
+ * This module reflects an `HttpApi` into an OpenAPI document and provides the
+ * annotations used to shape the generated output. The result can be served from
+ * `HttpApiBuilder.layer`, rendered by Swagger UI or Scalar, passed to client
+ * generators, or published through API gateway and documentation pipelines.
+ *
+ * **Mental model**
+ *
+ * {@link fromApi} walks the API's groups and endpoints and emits OpenAPI tags,
  * paths, operations, parameters, request bodies, responses, security schemes,
- * and component schemas while preserving Effect Schema metadata where OpenAPI
- * can represent it.
- *
- * The generated specification is driven by annotations on APIs, groups,
- * endpoints, security definitions, and schemas. `Title`, `Description`,
- * `Summary`, `Version`, `Servers`, `License`, `ExternalDocs`, `Identifier`,
- * `Deprecated`, and `Format` feed the corresponding OpenAPI fields; `Exclude`
- * omits a group or endpoint; `Override` shallowly merges custom fields; and
- * `Transform` can rewrite the generated API, tag, or operation object. Schema
- * identifiers are important for stable component names, additional schemas must
- * have identifiers, and invalid OpenAPI component keys are rejected during
- * generation.
- *
- * A few generation details are worth keeping in mind: `HttpApiSchema`
- * encodings choose media types and special representations for JSON,
- * form-url-encoded, text, binary, and multipart payloads; no-content schemas
- * emit responses without bodies; request and response unions are grouped by
- * status code and content type; path parameters are rendered from `:id` route
- * segments as `{id}`; and schemas are converted through the OpenAPI 3.1 JSON
- * Schema representation before being patched into the final document.
+ * and component schemas. Endpoint and schema metadata determine the HTTP
+ * surface; annotations such as {@link Title}, {@link Description},
+ * {@link Summary}, {@link Version}, {@link Servers}, {@link License},
+ * {@link ExternalDocs}, {@link Identifier}, {@link Deprecated}, and
+ * {@link Format} fill in OpenAPI-specific fields.
+ *
+ * **Common tasks**
+ *
+ * Use {@link fromApi} to generate the complete specification. Use
+ * {@link annotations} to attach several OpenAPI annotations at once. Use
+ * {@link Exclude} to omit a group or endpoint, {@link Override} to shallowly
+ * merge extra fields into a generated object, and {@link Transform} when the
+ * generated API, tag, or operation needs a programmatic rewrite.
+ *
+ * **Gotchas**
+ *
+ * Schema identifiers are used as component names; additional schemas must have
+ * identifiers, and invalid OpenAPI component keys are rejected during
+ * generation. `HttpApiSchema` encodings choose media types for JSON,
+ * form-url-encoded, text, binary, and multipart payloads. No-content schemas
+ * emit responses without bodies, request and response unions are grouped by
+ * status code and content type, and `:id` route segments are rendered as `{id}`
+ * path parameters.
+ *
+ * **See also**
+ *
+ * `HttpApi` for API composition, `HttpApiEndpoint` for endpoint metadata,
+ * `HttpApiSchema` for HTTP status and encoding annotations, and
+ * `HttpApiBuilder` for serving the generated document with an HTTP router.
  *
  * @since 4.0.0
  */
@@ -123,7 +135,13 @@ export class Deprecated extends /*#__PURE__*/Context.Service()("effect/httpapi/O
  */
 export class Override extends /*#__PURE__*/Context.Service()("effect/httpapi/OpenApi/Override") {}
 /**
- * OpenAPI annotation reference that excludes an annotated group or endpoint from the generated specification.
+ * Annotation that excludes an annotated group or endpoint from the generated
+ * OpenAPI specification.
+ *
+ * **When to use**
+ *
+ * Use to hide internal, experimental, or otherwise undocumented HTTP API groups
+ * and endpoints from generated OpenAPI output.
  *
  * @category annotations
  * @since 4.0.0