Microsoft.OpenApi.xml 272 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.OpenApi</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.OpenApi.Any.AnyType">
  8. <summary>
  9. Type of an <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
  10. </summary>
  11. </member>
  12. <member name="F:Microsoft.OpenApi.Any.AnyType.Primitive">
  13. <summary>
  14. Primitive.
  15. </summary>
  16. </member>
  17. <member name="F:Microsoft.OpenApi.Any.AnyType.Null">
  18. <summary>
  19. Null.
  20. </summary>
  21. </member>
  22. <member name="F:Microsoft.OpenApi.Any.AnyType.Array">
  23. <summary>
  24. Array.
  25. </summary>
  26. </member>
  27. <member name="F:Microsoft.OpenApi.Any.AnyType.Object">
  28. <summary>
  29. Object.
  30. </summary>
  31. </member>
  32. <member name="T:Microsoft.OpenApi.Any.IOpenApiAny">
  33. <summary>
  34. Base interface for all the types that represent Open API Any.
  35. </summary>
  36. </member>
  37. <member name="P:Microsoft.OpenApi.Any.IOpenApiAny.AnyType">
  38. <summary>
  39. Type of an <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
  40. </summary>
  41. </member>
  42. <member name="T:Microsoft.OpenApi.Any.PrimitiveType">
  43. <summary>
  44. Primitive type.
  45. </summary>
  46. </member>
  47. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Integer">
  48. <summary>
  49. Integer
  50. </summary>
  51. </member>
  52. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Long">
  53. <summary>
  54. Long
  55. </summary>
  56. </member>
  57. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Float">
  58. <summary>
  59. Float
  60. </summary>
  61. </member>
  62. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Double">
  63. <summary>
  64. Double
  65. </summary>
  66. </member>
  67. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.String">
  68. <summary>
  69. String
  70. </summary>
  71. </member>
  72. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Byte">
  73. <summary>
  74. Byte
  75. </summary>
  76. </member>
  77. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Binary">
  78. <summary>
  79. Binary
  80. </summary>
  81. </member>
  82. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Boolean">
  83. <summary>
  84. Boolean
  85. </summary>
  86. </member>
  87. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Date">
  88. <summary>
  89. Date
  90. </summary>
  91. </member>
  92. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.DateTime">
  93. <summary>
  94. DateTime
  95. </summary>
  96. </member>
  97. <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Password">
  98. <summary>
  99. Password
  100. </summary>
  101. </member>
  102. <member name="T:Microsoft.OpenApi.Any.IOpenApiPrimitive">
  103. <summary>
  104. Base interface for the Primitive type.
  105. </summary>
  106. </member>
  107. <member name="P:Microsoft.OpenApi.Any.IOpenApiPrimitive.PrimitiveType">
  108. <summary>
  109. Primitive type.
  110. </summary>
  111. </member>
  112. <member name="T:Microsoft.OpenApi.Any.OpenApiArray">
  113. <summary>
  114. Open API array.
  115. </summary>
  116. </member>
  117. <member name="P:Microsoft.OpenApi.Any.OpenApiArray.AnyType">
  118. <summary>
  119. The type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
  120. </summary>
  121. </member>
  122. <member name="M:Microsoft.OpenApi.Any.OpenApiArray.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
  123. <summary>
  124. Write out contents of OpenApiArray to passed writer
  125. </summary>
  126. <param name="writer">Instance of JSON or YAML writer.</param>
  127. <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
  128. </member>
  129. <member name="T:Microsoft.OpenApi.Any.OpenApiBinary">
  130. <summary>
  131. Open API binary.
  132. </summary>
  133. </member>
  134. <member name="M:Microsoft.OpenApi.Any.OpenApiBinary.#ctor(System.Byte[])">
  135. <summary>
  136. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiBinary"/> class.
  137. </summary>
  138. <param name="value"></param>
  139. </member>
  140. <member name="P:Microsoft.OpenApi.Any.OpenApiBinary.PrimitiveType">
  141. <summary>
  142. Primitive type this object represents.
  143. </summary>
  144. </member>
  145. <member name="T:Microsoft.OpenApi.Any.OpenApiBoolean">
  146. <summary>
  147. Open API boolean.
  148. </summary>
  149. </member>
  150. <member name="M:Microsoft.OpenApi.Any.OpenApiBoolean.#ctor(System.Boolean)">
  151. <summary>
  152. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiBoolean"/> class.
  153. </summary>
  154. <param name="value"></param>
  155. </member>
  156. <member name="P:Microsoft.OpenApi.Any.OpenApiBoolean.PrimitiveType">
  157. <summary>
  158. Primitive type this object represents.
  159. </summary>
  160. </member>
  161. <member name="T:Microsoft.OpenApi.Any.OpenApiByte">
  162. <summary>
  163. Open API Byte
  164. </summary>
  165. </member>
  166. <member name="M:Microsoft.OpenApi.Any.OpenApiByte.#ctor(System.Byte)">
  167. <summary>
  168. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiByte"/> class.
  169. </summary>
  170. </member>
  171. <member name="M:Microsoft.OpenApi.Any.OpenApiByte.#ctor(System.Byte[])">
  172. <summary>
  173. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiByte"/> class.
  174. </summary>
  175. </member>
  176. <member name="P:Microsoft.OpenApi.Any.OpenApiByte.PrimitiveType">
  177. <summary>
  178. Primitive type this object represents.
  179. </summary>
  180. </member>
  181. <member name="T:Microsoft.OpenApi.Any.OpenApiDate">
  182. <summary>
  183. Open API Date
  184. </summary>
  185. </member>
  186. <member name="M:Microsoft.OpenApi.Any.OpenApiDate.#ctor(System.DateTime)">
  187. <summary>
  188. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDate"/> class.
  189. </summary>
  190. </member>
  191. <member name="P:Microsoft.OpenApi.Any.OpenApiDate.PrimitiveType">
  192. <summary>
  193. Primitive type this object represents.
  194. </summary>
  195. </member>
  196. <member name="T:Microsoft.OpenApi.Any.OpenApiDateTime">
  197. <summary>
  198. Open API Datetime
  199. </summary>
  200. </member>
  201. <member name="M:Microsoft.OpenApi.Any.OpenApiDateTime.#ctor(System.DateTimeOffset)">
  202. <summary>
  203. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDateTime"/> class.
  204. </summary>
  205. </member>
  206. <member name="P:Microsoft.OpenApi.Any.OpenApiDateTime.PrimitiveType">
  207. <summary>
  208. Primitive type this object represents.
  209. </summary>
  210. </member>
  211. <member name="T:Microsoft.OpenApi.Any.OpenApiDouble">
  212. <summary>
  213. Open API Double
  214. </summary>
  215. </member>
  216. <member name="M:Microsoft.OpenApi.Any.OpenApiDouble.#ctor(System.Double)">
  217. <summary>
  218. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDouble"/> class.
  219. </summary>
  220. </member>
  221. <member name="P:Microsoft.OpenApi.Any.OpenApiDouble.PrimitiveType">
  222. <summary>
  223. Primitive type this object represents.
  224. </summary>
  225. </member>
  226. <member name="T:Microsoft.OpenApi.Any.OpenApiFloat">
  227. <summary>
  228. Open API Float
  229. </summary>
  230. </member>
  231. <member name="M:Microsoft.OpenApi.Any.OpenApiFloat.#ctor(System.Single)">
  232. <summary>
  233. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiFloat"/> class.
  234. </summary>
  235. </member>
  236. <member name="P:Microsoft.OpenApi.Any.OpenApiFloat.PrimitiveType">
  237. <summary>
  238. Primitive type this object represents.
  239. </summary>
  240. </member>
  241. <member name="T:Microsoft.OpenApi.Any.OpenApiInteger">
  242. <summary>
  243. Open API Integer
  244. </summary>
  245. </member>
  246. <member name="M:Microsoft.OpenApi.Any.OpenApiInteger.#ctor(System.Int32)">
  247. <summary>
  248. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiInteger"/> class.
  249. </summary>
  250. </member>
  251. <member name="P:Microsoft.OpenApi.Any.OpenApiInteger.PrimitiveType">
  252. <summary>
  253. Primitive type this object represents.
  254. </summary>
  255. </member>
  256. <member name="T:Microsoft.OpenApi.Any.OpenApiLong">
  257. <summary>
  258. Open API long.
  259. </summary>
  260. </member>
  261. <member name="M:Microsoft.OpenApi.Any.OpenApiLong.#ctor(System.Int64)">
  262. <summary>
  263. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiLong"/> class.
  264. </summary>
  265. </member>
  266. <member name="P:Microsoft.OpenApi.Any.OpenApiLong.PrimitiveType">
  267. <summary>
  268. Primitive type this object represents.
  269. </summary>
  270. </member>
  271. <member name="T:Microsoft.OpenApi.Any.OpenApiNull">
  272. <summary>
  273. Open API null.
  274. </summary>
  275. </member>
  276. <member name="P:Microsoft.OpenApi.Any.OpenApiNull.AnyType">
  277. <summary>
  278. The type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
  279. </summary>
  280. </member>
  281. <member name="M:Microsoft.OpenApi.Any.OpenApiNull.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
  282. <summary>
  283. Write out null representation
  284. </summary>
  285. <param name="writer"></param>
  286. <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
  287. </member>
  288. <member name="T:Microsoft.OpenApi.Any.OpenApiObject">
  289. <summary>
  290. Open API object.
  291. </summary>
  292. </member>
  293. <member name="P:Microsoft.OpenApi.Any.OpenApiObject.AnyType">
  294. <summary>
  295. Type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
  296. </summary>
  297. </member>
  298. <member name="M:Microsoft.OpenApi.Any.OpenApiObject.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
  299. <summary>
  300. Serialize OpenApiObject to writer
  301. </summary>
  302. <param name="writer"></param>
  303. <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
  304. </member>
  305. <member name="T:Microsoft.OpenApi.Any.OpenApiPassword">
  306. <summary>
  307. Open API password.
  308. </summary>
  309. </member>
  310. <member name="M:Microsoft.OpenApi.Any.OpenApiPassword.#ctor(System.String)">
  311. <summary>
  312. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiPassword"/> class.
  313. </summary>
  314. </member>
  315. <member name="P:Microsoft.OpenApi.Any.OpenApiPassword.PrimitiveType">
  316. <summary>
  317. The primitive type this object represents.
  318. </summary>
  319. </member>
  320. <member name="T:Microsoft.OpenApi.Any.OpenApiPrimitive`1">
  321. <summary>
  322. Open API primitive class.
  323. </summary>
  324. <typeparam name="T"></typeparam>
  325. </member>
  326. <member name="M:Microsoft.OpenApi.Any.OpenApiPrimitive`1.#ctor(`0)">
  327. <summary>
  328. Initializes the <see cref="T:Microsoft.OpenApi.Any.IOpenApiPrimitive"/> class with the given value.
  329. </summary>
  330. <param name="value"></param>
  331. </member>
  332. <member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.AnyType">
  333. <summary>
  334. The kind of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
  335. </summary>
  336. </member>
  337. <member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.PrimitiveType">
  338. <summary>
  339. The primitive class this object represents.
  340. </summary>
  341. </member>
  342. <member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.Value">
  343. <summary>
  344. Value of this <see cref="T:Microsoft.OpenApi.Any.IOpenApiPrimitive"/>
  345. </summary>
  346. </member>
  347. <member name="M:Microsoft.OpenApi.Any.OpenApiPrimitive`1.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
  348. <summary>
  349. Write out content of primitive element
  350. </summary>
  351. <param name="writer"></param>
  352. <param name="specVersion"></param>
  353. </member>
  354. <member name="T:Microsoft.OpenApi.Any.OpenApiString">
  355. <summary>
  356. Open API string type.
  357. </summary>
  358. </member>
  359. <member name="M:Microsoft.OpenApi.Any.OpenApiString.#ctor(System.String)">
  360. <summary>
  361. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiString"/> class.
  362. </summary>
  363. <param name="value"></param>
  364. </member>
  365. <member name="M:Microsoft.OpenApi.Any.OpenApiString.#ctor(System.String,System.Boolean)">
  366. <summary>
  367. Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiString"/> class.
  368. </summary>
  369. <param name="value"></param>
  370. <param name="isExplicit">Used to indicate if a string is quoted.</param>
  371. </member>
  372. <member name="P:Microsoft.OpenApi.Any.OpenApiString.PrimitiveType">
  373. <summary>
  374. The primitive class this object represents.
  375. </summary>
  376. </member>
  377. <member name="M:Microsoft.OpenApi.Any.OpenApiString.IsExplicit">
  378. <summary>
  379. True if string was specified explicitly by the means of double quotes, single quotes, or literal or folded style.
  380. </summary>
  381. </member>
  382. <member name="T:Microsoft.OpenApi.Attributes.DisplayAttribute">
  383. <summary>
  384. Represents the Open Api Data type metadata attribute.
  385. </summary>
  386. </member>
  387. <member name="M:Microsoft.OpenApi.Attributes.DisplayAttribute.#ctor(System.String)">
  388. <summary>
  389. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Attributes.DisplayAttribute"/> class.
  390. </summary>
  391. <param name="name">The display name.</param>
  392. </member>
  393. <member name="P:Microsoft.OpenApi.Attributes.DisplayAttribute.Name">
  394. <summary>
  395. The display Name.
  396. </summary>
  397. </member>
  398. <member name="T:Microsoft.OpenApi.Error">
  399. <summary>
  400. Utility class for creating and unwrapping <see cref="T:System.Exception"/> instances.
  401. </summary>
  402. </member>
  403. <member name="M:Microsoft.OpenApi.Error.Format(System.String,System.Object[])">
  404. <summary>
  405. Formats the specified resource string using <see cref="M:CultureInfo.CurrentCulture"/>.
  406. </summary>
  407. <param name="format">A composite format string.</param>
  408. <param name="args">An object array that contains zero or more objects to format.</param>
  409. <returns>The formatted string.</returns>
  410. </member>
  411. <member name="M:Microsoft.OpenApi.Error.Argument(System.String,System.Object[])">
  412. <summary>
  413. Creates an <see cref="T:System.ArgumentException"/> with the provided properties.
  414. </summary>
  415. <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
  416. <param name="messageArgs">An object array that contains zero or more objects to format.</param>
  417. <returns>The logged <see cref="T:System.Exception"/>.</returns>
  418. </member>
  419. <member name="M:Microsoft.OpenApi.Error.Argument(System.String,System.String,System.Object[])">
  420. <summary>
  421. Creates an <see cref="T:System.ArgumentException"/> with the provided properties.
  422. </summary>
  423. <param name="parameterName">The name of the parameter that caused the current exception.</param>
  424. <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
  425. <param name="messageArgs">An object array that contains zero or more objects to format.</param>
  426. <returns>The logged <see cref="T:System.Exception"/>.</returns>
  427. </member>
  428. <member name="M:Microsoft.OpenApi.Error.ArgumentNull(System.String)">
  429. <summary>
  430. Creates an <see cref="T:System.ArgumentNullException"/> with the provided properties.
  431. </summary>
  432. <param name="parameterName">The name of the parameter that caused the current exception.</param>
  433. <returns>The logged <see cref="T:System.Exception"/>.</returns>
  434. </member>
  435. <member name="M:Microsoft.OpenApi.Error.ArgumentNull(System.String,System.String,System.Object[])">
  436. <summary>
  437. Creates an <see cref="T:System.ArgumentNullException"/> with the provided properties.
  438. </summary>
  439. <param name="parameterName">The name of the parameter that caused the current exception.</param>
  440. <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
  441. <param name="messageArgs">An object array that contains zero or more objects to format.</param>
  442. <returns>The logged <see cref="T:System.Exception"/>.</returns>
  443. </member>
  444. <member name="M:Microsoft.OpenApi.Error.ArgumentNullOrWhiteSpace(System.String)">
  445. <summary>
  446. Creates an <see cref="T:System.ArgumentException"/> with a default message.
  447. </summary>
  448. <param name="parameterName">The name of the parameter that caused the current exception.</param>
  449. <returns>The logged <see cref="T:System.Exception"/>.</returns>
  450. </member>
  451. <member name="M:Microsoft.OpenApi.Error.NotSupported(System.String,System.Object[])">
  452. <summary>
  453. Creates an <see cref="T:System.NotSupportedException"/>.
  454. </summary>
  455. <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
  456. <param name="messageArgs">An object array that contains zero or more objects to format.</param>
  457. <returns>The logged <see cref="T:System.Exception"/>.</returns>
  458. </member>
  459. <member name="T:Microsoft.OpenApi.Exceptions.OpenApiException">
  460. <summary>
  461. Exception type representing exceptions in the Open API library.
  462. </summary>
  463. </member>
  464. <member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor">
  465. <summary>
  466. Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiException"/> class with default values.
  467. </summary>
  468. </member>
  469. <member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor(System.String)">
  470. <summary>
  471. Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiException"/> class with an error message.
  472. </summary>
  473. <param name="message">The plain text error message for this exception.</param>
  474. </member>
  475. <member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor(System.String,System.Exception)">
  476. <summary>
  477. Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiException"/> class with an error message and an inner exception.
  478. </summary>
  479. <param name="message">The plain text error message for this exception.</param>
  480. <param name="innerException">The inner exception that is the cause of this exception to be thrown.</param>
  481. </member>
  482. <member name="P:Microsoft.OpenApi.Exceptions.OpenApiException.Pointer">
  483. <summary>
  484. The reference pointer.
  485. </summary>
  486. </member>
  487. <member name="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException">
  488. <summary>
  489. Exception type representing exceptions in the OpenAPI writer.
  490. </summary>
  491. </member>
  492. <member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor">
  493. <summary>
  494. Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException"/> class with default values.
  495. </summary>
  496. </member>
  497. <member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor(System.String)">
  498. <summary>
  499. Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException"/> class with an error message.
  500. </summary>
  501. <param name="message">The plain text error message for this exception.</param>
  502. </member>
  503. <member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor(System.String,System.Exception)">
  504. <summary>
  505. Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException"/> class with an error message and an inner exception.
  506. </summary>
  507. <param name="message">The plain text error message for this exception.</param>
  508. <param name="innerException">The inner exception that is the cause of this exception to be thrown.</param>
  509. </member>
  510. <member name="T:Microsoft.OpenApi.Expressions.BodyExpression">
  511. <summary>
  512. Body expression.
  513. </summary>
  514. </member>
  515. <member name="F:Microsoft.OpenApi.Expressions.BodyExpression.Body">
  516. <summary>
  517. body string
  518. </summary>
  519. </member>
  520. <member name="F:Microsoft.OpenApi.Expressions.BodyExpression.PointerPrefix">
  521. <summary>
  522. Prefix for a pointer
  523. </summary>
  524. </member>
  525. <member name="M:Microsoft.OpenApi.Expressions.BodyExpression.#ctor">
  526. <summary>
  527. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.BodyExpression"/> class.
  528. </summary>
  529. </member>
  530. <member name="M:Microsoft.OpenApi.Expressions.BodyExpression.#ctor(Microsoft.OpenApi.JsonPointer)">
  531. <summary>
  532. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.BodyExpression"/> class.
  533. </summary>
  534. <param name="pointer">a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901).</param>
  535. </member>
  536. <member name="P:Microsoft.OpenApi.Expressions.BodyExpression.Expression">
  537. <summary>
  538. Gets the expression string.
  539. </summary>
  540. </member>
  541. <member name="P:Microsoft.OpenApi.Expressions.BodyExpression.Fragment">
  542. <summary>
  543. Gets the fragment string.
  544. </summary>
  545. </member>
  546. <member name="T:Microsoft.OpenApi.Expressions.CompositeExpression">
  547. <summary>
  548. String literal with embedded expressions
  549. </summary>
  550. </member>
  551. <member name="F:Microsoft.OpenApi.Expressions.CompositeExpression.ContainedExpressions">
  552. <summary>
  553. Expressions embedded into string literal
  554. </summary>
  555. </member>
  556. <member name="M:Microsoft.OpenApi.Expressions.CompositeExpression.#ctor(System.String)">
  557. <summary>
  558. Create a composite expression from a string literal with an embedded expression
  559. </summary>
  560. <param name="expression"></param>
  561. </member>
  562. <member name="P:Microsoft.OpenApi.Expressions.CompositeExpression.Expression">
  563. <summary>
  564. Return original string literal with embedded expression
  565. </summary>
  566. </member>
  567. <member name="T:Microsoft.OpenApi.Expressions.HeaderExpression">
  568. <summary>
  569. Header expression, The token identifier in header is case-insensitive.
  570. </summary>
  571. </member>
  572. <member name="F:Microsoft.OpenApi.Expressions.HeaderExpression.Header">
  573. <summary>
  574. header. string
  575. </summary>
  576. </member>
  577. <member name="M:Microsoft.OpenApi.Expressions.HeaderExpression.#ctor(System.String)">
  578. <summary>
  579. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.HeaderExpression"/> class.
  580. </summary>
  581. <param name="token">The token string, it's case-insensitive.</param>
  582. </member>
  583. <member name="P:Microsoft.OpenApi.Expressions.HeaderExpression.Expression">
  584. <summary>
  585. Gets the expression string.
  586. </summary>
  587. </member>
  588. <member name="P:Microsoft.OpenApi.Expressions.HeaderExpression.Token">
  589. <summary>
  590. Gets the token string.
  591. </summary>
  592. </member>
  593. <member name="T:Microsoft.OpenApi.Expressions.MethodExpression">
  594. <summary>
  595. Method expression.
  596. </summary>
  597. </member>
  598. <member name="F:Microsoft.OpenApi.Expressions.MethodExpression.Method">
  599. <summary>
  600. $method. string
  601. </summary>
  602. </member>
  603. <member name="P:Microsoft.OpenApi.Expressions.MethodExpression.Expression">
  604. <summary>
  605. Gets the expression string.
  606. </summary>
  607. </member>
  608. <member name="M:Microsoft.OpenApi.Expressions.MethodExpression.#ctor">
  609. <summary>
  610. Private constructor.
  611. </summary>
  612. </member>
  613. <member name="T:Microsoft.OpenApi.Expressions.PathExpression">
  614. <summary>
  615. Path expression, the name in path is case-sensitive.
  616. </summary>
  617. </member>
  618. <member name="F:Microsoft.OpenApi.Expressions.PathExpression.Path">
  619. <summary>
  620. path. string
  621. </summary>
  622. </member>
  623. <member name="M:Microsoft.OpenApi.Expressions.PathExpression.#ctor(System.String)">
  624. <summary>
  625. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.PathExpression"/> class.
  626. </summary>
  627. <param name="name">The name string, it's case-insensitive.</param>
  628. </member>
  629. <member name="P:Microsoft.OpenApi.Expressions.PathExpression.Expression">
  630. <summary>
  631. Gets the expression string.
  632. </summary>
  633. </member>
  634. <member name="P:Microsoft.OpenApi.Expressions.PathExpression.Name">
  635. <summary>
  636. Gets the name string.
  637. </summary>
  638. </member>
  639. <member name="T:Microsoft.OpenApi.Expressions.QueryExpression">
  640. <summary>
  641. Query expression, the name in query is case-sensitive.
  642. </summary>
  643. </member>
  644. <member name="F:Microsoft.OpenApi.Expressions.QueryExpression.Query">
  645. <summary>
  646. query. string
  647. </summary>
  648. </member>
  649. <member name="M:Microsoft.OpenApi.Expressions.QueryExpression.#ctor(System.String)">
  650. <summary>
  651. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.QueryExpression"/> class.
  652. </summary>
  653. <param name="name">The name string, it's case-insensitive.</param>
  654. </member>
  655. <member name="P:Microsoft.OpenApi.Expressions.QueryExpression.Expression">
  656. <summary>
  657. Gets the expression string.
  658. </summary>
  659. </member>
  660. <member name="P:Microsoft.OpenApi.Expressions.QueryExpression.Name">
  661. <summary>
  662. Gets the name string.
  663. </summary>
  664. </member>
  665. <member name="T:Microsoft.OpenApi.Expressions.RequestExpression">
  666. <summary>
  667. $request. expression.
  668. </summary>
  669. </member>
  670. <member name="F:Microsoft.OpenApi.Expressions.RequestExpression.Request">
  671. <summary>
  672. $request. string
  673. </summary>
  674. </member>
  675. <member name="M:Microsoft.OpenApi.Expressions.RequestExpression.#ctor(Microsoft.OpenApi.Expressions.SourceExpression)">
  676. <summary>
  677. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.RequestExpression"/> class.
  678. </summary>
  679. <param name="source">The source of the request.</param>
  680. </member>
  681. <member name="P:Microsoft.OpenApi.Expressions.RequestExpression.Expression">
  682. <summary>
  683. Gets the expression string.
  684. </summary>
  685. </member>
  686. <member name="P:Microsoft.OpenApi.Expressions.RequestExpression.Source">
  687. <summary>
  688. The <see cref="T:Microsoft.OpenApi.Expressions.SourceExpression"/> expression.
  689. </summary>
  690. </member>
  691. <member name="T:Microsoft.OpenApi.Expressions.ResponseExpression">
  692. <summary>
  693. $response. expression.
  694. </summary>
  695. </member>
  696. <member name="F:Microsoft.OpenApi.Expressions.ResponseExpression.Response">
  697. <summary>
  698. $response. string
  699. </summary>
  700. </member>
  701. <member name="M:Microsoft.OpenApi.Expressions.ResponseExpression.#ctor(Microsoft.OpenApi.Expressions.SourceExpression)">
  702. <summary>
  703. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.ResponseExpression"/> class.
  704. </summary>
  705. <param name="source">The source of the response.</param>
  706. </member>
  707. <member name="P:Microsoft.OpenApi.Expressions.ResponseExpression.Expression">
  708. <summary>
  709. Gets the expression string.
  710. </summary>
  711. </member>
  712. <member name="P:Microsoft.OpenApi.Expressions.ResponseExpression.Source">
  713. <summary>
  714. The <see cref="T:Microsoft.OpenApi.Expressions.SourceExpression"/> expression.
  715. </summary>
  716. </member>
  717. <member name="T:Microsoft.OpenApi.Expressions.RuntimeExpression">
  718. <summary>
  719. Base class for the Open API runtime expression.
  720. </summary>
  721. </member>
  722. <member name="F:Microsoft.OpenApi.Expressions.RuntimeExpression.Prefix">
  723. <summary>
  724. The dollar sign prefix for a runtime expression.
  725. </summary>
  726. </member>
  727. <member name="P:Microsoft.OpenApi.Expressions.RuntimeExpression.Expression">
  728. <summary>
  729. The expression string.
  730. </summary>
  731. </member>
  732. <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Build(System.String)">
  733. <summary>
  734. Build the runtime expression from input string.
  735. </summary>
  736. <param name="expression">The runtime expression.</param>
  737. <returns>The built runtime expression object.</returns>
  738. </member>
  739. <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.GetHashCode">
  740. <summary>
  741. GetHashCode implementation for IEquatable.
  742. </summary>
  743. </member>
  744. <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Equals(System.Object)">
  745. <summary>
  746. Equals implementation for IEquatable.
  747. </summary>
  748. </member>
  749. <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Equals(Microsoft.OpenApi.Expressions.RuntimeExpression)">
  750. <summary>
  751. Equals implementation for object of the same type.
  752. </summary>
  753. </member>
  754. <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.ToString">
  755. <inheritdoc />
  756. </member>
  757. <member name="T:Microsoft.OpenApi.Expressions.SourceExpression">
  758. <summary>
  759. Source expression.
  760. </summary>
  761. </member>
  762. <member name="M:Microsoft.OpenApi.Expressions.SourceExpression.#ctor(System.String)">
  763. <summary>
  764. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.QueryExpression"/> class.
  765. </summary>
  766. <param name="value">The value string.</param>
  767. </member>
  768. <member name="P:Microsoft.OpenApi.Expressions.SourceExpression.Value">
  769. <summary>
  770. Gets the expression string.
  771. </summary>
  772. </member>
  773. <member name="M:Microsoft.OpenApi.Expressions.SourceExpression.Build(System.String)">
  774. <summary>
  775. Build the source expression from input string.
  776. </summary>
  777. <param name="expression">The source expression.</param>
  778. <returns>The built source expression.</returns>
  779. </member>
  780. <member name="T:Microsoft.OpenApi.Expressions.StatusCodeExpression">
  781. <summary>
  782. StatusCode expression.
  783. </summary>
  784. </member>
  785. <member name="F:Microsoft.OpenApi.Expressions.StatusCodeExpression.StatusCode">
  786. <summary>
  787. $statusCode string.
  788. </summary>
  789. </member>
  790. <member name="P:Microsoft.OpenApi.Expressions.StatusCodeExpression.Expression">
  791. <summary>
  792. Gets the expression string.
  793. </summary>
  794. </member>
  795. <member name="M:Microsoft.OpenApi.Expressions.StatusCodeExpression.#ctor">
  796. <summary>
  797. Private constructor.
  798. </summary>
  799. </member>
  800. <member name="T:Microsoft.OpenApi.Expressions.UrlExpression">
  801. <summary>
  802. Url expression.
  803. </summary>
  804. </member>
  805. <member name="F:Microsoft.OpenApi.Expressions.UrlExpression.Url">
  806. <summary>
  807. $url string.
  808. </summary>
  809. </member>
  810. <member name="P:Microsoft.OpenApi.Expressions.UrlExpression.Expression">
  811. <summary>
  812. Gets the expression string.
  813. </summary>
  814. </member>
  815. <member name="M:Microsoft.OpenApi.Expressions.UrlExpression.#ctor">
  816. <summary>
  817. Private constructor.
  818. </summary>
  819. </member>
  820. <member name="T:Microsoft.OpenApi.Extensions.EnumExtensions">
  821. <summary>
  822. Enumeration type extension methods.
  823. </summary>
  824. </member>
  825. <member name="M:Microsoft.OpenApi.Extensions.EnumExtensions.GetAttributeOfType``1(System.Enum)">
  826. <summary>
  827. Gets an attribute on an enum field value.
  828. </summary>
  829. <typeparam name="T">The type of the attribute to retrieve.</typeparam>
  830. <param name="enumValue">The enum value.</param>
  831. <returns>
  832. The attribute of the specified type or null.
  833. </returns>
  834. </member>
  835. <member name="M:Microsoft.OpenApi.Extensions.EnumExtensions.GetDisplayName(System.Enum)">
  836. <summary>
  837. Gets the enum display name.
  838. </summary>
  839. <param name="enumValue">The enum value.</param>
  840. <returns>
  841. Use <see cref="T:Microsoft.OpenApi.Attributes.DisplayAttribute"/> if exists.
  842. Otherwise, use the standard string representation.
  843. </returns>
  844. </member>
  845. <member name="T:Microsoft.OpenApi.Extensions.OpenApiElementExtensions">
  846. <summary>
  847. Extension methods that apply across all OpenAPIElements
  848. </summary>
  849. </member>
  850. <member name="M:Microsoft.OpenApi.Extensions.OpenApiElementExtensions.Validate(Microsoft.OpenApi.Interfaces.IOpenApiElement,Microsoft.OpenApi.Validations.ValidationRuleSet)">
  851. <summary>
  852. Validate element and all child elements
  853. </summary>
  854. <param name="element">Element to validate</param>
  855. <param name="ruleSet">Optional set of rules to use for validation</param>
  856. <returns>An IEnumerable of errors. This function will never return null.</returns>
  857. </member>
  858. <member name="T:Microsoft.OpenApi.Extensions.OpenApiExtensibleExtensions">
  859. <summary>
  860. Extension methods to verify validatity and add an extension to Extensions property.
  861. </summary>
  862. </member>
  863. <member name="M:Microsoft.OpenApi.Extensions.OpenApiExtensibleExtensions.AddExtension``1(``0,System.String,Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
  864. <summary>
  865. Add extension into the Extensions
  866. </summary>
  867. <typeparam name="T"><see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>.</typeparam>
  868. <param name="element">The extensible Open API element. </param>
  869. <param name="name">The extension name.</param>
  870. <param name="any">The extension value.</param>
  871. </member>
  872. <member name="T:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions">
  873. <summary>
  874. Extension methods for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> serialization.
  875. </summary>
  876. </member>
  877. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsJson``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion)">
  878. <summary>
  879. Serialize the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document (JSON) using the given stream and specification version.
  880. </summary>
  881. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  882. <param name="element">The Open API element.</param>
  883. <param name="stream">The output stream.</param>
  884. <param name="specVersion">The Open API specification version.</param>
  885. </member>
  886. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsYaml``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion)">
  887. <summary>
  888. Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document (YAML) using the given stream and specification version.
  889. </summary>
  890. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  891. <param name="element">The Open API element.</param>
  892. <param name="stream">The output stream.</param>
  893. <param name="specVersion">The Open API specification version.</param>
  894. </member>
  895. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat)">
  896. <summary>
  897. Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document using
  898. the given stream, specification version and the format.
  899. </summary>
  900. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  901. <param name="element">The Open API element.</param>
  902. <param name="stream">The given stream.</param>
  903. <param name="specVersion">The Open API specification version.</param>
  904. <param name="format">The output format (JSON or YAML).</param>
  905. </member>
  906. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
  907. <summary>
  908. Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document using
  909. the given stream, specification version and the format.
  910. </summary>
  911. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  912. <param name="element">The Open API element.</param>
  913. <param name="stream">The given stream.</param>
  914. <param name="specVersion">The Open API specification version.</param>
  915. <param name="format">The output format (JSON or YAML).</param>
  916. <param name="settings">Provide configuration settings for controlling writing output</param>
  917. </member>
  918. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
  919. <summary>
  920. Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to Open API document using the given specification version and writer.
  921. </summary>
  922. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  923. <param name="element">The Open API element.</param>
  924. <param name="writer">The output writer.</param>
  925. <param name="specVersion">Version of the specification the output should conform to</param>
  926. </member>
  927. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsJson``1(``0,Microsoft.OpenApi.OpenApiSpecVersion)">
  928. <summary>
  929. Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in JSON format.
  930. </summary>
  931. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  932. <param name="element">The Open API element.</param>
  933. <param name="specVersion">The Open API specification version.</param>
  934. </member>
  935. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsYaml``1(``0,Microsoft.OpenApi.OpenApiSpecVersion)">
  936. <summary>
  937. Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in YAML format.
  938. </summary>
  939. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  940. <param name="element">The Open API element.</param>
  941. <param name="specVersion">The Open API specification version.</param>
  942. </member>
  943. <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat)">
  944. <summary>
  945. Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in the given format.
  946. </summary>
  947. <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
  948. <param name="element">The Open API element.</param>
  949. <param name="specVersion">The Open API specification version.</param>
  950. <param name="format">Open API document format.</param>
  951. </member>
  952. <member name="T:Microsoft.OpenApi.Extensions.StringExtensions">
  953. <summary>
  954. String extension methods.
  955. </summary>
  956. </member>
  957. <member name="M:Microsoft.OpenApi.Extensions.StringExtensions.GetEnumFromDisplayName``1(System.String)">
  958. <summary>
  959. Gets the enum value based on the given enum type and display name.
  960. </summary>
  961. <param name="displayName">The display name.</param>
  962. </member>
  963. <member name="M:Microsoft.OpenApi.OpenAPIWriterExtensions.GetSettings(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  964. <summary>
  965. Temporary extension method until we add Settings property to IOpenApiWriter in next major version
  966. </summary>
  967. <param name="openApiWriter"></param>
  968. <returns></returns>
  969. </member>
  970. <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiElement">
  971. <summary>
  972. Represents an Open API element.
  973. </summary>
  974. </member>
  975. <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible">
  976. <summary>
  977. Represents an Extensible Open API element.
  978. </summary>
  979. </member>
  980. <member name="P:Microsoft.OpenApi.Interfaces.IOpenApiExtensible.Extensions">
  981. <summary>
  982. Specification extensions.
  983. </summary>
  984. </member>
  985. <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension">
  986. <summary>
  987. Interface requuired for implementing any custom extension
  988. </summary>
  989. </member>
  990. <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiExtension.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
  991. <summary>
  992. Write out contents of custom extension
  993. </summary>
  994. <param name="writer"></param>
  995. <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
  996. </member>
  997. <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable">
  998. <summary>
  999. Represents an Open API element is referenceable.
  1000. </summary>
  1001. </member>
  1002. <member name="P:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.UnresolvedReference">
  1003. <summary>
  1004. Indicates if object is populated with data or is just a reference to the data
  1005. </summary>
  1006. </member>
  1007. <member name="P:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.Reference">
  1008. <summary>
  1009. Reference object.
  1010. </summary>
  1011. </member>
  1012. <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1013. <summary>
  1014. Serialize to OpenAPI V3 document without using reference.
  1015. </summary>
  1016. </member>
  1017. <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1018. <summary>
  1019. Serialize to OpenAPI V2 document without using reference.
  1020. </summary>
  1021. </member>
  1022. <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable">
  1023. <summary>
  1024. Represents an Open API element that comes with serialzation functionality.
  1025. </summary>
  1026. </member>
  1027. <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiSerializable.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1028. <summary>
  1029. Serialize Open API element to v3.0.
  1030. </summary>
  1031. <param name="writer">The writer.</param>
  1032. </member>
  1033. <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiSerializable.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1034. <summary>
  1035. Serialize Open API element to v2.0.
  1036. </summary>
  1037. <param name="writer">The writer.</param>
  1038. </member>
  1039. <member name="T:Microsoft.OpenApi.JsonPointer">
  1040. <summary>
  1041. JSON pointer.
  1042. </summary>
  1043. </member>
  1044. <member name="M:Microsoft.OpenApi.JsonPointer.#ctor(System.String)">
  1045. <summary>
  1046. Initializes the <see cref="T:Microsoft.OpenApi.JsonPointer"/> class.
  1047. </summary>
  1048. <param name="pointer">Pointer as string.</param>
  1049. </member>
  1050. <member name="M:Microsoft.OpenApi.JsonPointer.#ctor(System.String[])">
  1051. <summary>
  1052. Initializes the <see cref="T:Microsoft.OpenApi.JsonPointer"/> class.
  1053. </summary>
  1054. <param name="tokens">Pointer as tokenized string.</param>
  1055. </member>
  1056. <member name="P:Microsoft.OpenApi.JsonPointer.Tokens">
  1057. <summary>
  1058. Tokens.
  1059. </summary>
  1060. </member>
  1061. <member name="P:Microsoft.OpenApi.JsonPointer.ParentPointer">
  1062. <summary>
  1063. Gets the parent pointer.
  1064. </summary>
  1065. </member>
  1066. <member name="M:Microsoft.OpenApi.JsonPointer.Decode(System.String)">
  1067. <summary>
  1068. Decode the string.
  1069. </summary>
  1070. </member>
  1071. <member name="M:Microsoft.OpenApi.JsonPointer.ToString">
  1072. <summary>
  1073. Gets the string representation of this JSON pointer.
  1074. </summary>
  1075. </member>
  1076. <member name="T:Microsoft.OpenApi.Models.OpenApiCallback">
  1077. <summary>
  1078. Callback Object: A map of possible out-of band callbacks related to the parent operation.
  1079. </summary>
  1080. </member>
  1081. <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.PathItems">
  1082. <summary>
  1083. A Path Item Object used to define a callback request and expected responses.
  1084. </summary>
  1085. </member>
  1086. <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.UnresolvedReference">
  1087. <summary>
  1088. Indicates if object is populated with data or is just a reference to the data
  1089. </summary>
  1090. </member>
  1091. <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.Reference">
  1092. <summary>
  1093. Reference pointer.
  1094. </summary>
  1095. </member>
  1096. <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.Extensions">
  1097. <summary>
  1098. This object MAY be extended with Specification Extensions.
  1099. </summary>
  1100. </member>
  1101. <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.AddPathItem(Microsoft.OpenApi.Expressions.RuntimeExpression,Microsoft.OpenApi.Models.OpenApiPathItem)">
  1102. <summary>
  1103. Add a <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> into the <see cref="P:Microsoft.OpenApi.Models.OpenApiCallback.PathItems"/>.
  1104. </summary>
  1105. <param name="expression">The runtime expression.</param>
  1106. <param name="pathItem">The path item.</param>
  1107. </member>
  1108. <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1109. <summary>
  1110. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> to Open Api v3.0
  1111. </summary>
  1112. </member>
  1113. <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1114. <summary>
  1115. Serialize to OpenAPI V3 document without using reference.
  1116. </summary>
  1117. </member>
  1118. <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1119. <summary>
  1120. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> to Open Api v2.0
  1121. </summary>
  1122. </member>
  1123. <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1124. <summary>
  1125. Serialize to OpenAPI V2 document without using reference.
  1126. </summary>
  1127. </member>
  1128. <member name="T:Microsoft.OpenApi.Models.OpenApiComponents">
  1129. <summary>
  1130. Components Object.
  1131. </summary>
  1132. </member>
  1133. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Schemas">
  1134. <summary>
  1135. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> Objects.
  1136. </summary>
  1137. </member>
  1138. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Responses">
  1139. <summary>
  1140. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> Objects.
  1141. </summary>
  1142. </member>
  1143. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Parameters">
  1144. <summary>
  1145. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> Objects.
  1146. </summary>
  1147. </member>
  1148. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Examples">
  1149. <summary>
  1150. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> Objects.
  1151. </summary>
  1152. </member>
  1153. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.RequestBodies">
  1154. <summary>
  1155. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> Objects.
  1156. </summary>
  1157. </member>
  1158. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Headers">
  1159. <summary>
  1160. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> Objects.
  1161. </summary>
  1162. </member>
  1163. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.SecuritySchemes">
  1164. <summary>
  1165. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> Objects.
  1166. </summary>
  1167. </member>
  1168. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Links">
  1169. <summary>
  1170. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> Objects.
  1171. </summary>
  1172. </member>
  1173. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Callbacks">
  1174. <summary>
  1175. An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> Objects.
  1176. </summary>
  1177. </member>
  1178. <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Extensions">
  1179. <summary>
  1180. This object MAY be extended with Specification Extensions.
  1181. </summary>
  1182. </member>
  1183. <member name="M:Microsoft.OpenApi.Models.OpenApiComponents.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1184. <summary>
  1185. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> to Open Api v3.0.
  1186. </summary>
  1187. </member>
  1188. <member name="M:Microsoft.OpenApi.Models.OpenApiComponents.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1189. <summary>
  1190. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> to Open Api v2.0.
  1191. </summary>
  1192. </member>
  1193. <member name="T:Microsoft.OpenApi.Models.OpenApiConstants">
  1194. <summary>
  1195. Constants used in the Open API document.
  1196. </summary>
  1197. </member>
  1198. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OpenApi">
  1199. <summary>
  1200. Field: OpenApi
  1201. </summary>
  1202. </member>
  1203. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Info">
  1204. <summary>
  1205. Field: Info
  1206. </summary>
  1207. </member>
  1208. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Title">
  1209. <summary>
  1210. Field: Title
  1211. </summary>
  1212. </member>
  1213. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Type">
  1214. <summary>
  1215. Field: Type
  1216. </summary>
  1217. </member>
  1218. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Format">
  1219. <summary>
  1220. Field: Format
  1221. </summary>
  1222. </member>
  1223. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Version">
  1224. <summary>
  1225. Field: Version
  1226. </summary>
  1227. </member>
  1228. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Contact">
  1229. <summary>
  1230. Field: Contact
  1231. </summary>
  1232. </member>
  1233. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.License">
  1234. <summary>
  1235. Field: License
  1236. </summary>
  1237. </member>
  1238. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.TermsOfService">
  1239. <summary>
  1240. Field: TermsOfService
  1241. </summary>
  1242. </member>
  1243. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Servers">
  1244. <summary>
  1245. Field: Servers
  1246. </summary>
  1247. </member>
  1248. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Server">
  1249. <summary>
  1250. Field: Server
  1251. </summary>
  1252. </member>
  1253. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Paths">
  1254. <summary>
  1255. Field: Paths
  1256. </summary>
  1257. </member>
  1258. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Components">
  1259. <summary>
  1260. Field: Components
  1261. </summary>
  1262. </member>
  1263. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Security">
  1264. <summary>
  1265. Field: Security
  1266. </summary>
  1267. </member>
  1268. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Tags">
  1269. <summary>
  1270. Field: Tags
  1271. </summary>
  1272. </member>
  1273. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExternalDocs">
  1274. <summary>
  1275. Field: ExternalDocs
  1276. </summary>
  1277. </member>
  1278. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OperationRef">
  1279. <summary>
  1280. Field: OperationRef
  1281. </summary>
  1282. </member>
  1283. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OperationId">
  1284. <summary>
  1285. Field: OperationId
  1286. </summary>
  1287. </member>
  1288. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Parameters">
  1289. <summary>
  1290. Field: Parameters
  1291. </summary>
  1292. </member>
  1293. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RequestBody">
  1294. <summary>
  1295. Field: RequestBody
  1296. </summary>
  1297. </member>
  1298. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExtensionFieldNamePrefix">
  1299. <summary>
  1300. Field: ExtensionFieldNamePrefix
  1301. </summary>
  1302. </member>
  1303. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Name">
  1304. <summary>
  1305. Field: Name
  1306. </summary>
  1307. </member>
  1308. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Namespace">
  1309. <summary>
  1310. Field: Namespace
  1311. </summary>
  1312. </member>
  1313. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Prefix">
  1314. <summary>
  1315. Field: Prefix
  1316. </summary>
  1317. </member>
  1318. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Attribute">
  1319. <summary>
  1320. Field: Attribute
  1321. </summary>
  1322. </member>
  1323. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Wrapped">
  1324. <summary>
  1325. Field: Wrapped
  1326. </summary>
  1327. </member>
  1328. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.In">
  1329. <summary>
  1330. Field: In
  1331. </summary>
  1332. </member>
  1333. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Summary">
  1334. <summary>
  1335. Field: Summary
  1336. </summary>
  1337. </member>
  1338. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Variables">
  1339. <summary>
  1340. Field: Variables
  1341. </summary>
  1342. </member>
  1343. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Description">
  1344. <summary>
  1345. Field: Description
  1346. </summary>
  1347. </member>
  1348. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Required">
  1349. <summary>
  1350. Field: Required
  1351. </summary>
  1352. </member>
  1353. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Deprecated">
  1354. <summary>
  1355. Field: Deprecated
  1356. </summary>
  1357. </member>
  1358. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Style">
  1359. <summary>
  1360. Field: Style
  1361. </summary>
  1362. </member>
  1363. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Explode">
  1364. <summary>
  1365. Field: Explode
  1366. </summary>
  1367. </member>
  1368. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllowReserved">
  1369. <summary>
  1370. Field: AllowReserved
  1371. </summary>
  1372. </member>
  1373. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schema">
  1374. <summary>
  1375. Field: Schema
  1376. </summary>
  1377. </member>
  1378. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schemas">
  1379. <summary>
  1380. Field: Schemas
  1381. </summary>
  1382. </member>
  1383. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Responses">
  1384. <summary>
  1385. Field: Responses
  1386. </summary>
  1387. </member>
  1388. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Example">
  1389. <summary>
  1390. Field: Example
  1391. </summary>
  1392. </member>
  1393. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Examples">
  1394. <summary>
  1395. Field: Examples
  1396. </summary>
  1397. </member>
  1398. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Encoding">
  1399. <summary>
  1400. Field: Encoding
  1401. </summary>
  1402. </member>
  1403. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RequestBodies">
  1404. <summary>
  1405. Field: RequestBodies
  1406. </summary>
  1407. </member>
  1408. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllowEmptyValue">
  1409. <summary>
  1410. Field: AllowEmptyValue
  1411. </summary>
  1412. </member>
  1413. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Value">
  1414. <summary>
  1415. Field: Value
  1416. </summary>
  1417. </member>
  1418. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExternalValue">
  1419. <summary>
  1420. Field: ExternalValue
  1421. </summary>
  1422. </member>
  1423. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DollarRef">
  1424. <summary>
  1425. Field: DollarRef
  1426. </summary>
  1427. </member>
  1428. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Headers">
  1429. <summary>
  1430. Field: Headers
  1431. </summary>
  1432. </member>
  1433. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.SecuritySchemes">
  1434. <summary>
  1435. Field: SecuritySchemes
  1436. </summary>
  1437. </member>
  1438. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Content">
  1439. <summary>
  1440. Field: Content
  1441. </summary>
  1442. </member>
  1443. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Links">
  1444. <summary>
  1445. Field: Links
  1446. </summary>
  1447. </member>
  1448. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Callbacks">
  1449. <summary>
  1450. Field: Callbacks
  1451. </summary>
  1452. </member>
  1453. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Url">
  1454. <summary>
  1455. Field: Url
  1456. </summary>
  1457. </member>
  1458. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Email">
  1459. <summary>
  1460. Field: Email
  1461. </summary>
  1462. </member>
  1463. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Default">
  1464. <summary>
  1465. Field: Default
  1466. </summary>
  1467. </member>
  1468. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Enum">
  1469. <summary>
  1470. Field: Enum
  1471. </summary>
  1472. </member>
  1473. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MultipleOf">
  1474. <summary>
  1475. Field: MultipleOf
  1476. </summary>
  1477. </member>
  1478. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Maximum">
  1479. <summary>
  1480. Field: Maximum
  1481. </summary>
  1482. </member>
  1483. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExclusiveMaximum">
  1484. <summary>
  1485. Field: ExclusiveMaximum
  1486. </summary>
  1487. </member>
  1488. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Minimum">
  1489. <summary>
  1490. Field: Minimum
  1491. </summary>
  1492. </member>
  1493. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExclusiveMinimum">
  1494. <summary>
  1495. Field: ExclusiveMinimum
  1496. </summary>
  1497. </member>
  1498. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxLength">
  1499. <summary>
  1500. Field: MaxLength
  1501. </summary>
  1502. </member>
  1503. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinLength">
  1504. <summary>
  1505. Field: MinLength
  1506. </summary>
  1507. </member>
  1508. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Pattern">
  1509. <summary>
  1510. Field: Pattern
  1511. </summary>
  1512. </member>
  1513. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxItems">
  1514. <summary>
  1515. Field: MaxItems
  1516. </summary>
  1517. </member>
  1518. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinItems">
  1519. <summary>
  1520. Field: MinItems
  1521. </summary>
  1522. </member>
  1523. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.UniqueItems">
  1524. <summary>
  1525. Field: UniqueItems
  1526. </summary>
  1527. </member>
  1528. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxProperties">
  1529. <summary>
  1530. Field: MaxProperties
  1531. </summary>
  1532. </member>
  1533. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinProperties">
  1534. <summary>
  1535. Field: MinProperties
  1536. </summary>
  1537. </member>
  1538. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllOf">
  1539. <summary>
  1540. Field: AllOf
  1541. </summary>
  1542. </member>
  1543. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OneOf">
  1544. <summary>
  1545. Field: OneOf
  1546. </summary>
  1547. </member>
  1548. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AnyOf">
  1549. <summary>
  1550. Field: AnyOf
  1551. </summary>
  1552. </member>
  1553. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Not">
  1554. <summary>
  1555. Field: Not
  1556. </summary>
  1557. </member>
  1558. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Items">
  1559. <summary>
  1560. Field: Items
  1561. </summary>
  1562. </member>
  1563. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Properties">
  1564. <summary>
  1565. Field: Properties
  1566. </summary>
  1567. </member>
  1568. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AdditionalProperties">
  1569. <summary>
  1570. Field: AdditionalProperties
  1571. </summary>
  1572. </member>
  1573. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Nullable">
  1574. <summary>
  1575. Field: Nullable
  1576. </summary>
  1577. </member>
  1578. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Discriminator">
  1579. <summary>
  1580. Field: Discriminator
  1581. </summary>
  1582. </member>
  1583. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ReadOnly">
  1584. <summary>
  1585. Field: ReadOnly
  1586. </summary>
  1587. </member>
  1588. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.WriteOnly">
  1589. <summary>
  1590. Field: WriteOnly
  1591. </summary>
  1592. </member>
  1593. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Xml">
  1594. <summary>
  1595. Field: Xml
  1596. </summary>
  1597. </member>
  1598. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Flow">
  1599. <summary>
  1600. Field: Flow
  1601. </summary>
  1602. </member>
  1603. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Application">
  1604. <summary>
  1605. Field: Application
  1606. </summary>
  1607. </member>
  1608. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AccessCode">
  1609. <summary>
  1610. Field: AccessCode
  1611. </summary>
  1612. </member>
  1613. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Implicit">
  1614. <summary>
  1615. Field: Implicit
  1616. </summary>
  1617. </member>
  1618. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Password">
  1619. <summary>
  1620. Field: Password
  1621. </summary>
  1622. </member>
  1623. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ClientCredentials">
  1624. <summary>
  1625. Field: ClientCredentials
  1626. </summary>
  1627. </member>
  1628. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AuthorizationCode">
  1629. <summary>
  1630. Field: AuthorizationCode
  1631. </summary>
  1632. </member>
  1633. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AuthorizationUrl">
  1634. <summary>
  1635. Field: AuthorizationUrl
  1636. </summary>
  1637. </member>
  1638. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.TokenUrl">
  1639. <summary>
  1640. Field: TokenUrl
  1641. </summary>
  1642. </member>
  1643. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RefreshUrl">
  1644. <summary>
  1645. Field: RefreshUrl
  1646. </summary>
  1647. </member>
  1648. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Scopes">
  1649. <summary>
  1650. Field: Scopes
  1651. </summary>
  1652. </member>
  1653. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ContentType">
  1654. <summary>
  1655. Field: ContentType
  1656. </summary>
  1657. </member>
  1658. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Get">
  1659. <summary>
  1660. Field: Get
  1661. </summary>
  1662. </member>
  1663. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Put">
  1664. <summary>
  1665. Field: Put
  1666. </summary>
  1667. </member>
  1668. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Post">
  1669. <summary>
  1670. Field: Post
  1671. </summary>
  1672. </member>
  1673. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Delete">
  1674. <summary>
  1675. Field: Delete
  1676. </summary>
  1677. </member>
  1678. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Options">
  1679. <summary>
  1680. Field: Options
  1681. </summary>
  1682. </member>
  1683. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Head">
  1684. <summary>
  1685. Field: Head
  1686. </summary>
  1687. </member>
  1688. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Patch">
  1689. <summary>
  1690. Field: Patch
  1691. </summary>
  1692. </member>
  1693. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Trace">
  1694. <summary>
  1695. Field: Trace
  1696. </summary>
  1697. </member>
  1698. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.PropertyName">
  1699. <summary>
  1700. Field: PropertyName
  1701. </summary>
  1702. </member>
  1703. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Mapping">
  1704. <summary>
  1705. Field: Mapping
  1706. </summary>
  1707. </member>
  1708. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Scheme">
  1709. <summary>
  1710. Field: Scheme
  1711. </summary>
  1712. </member>
  1713. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BearerFormat">
  1714. <summary>
  1715. Field: BearerFormat
  1716. </summary>
  1717. </member>
  1718. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Flows">
  1719. <summary>
  1720. Field: Flows
  1721. </summary>
  1722. </member>
  1723. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OpenIdConnectUrl">
  1724. <summary>
  1725. Field: OpenIdConnectUrl
  1726. </summary>
  1727. </member>
  1728. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultName">
  1729. <summary>
  1730. Field: DefaultName
  1731. </summary>
  1732. </member>
  1733. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultDefault">
  1734. <summary>
  1735. Field: DefaultDefault
  1736. </summary>
  1737. </member>
  1738. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultTitle">
  1739. <summary>
  1740. Field: DefaultTitle
  1741. </summary>
  1742. </member>
  1743. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultDescription">
  1744. <summary>
  1745. Field: DefaultDescription
  1746. </summary>
  1747. </member>
  1748. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BodyName">
  1749. <summary>
  1750. Field: BodyName extensions
  1751. </summary>
  1752. </member>
  1753. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.version3_0_0">
  1754. <summary>
  1755. Field: version3_0_0
  1756. </summary>
  1757. </member>
  1758. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.defaultUrl">
  1759. <summary>
  1760. Field: defaultUrl
  1761. </summary>
  1762. </member>
  1763. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Host">
  1764. <summary>
  1765. Field: Host
  1766. </summary>
  1767. </member>
  1768. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Swagger">
  1769. <summary>
  1770. Field: Swagger
  1771. </summary>
  1772. </member>
  1773. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.version2_0">
  1774. <summary>
  1775. Field: version2_0
  1776. </summary>
  1777. </member>
  1778. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BasePath">
  1779. <summary>
  1780. Field: BasePath
  1781. </summary>
  1782. </member>
  1783. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schemes">
  1784. <summary>
  1785. Field: Schemes
  1786. </summary>
  1787. </member>
  1788. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.SecurityDefinitions">
  1789. <summary>
  1790. Field: SecurityDefinitions
  1791. </summary>
  1792. </member>
  1793. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Definitions">
  1794. <summary>
  1795. Field: Definitions
  1796. </summary>
  1797. </member>
  1798. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Basic">
  1799. <summary>
  1800. Field: Basic
  1801. </summary>
  1802. </member>
  1803. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Consumes">
  1804. <summary>
  1805. Field: Consumes
  1806. </summary>
  1807. </member>
  1808. <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Produces">
  1809. <summary>
  1810. Field: Produces
  1811. </summary>
  1812. </member>
  1813. <member name="T:Microsoft.OpenApi.Models.OpenApiContact">
  1814. <summary>
  1815. Contact Object.
  1816. </summary>
  1817. </member>
  1818. <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Name">
  1819. <summary>
  1820. The identifying name of the contact person/organization.
  1821. </summary>
  1822. </member>
  1823. <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Url">
  1824. <summary>
  1825. The URL pointing to the contact information. MUST be in the format of a URL.
  1826. </summary>
  1827. </member>
  1828. <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Email">
  1829. <summary>
  1830. The email address of the contact person/organization.
  1831. MUST be in the format of an email address.
  1832. </summary>
  1833. </member>
  1834. <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Extensions">
  1835. <summary>
  1836. This object MAY be extended with Specification Extensions.
  1837. </summary>
  1838. </member>
  1839. <member name="M:Microsoft.OpenApi.Models.OpenApiContact.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1840. <summary>
  1841. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> to Open Api v3.0
  1842. </summary>
  1843. </member>
  1844. <member name="M:Microsoft.OpenApi.Models.OpenApiContact.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1845. <summary>
  1846. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> to Open Api v2.0
  1847. </summary>
  1848. </member>
  1849. <member name="T:Microsoft.OpenApi.Models.OpenApiDiscriminator">
  1850. <summary>
  1851. Discriminator object.
  1852. </summary>
  1853. </member>
  1854. <member name="P:Microsoft.OpenApi.Models.OpenApiDiscriminator.PropertyName">
  1855. <summary>
  1856. REQUIRED. The name of the property in the payload that will hold the discriminator value.
  1857. </summary>
  1858. </member>
  1859. <member name="P:Microsoft.OpenApi.Models.OpenApiDiscriminator.Mapping">
  1860. <summary>
  1861. An object to hold mappings between payload values and schema names or references.
  1862. </summary>
  1863. </member>
  1864. <member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1865. <summary>
  1866. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDiscriminator"/> to Open Api v3.0
  1867. </summary>
  1868. </member>
  1869. <member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1870. <summary>
  1871. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDiscriminator"/> to Open Api v2.0
  1872. </summary>
  1873. </member>
  1874. <member name="T:Microsoft.OpenApi.Models.OpenApiDocument">
  1875. <summary>
  1876. Describes an OpenAPI object (OpenAPI document). See: https://swagger.io/specification
  1877. </summary>
  1878. </member>
  1879. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Info">
  1880. <summary>
  1881. REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
  1882. </summary>
  1883. </member>
  1884. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Servers">
  1885. <summary>
  1886. An array of Server Objects, which provide connectivity information to a target server.
  1887. </summary>
  1888. </member>
  1889. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Paths">
  1890. <summary>
  1891. REQUIRED. The available paths and operations for the API.
  1892. </summary>
  1893. </member>
  1894. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Components">
  1895. <summary>
  1896. An element to hold various schemas for the specification.
  1897. </summary>
  1898. </member>
  1899. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.SecurityRequirements">
  1900. <summary>
  1901. A declaration of which security mechanisms can be used across the API.
  1902. </summary>
  1903. </member>
  1904. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Tags">
  1905. <summary>
  1906. A list of tags used by the specification with additional metadata.
  1907. </summary>
  1908. </member>
  1909. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.ExternalDocs">
  1910. <summary>
  1911. Additional external documentation.
  1912. </summary>
  1913. </member>
  1914. <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Extensions">
  1915. <summary>
  1916. This object MAY be extended with Specification Extensions.
  1917. </summary>
  1918. </member>
  1919. <member name="M:Microsoft.OpenApi.Models.OpenApiDocument.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1920. <summary>
  1921. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> to the latest patch of OpenAPI object V3.0.
  1922. </summary>
  1923. </member>
  1924. <member name="M:Microsoft.OpenApi.Models.OpenApiDocument.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1925. <summary>
  1926. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> to OpenAPI object V2.0.
  1927. </summary>
  1928. </member>
  1929. <member name="M:Microsoft.OpenApi.Models.OpenApiDocument.ResolveReference(Microsoft.OpenApi.Models.OpenApiReference)">
  1930. <summary>
  1931. Load the referenced <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable"/> object from a <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> object
  1932. </summary>
  1933. </member>
  1934. <member name="T:Microsoft.OpenApi.Models.OpenApiEncoding">
  1935. <summary>
  1936. ExternalDocs object.
  1937. </summary>
  1938. </member>
  1939. <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.ContentType">
  1940. <summary>
  1941. The Content-Type for encoding a specific property.
  1942. The value can be a specific media type (e.g. application/json),
  1943. a wildcard media type (e.g. image/*), or a comma-separated list of the two types.
  1944. </summary>
  1945. </member>
  1946. <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Headers">
  1947. <summary>
  1948. A map allowing additional information to be provided as headers.
  1949. </summary>
  1950. </member>
  1951. <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Style">
  1952. <summary>
  1953. Describes how a specific property value will be serialized depending on its type.
  1954. </summary>
  1955. </member>
  1956. <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Explode">
  1957. <summary>
  1958. When this is true, property values of type array or object generate separate parameters
  1959. for each value of the array, or key-value-pair of the map. For other types of properties
  1960. this property has no effect. When style is form, the default value is true.
  1961. For all other styles, the default value is false.
  1962. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
  1963. </summary>
  1964. </member>
  1965. <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.AllowReserved">
  1966. <summary>
  1967. Determines whether the parameter value SHOULD allow reserved characters,
  1968. as defined by RFC3986 :/?#[]@!$&amp;'()*+,;= to be included without percent-encoding.
  1969. The default value is false. This property SHALL be ignored
  1970. if the request body media type is not application/x-www-form-urlencoded.
  1971. </summary>
  1972. </member>
  1973. <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Extensions">
  1974. <summary>
  1975. This object MAY be extended with Specification Extensions.
  1976. </summary>
  1977. </member>
  1978. <member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1979. <summary>
  1980. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
  1981. </summary>
  1982. </member>
  1983. <member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  1984. <summary>
  1985. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v2.0.
  1986. </summary>
  1987. </member>
  1988. <member name="T:Microsoft.OpenApi.Models.OpenApiError">
  1989. <summary>
  1990. Error related to the Open API Document.
  1991. </summary>
  1992. </member>
  1993. <member name="M:Microsoft.OpenApi.Models.OpenApiError.#ctor(Microsoft.OpenApi.Exceptions.OpenApiException)">
  1994. <summary>
  1995. Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class using the message and pointer from the given exception.
  1996. </summary>
  1997. </member>
  1998. <member name="M:Microsoft.OpenApi.Models.OpenApiError.#ctor(System.String,System.String)">
  1999. <summary>
  2000. Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class.
  2001. </summary>
  2002. </member>
  2003. <member name="P:Microsoft.OpenApi.Models.OpenApiError.Message">
  2004. <summary>
  2005. Message explaining the error.
  2006. </summary>
  2007. </member>
  2008. <member name="P:Microsoft.OpenApi.Models.OpenApiError.Pointer">
  2009. <summary>
  2010. Pointer to the location of the error.
  2011. </summary>
  2012. </member>
  2013. <member name="M:Microsoft.OpenApi.Models.OpenApiError.ToString">
  2014. <summary>
  2015. Gets the string representation of <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/>.
  2016. </summary>
  2017. </member>
  2018. <member name="T:Microsoft.OpenApi.Models.OpenApiExample">
  2019. <summary>
  2020. Example Object.
  2021. </summary>
  2022. </member>
  2023. <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Summary">
  2024. <summary>
  2025. Short description for the example.
  2026. </summary>
  2027. </member>
  2028. <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Description">
  2029. <summary>
  2030. Long description for the example.
  2031. CommonMark syntax MAY be used for rich text representation.
  2032. </summary>
  2033. </member>
  2034. <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Value">
  2035. <summary>
  2036. Embedded literal example. The value field and externalValue field are mutually
  2037. exclusive. To represent examples of media types that cannot naturally represented
  2038. in JSON or YAML, use a string value to contain the example, escaping where necessary.
  2039. </summary>
  2040. </member>
  2041. <member name="P:Microsoft.OpenApi.Models.OpenApiExample.ExternalValue">
  2042. <summary>
  2043. A URL that points to the literal example.
  2044. This provides the capability to reference examples that cannot easily be
  2045. included in JSON or YAML documents.
  2046. The value field and externalValue field are mutually exclusive.
  2047. </summary>
  2048. </member>
  2049. <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Extensions">
  2050. <summary>
  2051. This object MAY be extended with Specification Extensions.
  2052. </summary>
  2053. </member>
  2054. <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Reference">
  2055. <summary>
  2056. Reference object.
  2057. </summary>
  2058. </member>
  2059. <member name="P:Microsoft.OpenApi.Models.OpenApiExample.UnresolvedReference">
  2060. <summary>
  2061. Indicates object is a placeholder reference to an actual object and does not contain valid data.
  2062. </summary>
  2063. </member>
  2064. <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2065. <summary>
  2066. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> to Open Api v3.0
  2067. </summary>
  2068. </member>
  2069. <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2070. <summary>
  2071. Serialize to OpenAPI V3 document without using reference.
  2072. </summary>
  2073. </member>
  2074. <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2075. <summary>
  2076. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> to Open Api v2.0
  2077. </summary>
  2078. </member>
  2079. <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2080. <summary>
  2081. Serialize to OpenAPI V2 document without using reference.
  2082. </summary>
  2083. </member>
  2084. <member name="T:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1">
  2085. <summary>
  2086. Generic dictionary type for Open API dictionary element.
  2087. </summary>
  2088. <typeparam name="T">The Open API element, <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  2089. </member>
  2090. <member name="P:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.Extensions">
  2091. <summary>
  2092. This object MAY be extended with Specification Extensions.
  2093. </summary>
  2094. </member>
  2095. <member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2096. <summary>
  2097. Serialize to Open Api v3.0
  2098. </summary>
  2099. </member>
  2100. <member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2101. <summary>
  2102. Serialize to Open Api v2.0
  2103. </summary>
  2104. </member>
  2105. <member name="T:Microsoft.OpenApi.Models.OpenApiExternalDocs">
  2106. <summary>
  2107. ExternalDocs object.
  2108. </summary>
  2109. </member>
  2110. <member name="P:Microsoft.OpenApi.Models.OpenApiExternalDocs.Description">
  2111. <summary>
  2112. A short description of the target documentation.
  2113. </summary>
  2114. </member>
  2115. <member name="P:Microsoft.OpenApi.Models.OpenApiExternalDocs.Url">
  2116. <summary>
  2117. REQUIRED. The URL for the target documentation. Value MUST be in the format of a URL.
  2118. </summary>
  2119. </member>
  2120. <member name="P:Microsoft.OpenApi.Models.OpenApiExternalDocs.Extensions">
  2121. <summary>
  2122. This object MAY be extended with Specification Extensions.
  2123. </summary>
  2124. </member>
  2125. <member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2126. <summary>
  2127. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
  2128. </summary>
  2129. </member>
  2130. <member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2131. <summary>
  2132. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v2.0.
  2133. </summary>
  2134. </member>
  2135. <member name="T:Microsoft.OpenApi.Models.OpenApiHeader">
  2136. <summary>
  2137. Header Object.
  2138. The Header Object follows the structure of the Parameter Object.
  2139. </summary>
  2140. </member>
  2141. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.UnresolvedReference">
  2142. <summary>
  2143. Indicates if object is populated with data or is just a reference to the data
  2144. </summary>
  2145. </member>
  2146. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Reference">
  2147. <summary>
  2148. Reference pointer.
  2149. </summary>
  2150. </member>
  2151. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Description">
  2152. <summary>
  2153. A brief description of the header.
  2154. </summary>
  2155. </member>
  2156. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Required">
  2157. <summary>
  2158. Determines whether this header is mandatory.
  2159. </summary>
  2160. </member>
  2161. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Deprecated">
  2162. <summary>
  2163. Specifies that a header is deprecated and SHOULD be transitioned out of usage.
  2164. </summary>
  2165. </member>
  2166. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.AllowEmptyValue">
  2167. <summary>
  2168. Sets the ability to pass empty-valued headers.
  2169. </summary>
  2170. </member>
  2171. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Style">
  2172. <summary>
  2173. Describes how the header value will be serialized depending on the type of the header value.
  2174. </summary>
  2175. </member>
  2176. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Explode">
  2177. <summary>
  2178. When this is true, header values of type array or object generate separate parameters
  2179. for each value of the array or key-value pair of the map.
  2180. </summary>
  2181. </member>
  2182. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.AllowReserved">
  2183. <summary>
  2184. Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986.
  2185. </summary>
  2186. </member>
  2187. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Schema">
  2188. <summary>
  2189. The schema defining the type used for the header.
  2190. </summary>
  2191. </member>
  2192. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Example">
  2193. <summary>
  2194. Example of the media type.
  2195. </summary>
  2196. </member>
  2197. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Examples">
  2198. <summary>
  2199. Examples of the media type.
  2200. </summary>
  2201. </member>
  2202. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Content">
  2203. <summary>
  2204. A map containing the representations for the header.
  2205. </summary>
  2206. </member>
  2207. <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Extensions">
  2208. <summary>
  2209. This object MAY be extended with Specification Extensions.
  2210. </summary>
  2211. </member>
  2212. <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2213. <summary>
  2214. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> to Open Api v3.0
  2215. </summary>
  2216. </member>
  2217. <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2218. <summary>
  2219. Serialize to OpenAPI V3 document without using reference.
  2220. </summary>
  2221. </member>
  2222. <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2223. <summary>
  2224. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> to Open Api v2.0
  2225. </summary>
  2226. </member>
  2227. <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2228. <summary>
  2229. Serialize to OpenAPI V2 document without using reference.
  2230. </summary>
  2231. </member>
  2232. <member name="T:Microsoft.OpenApi.Models.OpenApiInfo">
  2233. <summary>
  2234. Open API Info Object, it provides the metadata about the Open API.
  2235. </summary>
  2236. </member>
  2237. <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Title">
  2238. <summary>
  2239. REQUIRED. The title of the application.
  2240. </summary>
  2241. </member>
  2242. <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Description">
  2243. <summary>
  2244. A short description of the application.
  2245. </summary>
  2246. </member>
  2247. <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Version">
  2248. <summary>
  2249. REQUIRED. The version of the OpenAPI document.
  2250. </summary>
  2251. </member>
  2252. <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.TermsOfService">
  2253. <summary>
  2254. A URL to the Terms of Service for the API. MUST be in the format of a URL.
  2255. </summary>
  2256. </member>
  2257. <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Contact">
  2258. <summary>
  2259. The contact information for the exposed API.
  2260. </summary>
  2261. </member>
  2262. <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.License">
  2263. <summary>
  2264. The license information for the exposed API.
  2265. </summary>
  2266. </member>
  2267. <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Extensions">
  2268. <summary>
  2269. This object MAY be extended with Specification Extensions.
  2270. </summary>
  2271. </member>
  2272. <member name="M:Microsoft.OpenApi.Models.OpenApiInfo.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2273. <summary>
  2274. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> to Open Api v3.0
  2275. </summary>
  2276. </member>
  2277. <member name="M:Microsoft.OpenApi.Models.OpenApiInfo.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2278. <summary>
  2279. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> to Open Api v2.0
  2280. </summary>
  2281. </member>
  2282. <member name="T:Microsoft.OpenApi.Models.OpenApiLicense">
  2283. <summary>
  2284. License Object.
  2285. </summary>
  2286. </member>
  2287. <member name="P:Microsoft.OpenApi.Models.OpenApiLicense.Name">
  2288. <summary>
  2289. REQUIRED. The license name used for the API.
  2290. </summary>
  2291. </member>
  2292. <member name="P:Microsoft.OpenApi.Models.OpenApiLicense.Url">
  2293. <summary>
  2294. The URL pointing to the contact information. MUST be in the format of a URL.
  2295. </summary>
  2296. </member>
  2297. <member name="P:Microsoft.OpenApi.Models.OpenApiLicense.Extensions">
  2298. <summary>
  2299. This object MAY be extended with Specification Extensions.
  2300. </summary>
  2301. </member>
  2302. <member name="M:Microsoft.OpenApi.Models.OpenApiLicense.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2303. <summary>
  2304. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> to Open Api v3.0
  2305. </summary>
  2306. </member>
  2307. <member name="M:Microsoft.OpenApi.Models.OpenApiLicense.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2308. <summary>
  2309. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> to Open Api v2.0
  2310. </summary>
  2311. </member>
  2312. <member name="T:Microsoft.OpenApi.Models.OpenApiLink">
  2313. <summary>
  2314. Link Object.
  2315. </summary>
  2316. </member>
  2317. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.OperationRef">
  2318. <summary>
  2319. A relative or absolute reference to an OAS operation.
  2320. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object.
  2321. </summary>
  2322. </member>
  2323. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.OperationId">
  2324. <summary>
  2325. The name of an existing, resolvable OAS operation, as defined with a unique operationId.
  2326. This field is mutually exclusive of the operationRef field.
  2327. </summary>
  2328. </member>
  2329. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Parameters">
  2330. <summary>
  2331. A map representing parameters to pass to an operation as specified with operationId or identified via operationRef.
  2332. </summary>
  2333. </member>
  2334. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.RequestBody">
  2335. <summary>
  2336. A literal value or {expression} to use as a request body when calling the target operation.
  2337. </summary>
  2338. </member>
  2339. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Description">
  2340. <summary>
  2341. A description of the link.
  2342. </summary>
  2343. </member>
  2344. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Server">
  2345. <summary>
  2346. A server object to be used by the target operation.
  2347. </summary>
  2348. </member>
  2349. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Extensions">
  2350. <summary>
  2351. This object MAY be extended with Specification Extensions.
  2352. </summary>
  2353. </member>
  2354. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.UnresolvedReference">
  2355. <summary>
  2356. Indicates if object is populated with data or is just a reference to the data
  2357. </summary>
  2358. </member>
  2359. <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Reference">
  2360. <summary>
  2361. Reference pointer.
  2362. </summary>
  2363. </member>
  2364. <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2365. <summary>
  2366. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> to Open Api v3.0
  2367. </summary>
  2368. </member>
  2369. <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2370. <summary>
  2371. Serialize to OpenAPI V3 document without using reference.
  2372. </summary>
  2373. </member>
  2374. <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2375. <summary>
  2376. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> to Open Api v2.0
  2377. </summary>
  2378. </member>
  2379. <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2380. <summary>
  2381. Serialize to OpenAPI V2 document without using reference.
  2382. </summary>
  2383. </member>
  2384. <member name="T:Microsoft.OpenApi.Models.OpenApiMediaType">
  2385. <summary>
  2386. Media Type Object.
  2387. </summary>
  2388. </member>
  2389. <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Schema">
  2390. <summary>
  2391. The schema defining the type used for the request body.
  2392. </summary>
  2393. </member>
  2394. <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Example">
  2395. <summary>
  2396. Example of the media type.
  2397. The example object SHOULD be in the correct format as specified by the media type.
  2398. </summary>
  2399. </member>
  2400. <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Examples">
  2401. <summary>
  2402. Examples of the media type.
  2403. Each example object SHOULD match the media type and specified schema if present.
  2404. </summary>
  2405. </member>
  2406. <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Encoding">
  2407. <summary>
  2408. A map between a property name and its encoding information.
  2409. The key, being the property name, MUST exist in the schema as a property.
  2410. The encoding object SHALL only apply to requestBody objects
  2411. when the media type is multipart or application/x-www-form-urlencoded.
  2412. </summary>
  2413. </member>
  2414. <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Extensions">
  2415. <summary>
  2416. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
  2417. </summary>
  2418. </member>
  2419. <member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2420. <summary>
  2421. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> to Open Api v3.0.
  2422. </summary>
  2423. </member>
  2424. <member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2425. <summary>
  2426. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> to Open Api v2.0.
  2427. </summary>
  2428. </member>
  2429. <member name="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow">
  2430. <summary>
  2431. OAuth Flow Object.
  2432. </summary>
  2433. </member>
  2434. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.AuthorizationUrl">
  2435. <summary>
  2436. REQUIRED. The authorization URL to be used for this flow.
  2437. Applies to implicit and authorizationCode OAuthFlow.
  2438. </summary>
  2439. </member>
  2440. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.TokenUrl">
  2441. <summary>
  2442. REQUIRED. The token URL to be used for this flow.
  2443. Applies to password, clientCredentials, and authorizationCode OAuthFlow.
  2444. </summary>
  2445. </member>
  2446. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.RefreshUrl">
  2447. <summary>
  2448. The URL to be used for obtaining refresh tokens.
  2449. </summary>
  2450. </member>
  2451. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.Scopes">
  2452. <summary>
  2453. REQUIRED. A map between the scope name and a short description for it.
  2454. </summary>
  2455. </member>
  2456. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.Extensions">
  2457. <summary>
  2458. Specification Extensions.
  2459. </summary>
  2460. </member>
  2461. <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2462. <summary>
  2463. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> to Open Api v3.0
  2464. </summary>
  2465. </member>
  2466. <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2467. <summary>
  2468. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> to Open Api v2.0
  2469. </summary>
  2470. </member>
  2471. <member name="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows">
  2472. <summary>
  2473. OAuth Flows Object.
  2474. </summary>
  2475. </member>
  2476. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Implicit">
  2477. <summary>
  2478. Configuration for the OAuth Implicit flow
  2479. </summary>
  2480. </member>
  2481. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Password">
  2482. <summary>
  2483. Configuration for the OAuth Resource Owner Password flow.
  2484. </summary>
  2485. </member>
  2486. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.ClientCredentials">
  2487. <summary>
  2488. Configuration for the OAuth Client Credentials flow.
  2489. </summary>
  2490. </member>
  2491. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.AuthorizationCode">
  2492. <summary>
  2493. Configuration for the OAuth Authorization Code flow.
  2494. </summary>
  2495. </member>
  2496. <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Extensions">
  2497. <summary>
  2498. Specification Extensions.
  2499. </summary>
  2500. </member>
  2501. <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2502. <summary>
  2503. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> to Open Api v3.0
  2504. </summary>
  2505. </member>
  2506. <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2507. <summary>
  2508. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> to Open Api v2.0
  2509. </summary>
  2510. </member>
  2511. <member name="T:Microsoft.OpenApi.Models.OpenApiOperation">
  2512. <summary>
  2513. Operation Object.
  2514. </summary>
  2515. </member>
  2516. <member name="F:Microsoft.OpenApi.Models.OpenApiOperation.DeprecatedDefault">
  2517. <summary>
  2518. Default value for <see cref="P:Microsoft.OpenApi.Models.OpenApiOperation.Deprecated"/>.
  2519. </summary>
  2520. </member>
  2521. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Tags">
  2522. <summary>
  2523. A list of tags for API documentation control.
  2524. Tags can be used for logical grouping of operations by resources or any other qualifier.
  2525. </summary>
  2526. </member>
  2527. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Summary">
  2528. <summary>
  2529. A short summary of what the operation does.
  2530. </summary>
  2531. </member>
  2532. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Description">
  2533. <summary>
  2534. A verbose explanation of the operation behavior.
  2535. CommonMark syntax MAY be used for rich text representation.
  2536. </summary>
  2537. </member>
  2538. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.ExternalDocs">
  2539. <summary>
  2540. Additional external documentation for this operation.
  2541. </summary>
  2542. </member>
  2543. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.OperationId">
  2544. <summary>
  2545. Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
  2546. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore,
  2547. it is RECOMMENDED to follow common programming naming conventions.
  2548. </summary>
  2549. </member>
  2550. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Parameters">
  2551. <summary>
  2552. A list of parameters that are applicable for this operation.
  2553. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.
  2554. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.
  2555. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
  2556. </summary>
  2557. </member>
  2558. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.RequestBody">
  2559. <summary>
  2560. The request body applicable for this operation.
  2561. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231
  2562. has explicitly defined semantics for request bodies.
  2563. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.
  2564. </summary>
  2565. </member>
  2566. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Responses">
  2567. <summary>
  2568. REQUIRED. The list of possible responses as they are returned from executing this operation.
  2569. </summary>
  2570. </member>
  2571. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Callbacks">
  2572. <summary>
  2573. A map of possible out-of band callbacks related to the parent operation.
  2574. The key is a unique identifier for the Callback Object.
  2575. Each value in the map is a Callback Object that describes a request
  2576. that may be initiated by the API provider and the expected responses.
  2577. The key value used to identify the callback object is an expression, evaluated at runtime,
  2578. that identifies a URL to use for the callback operation.
  2579. </summary>
  2580. </member>
  2581. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Deprecated">
  2582. <summary>
  2583. Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation.
  2584. </summary>
  2585. </member>
  2586. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Security">
  2587. <summary>
  2588. A declaration of which security mechanisms can be used for this operation.
  2589. The list of values includes alternative security requirement objects that can be used.
  2590. Only one of the security requirement objects need to be satisfied to authorize a request.
  2591. This definition overrides any declared top-level security.
  2592. To remove a top-level security declaration, an empty array can be used.
  2593. </summary>
  2594. </member>
  2595. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Servers">
  2596. <summary>
  2597. An alternative server array to service this operation.
  2598. If an alternative server object is specified at the Path Item Object or Root level,
  2599. it will be overridden by this value.
  2600. </summary>
  2601. </member>
  2602. <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Extensions">
  2603. <summary>
  2604. This object MAY be extended with Specification Extensions.
  2605. </summary>
  2606. </member>
  2607. <member name="M:Microsoft.OpenApi.Models.OpenApiOperation.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2608. <summary>
  2609. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> to Open Api v3.0.
  2610. </summary>
  2611. </member>
  2612. <member name="M:Microsoft.OpenApi.Models.OpenApiOperation.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2613. <summary>
  2614. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> to Open Api v2.0.
  2615. </summary>
  2616. </member>
  2617. <member name="T:Microsoft.OpenApi.Models.OpenApiParameter">
  2618. <summary>
  2619. Parameter Object.
  2620. </summary>
  2621. </member>
  2622. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.UnresolvedReference">
  2623. <summary>
  2624. Indicates if object is populated with data or is just a reference to the data
  2625. </summary>
  2626. </member>
  2627. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Reference">
  2628. <summary>
  2629. Reference object.
  2630. </summary>
  2631. </member>
  2632. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Name">
  2633. <summary>
  2634. REQUIRED. The name of the parameter. Parameter names are case sensitive.
  2635. If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object.
  2636. If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
  2637. For all other cases, the name corresponds to the parameter name used by the in property.
  2638. </summary>
  2639. </member>
  2640. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.In">
  2641. <summary>
  2642. REQUIRED. The location of the parameter.
  2643. Possible values are "query", "header", "path" or "cookie".
  2644. </summary>
  2645. </member>
  2646. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Description">
  2647. <summary>
  2648. A brief description of the parameter. This could contain examples of use.
  2649. CommonMark syntax MAY be used for rich text representation.
  2650. </summary>
  2651. </member>
  2652. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Required">
  2653. <summary>
  2654. Determines whether this parameter is mandatory.
  2655. If the parameter location is "path", this property is REQUIRED and its value MUST be true.
  2656. Otherwise, the property MAY be included and its default value is false.
  2657. </summary>
  2658. </member>
  2659. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Deprecated">
  2660. <summary>
  2661. Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
  2662. </summary>
  2663. </member>
  2664. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.AllowEmptyValue">
  2665. <summary>
  2666. Sets the ability to pass empty-valued parameters.
  2667. This is valid only for query parameters and allows sending a parameter with an empty value.
  2668. Default value is false.
  2669. If style is used, and if behavior is n/a (cannot be serialized),
  2670. the value of allowEmptyValue SHALL be ignored.
  2671. </summary>
  2672. </member>
  2673. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Style">
  2674. <summary>
  2675. Describes how the parameter value will be serialized depending on the type of the parameter value.
  2676. Default values (based on value of in): for query - form; for path - simple; for header - simple;
  2677. for cookie - form.
  2678. </summary>
  2679. </member>
  2680. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Explode">
  2681. <summary>
  2682. When this is true, parameter values of type array or object generate separate parameters
  2683. for each value of the array or key-value pair of the map.
  2684. For other types of parameters this property has no effect.
  2685. When style is form, the default value is true.
  2686. For all other styles, the default value is false.
  2687. </summary>
  2688. </member>
  2689. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.AllowReserved">
  2690. <summary>
  2691. Determines whether the parameter value SHOULD allow reserved characters,
  2692. as defined by RFC3986 :/?#[]@!$&amp;'()*+,;= to be included without percent-encoding.
  2693. This property only applies to parameters with an in value of query.
  2694. The default value is false.
  2695. </summary>
  2696. </member>
  2697. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Schema">
  2698. <summary>
  2699. The schema defining the type used for the parameter.
  2700. </summary>
  2701. </member>
  2702. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Examples">
  2703. <summary>
  2704. Examples of the media type. Each example SHOULD contain a value
  2705. in the correct format as specified in the parameter encoding.
  2706. The examples object is mutually exclusive of the example object.
  2707. Furthermore, if referencing a schema which contains an example,
  2708. the examples value SHALL override the example provided by the schema.
  2709. </summary>
  2710. </member>
  2711. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Example">
  2712. <summary>
  2713. Example of the media type. The example SHOULD match the specified schema and encoding properties
  2714. if present. The example object is mutually exclusive of the examples object.
  2715. Furthermore, if referencing a schema which contains an example,
  2716. the example value SHALL override the example provided by the schema.
  2717. To represent examples of media types that cannot naturally be represented in JSON or YAML,
  2718. a string value can contain the example with escaping where necessary.
  2719. </summary>
  2720. </member>
  2721. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Content">
  2722. <summary>
  2723. A map containing the representations for the parameter.
  2724. The key is the media type and the value describes it.
  2725. The map MUST only contain one entry.
  2726. For more complex scenarios, the content property can define the media type and schema of the parameter.
  2727. A parameter MUST contain either a schema property, or a content property, but not both.
  2728. When example or examples are provided in conjunction with the schema object,
  2729. the example MUST follow the prescribed serialization strategy for the parameter.
  2730. </summary>
  2731. </member>
  2732. <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Extensions">
  2733. <summary>
  2734. This object MAY be extended with Specification Extensions.
  2735. </summary>
  2736. </member>
  2737. <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2738. <summary>
  2739. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> to Open Api v3.0
  2740. </summary>
  2741. </member>
  2742. <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2743. <summary>
  2744. Serialize to OpenAPI V3 document without using reference.
  2745. </summary>
  2746. </member>
  2747. <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2748. <summary>
  2749. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> to Open Api v2.0
  2750. </summary>
  2751. </member>
  2752. <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2753. <summary>
  2754. Serialize to OpenAPI V2 document without using reference.
  2755. </summary>
  2756. </member>
  2757. <member name="T:Microsoft.OpenApi.Models.OpenApiBodyParameter">
  2758. <summary>
  2759. Body parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)"/>
  2760. </summary>
  2761. </member>
  2762. <member name="T:Microsoft.OpenApi.Models.OpenApiFormDataParameter">
  2763. <summary>
  2764. Form parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)"/>
  2765. </summary>
  2766. </member>
  2767. <member name="T:Microsoft.OpenApi.Models.OpenApiPathItem">
  2768. <summary>
  2769. Path Item Object: to describe the operations available on a single path.
  2770. </summary>
  2771. </member>
  2772. <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Summary">
  2773. <summary>
  2774. An optional, string summary, intended to apply to all operations in this path.
  2775. </summary>
  2776. </member>
  2777. <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Description">
  2778. <summary>
  2779. An optional, string description, intended to apply to all operations in this path.
  2780. </summary>
  2781. </member>
  2782. <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Operations">
  2783. <summary>
  2784. Gets the definition of operations on this path.
  2785. </summary>
  2786. </member>
  2787. <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Servers">
  2788. <summary>
  2789. An alternative server array to service all operations in this path.
  2790. </summary>
  2791. </member>
  2792. <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Parameters">
  2793. <summary>
  2794. A list of parameters that are applicable for all the operations described under this path.
  2795. These parameters can be overridden at the operation level, but cannot be removed there.
  2796. </summary>
  2797. </member>
  2798. <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Extensions">
  2799. <summary>
  2800. This object MAY be extended with Specification Extensions.
  2801. </summary>
  2802. </member>
  2803. <member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.AddOperation(Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation)">
  2804. <summary>
  2805. Add one operation into this path item.
  2806. </summary>
  2807. <param name="operationType">The operation type kind.</param>
  2808. <param name="operation">The operation item.</param>
  2809. </member>
  2810. <member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2811. <summary>
  2812. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> to Open Api v3.0
  2813. </summary>
  2814. </member>
  2815. <member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2816. <summary>
  2817. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> to Open Api v2.0
  2818. </summary>
  2819. </member>
  2820. <member name="T:Microsoft.OpenApi.Models.OpenApiPaths">
  2821. <summary>
  2822. Paths object.
  2823. </summary>
  2824. </member>
  2825. <member name="T:Microsoft.OpenApi.Models.OpenApiReference">
  2826. <summary>
  2827. A simple object to allow referencing other components in the specification, internally and externally.
  2828. </summary>
  2829. </member>
  2830. <member name="P:Microsoft.OpenApi.Models.OpenApiReference.ExternalResource">
  2831. <summary>
  2832. External resource in the reference.
  2833. It maybe:
  2834. 1. a absolute/relative file path, for example: ../commons/pet.json
  2835. 2. a Url, for example: http://localhost/pet.json
  2836. </summary>
  2837. </member>
  2838. <member name="P:Microsoft.OpenApi.Models.OpenApiReference.Type">
  2839. <summary>
  2840. The element type referenced.
  2841. </summary>
  2842. <remarks>This must be present if <see cref="P:Microsoft.OpenApi.Models.OpenApiReference.ExternalResource"/> is not present.</remarks>
  2843. </member>
  2844. <member name="P:Microsoft.OpenApi.Models.OpenApiReference.Id">
  2845. <summary>
  2846. The identifier of the reusable component of one particular ReferenceType.
  2847. If ExternalResource is present, this is the path to the component after the '#/'.
  2848. For example, if the reference is 'example.json#/path/to/component', the Id is 'path/to/component'.
  2849. If ExternalResource is not present, this is the name of the component without the reference type name.
  2850. For example, if the reference is '#/components/schemas/componentName', the Id is 'componentName'.
  2851. </summary>
  2852. </member>
  2853. <member name="P:Microsoft.OpenApi.Models.OpenApiReference.IsExternal">
  2854. <summary>
  2855. Gets a flag indicating whether this reference is an external reference.
  2856. </summary>
  2857. </member>
  2858. <member name="P:Microsoft.OpenApi.Models.OpenApiReference.IsLocal">
  2859. <summary>
  2860. Gets a flag indicating whether this reference is a local reference.
  2861. </summary>
  2862. </member>
  2863. <member name="P:Microsoft.OpenApi.Models.OpenApiReference.ReferenceV3">
  2864. <summary>
  2865. Gets the full reference string for v3.0.
  2866. </summary>
  2867. </member>
  2868. <member name="P:Microsoft.OpenApi.Models.OpenApiReference.ReferenceV2">
  2869. <summary>
  2870. Gets the full reference string for V2.0
  2871. </summary>
  2872. </member>
  2873. <member name="M:Microsoft.OpenApi.Models.OpenApiReference.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2874. <summary>
  2875. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> to Open Api v3.0.
  2876. </summary>
  2877. </member>
  2878. <member name="M:Microsoft.OpenApi.Models.OpenApiReference.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2879. <summary>
  2880. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> to Open Api v2.0.
  2881. </summary>
  2882. </member>
  2883. <member name="T:Microsoft.OpenApi.Models.OpenApiRequestBody">
  2884. <summary>
  2885. Request Body Object
  2886. </summary>
  2887. </member>
  2888. <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.UnresolvedReference">
  2889. <summary>
  2890. Indicates if object is populated with data or is just a reference to the data
  2891. </summary>
  2892. </member>
  2893. <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Reference">
  2894. <summary>
  2895. Reference object.
  2896. </summary>
  2897. </member>
  2898. <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Description">
  2899. <summary>
  2900. A brief description of the request body. This could contain examples of use.
  2901. CommonMark syntax MAY be used for rich text representation.
  2902. </summary>
  2903. </member>
  2904. <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Required">
  2905. <summary>
  2906. Determines if the request body is required in the request. Defaults to false.
  2907. </summary>
  2908. </member>
  2909. <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Content">
  2910. <summary>
  2911. REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it.
  2912. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
  2913. </summary>
  2914. </member>
  2915. <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Extensions">
  2916. <summary>
  2917. This object MAY be extended with Specification Extensions.
  2918. </summary>
  2919. </member>
  2920. <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2921. <summary>
  2922. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> to Open Api v3.0
  2923. </summary>
  2924. </member>
  2925. <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2926. <summary>
  2927. Serialize to OpenAPI V3 document without using reference.
  2928. </summary>
  2929. </member>
  2930. <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2931. <summary>
  2932. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> to Open Api v2.0
  2933. </summary>
  2934. </member>
  2935. <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2936. <summary>
  2937. Serialize to OpenAPI V2 document without using reference.
  2938. </summary>
  2939. </member>
  2940. <member name="T:Microsoft.OpenApi.Models.OpenApiResponse">
  2941. <summary>
  2942. Response object.
  2943. </summary>
  2944. </member>
  2945. <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Description">
  2946. <summary>
  2947. REQUIRED. A short description of the response.
  2948. </summary>
  2949. </member>
  2950. <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Headers">
  2951. <summary>
  2952. Maps a header name to its definition.
  2953. </summary>
  2954. </member>
  2955. <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Content">
  2956. <summary>
  2957. A map containing descriptions of potential response payloads.
  2958. The key is a media type or media type range and the value describes it.
  2959. </summary>
  2960. </member>
  2961. <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Links">
  2962. <summary>
  2963. A map of operations links that can be followed from the response.
  2964. The key of the map is a short name for the link,
  2965. following the naming constraints of the names for Component Objects.
  2966. </summary>
  2967. </member>
  2968. <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Extensions">
  2969. <summary>
  2970. This object MAY be extended with Specification Extensions.
  2971. </summary>
  2972. </member>
  2973. <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.UnresolvedReference">
  2974. <summary>
  2975. Indicates if object is populated with data or is just a reference to the data
  2976. </summary>
  2977. </member>
  2978. <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Reference">
  2979. <summary>
  2980. Reference pointer.
  2981. </summary>
  2982. </member>
  2983. <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2984. <summary>
  2985. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> to Open Api v3.0.
  2986. </summary>
  2987. </member>
  2988. <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2989. <summary>
  2990. Serialize to OpenAPI V3 document without using reference.
  2991. </summary>
  2992. </member>
  2993. <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2994. <summary>
  2995. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> to Open Api v2.0.
  2996. </summary>
  2997. </member>
  2998. <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  2999. <summary>
  3000. Serialize to OpenAPI V2 document without using reference.
  3001. </summary>
  3002. </member>
  3003. <member name="T:Microsoft.OpenApi.Models.OpenApiResponses">
  3004. <summary>
  3005. Responses object.
  3006. </summary>
  3007. </member>
  3008. <member name="T:Microsoft.OpenApi.Models.OpenApiSchema">
  3009. <summary>
  3010. Schema Object.
  3011. </summary>
  3012. </member>
  3013. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Title">
  3014. <summary>
  3015. Follow JSON Schema definition. Short text providing information about the data.
  3016. </summary>
  3017. </member>
  3018. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Type">
  3019. <summary>
  3020. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3021. Value MUST be a string. Multiple types via an array are not supported.
  3022. </summary>
  3023. </member>
  3024. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Format">
  3025. <summary>
  3026. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3027. While relying on JSON Schema's defined formats,
  3028. the OAS offers a few additional predefined formats.
  3029. </summary>
  3030. </member>
  3031. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Description">
  3032. <summary>
  3033. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3034. CommonMark syntax MAY be used for rich text representation.
  3035. </summary>
  3036. </member>
  3037. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Maximum">
  3038. <summary>
  3039. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3040. </summary>
  3041. </member>
  3042. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExclusiveMaximum">
  3043. <summary>
  3044. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3045. </summary>
  3046. </member>
  3047. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Minimum">
  3048. <summary>
  3049. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3050. </summary>
  3051. </member>
  3052. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExclusiveMinimum">
  3053. <summary>
  3054. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3055. </summary>
  3056. </member>
  3057. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxLength">
  3058. <summary>
  3059. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3060. </summary>
  3061. </member>
  3062. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinLength">
  3063. <summary>
  3064. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3065. </summary>
  3066. </member>
  3067. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Pattern">
  3068. <summary>
  3069. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3070. This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect
  3071. </summary>
  3072. </member>
  3073. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MultipleOf">
  3074. <summary>
  3075. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3076. </summary>
  3077. </member>
  3078. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Default">
  3079. <summary>
  3080. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3081. The default value represents what would be assumed by the consumer of the input as the value of the schema if one is not provided.
  3082. Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level.
  3083. For example, if type is string, then default can be "foo" but cannot be 1.
  3084. </summary>
  3085. </member>
  3086. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ReadOnly">
  3087. <summary>
  3088. Relevant only for Schema "properties" definitions. Declares the property as "read only".
  3089. This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request.
  3090. If the property is marked as readOnly being true and is in the required list,
  3091. the required will take effect on the response only.
  3092. A property MUST NOT be marked as both readOnly and writeOnly being true.
  3093. Default value is false.
  3094. </summary>
  3095. </member>
  3096. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.WriteOnly">
  3097. <summary>
  3098. Relevant only for Schema "properties" definitions. Declares the property as "write only".
  3099. Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response.
  3100. If the property is marked as writeOnly being true and is in the required list,
  3101. the required will take effect on the request only.
  3102. A property MUST NOT be marked as both readOnly and writeOnly being true.
  3103. Default value is false.
  3104. </summary>
  3105. </member>
  3106. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AllOf">
  3107. <summary>
  3108. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3109. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
  3110. </summary>
  3111. </member>
  3112. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.OneOf">
  3113. <summary>
  3114. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3115. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
  3116. </summary>
  3117. </member>
  3118. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AnyOf">
  3119. <summary>
  3120. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3121. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
  3122. </summary>
  3123. </member>
  3124. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Not">
  3125. <summary>
  3126. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3127. Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
  3128. </summary>
  3129. </member>
  3130. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Required">
  3131. <summary>
  3132. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3133. </summary>
  3134. </member>
  3135. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Items">
  3136. <summary>
  3137. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3138. Value MUST be an object and not an array. Inline or referenced schema MUST be of a Schema Object
  3139. and not a standard JSON Schema. items MUST be present if the type is array.
  3140. </summary>
  3141. </member>
  3142. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxItems">
  3143. <summary>
  3144. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3145. </summary>
  3146. </member>
  3147. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinItems">
  3148. <summary>
  3149. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3150. </summary>
  3151. </member>
  3152. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.UniqueItems">
  3153. <summary>
  3154. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3155. </summary>
  3156. </member>
  3157. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Properties">
  3158. <summary>
  3159. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3160. Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).
  3161. </summary>
  3162. </member>
  3163. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxProperties">
  3164. <summary>
  3165. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3166. </summary>
  3167. </member>
  3168. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinProperties">
  3169. <summary>
  3170. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3171. </summary>
  3172. </member>
  3173. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AdditionalPropertiesAllowed">
  3174. <summary>
  3175. Indicates if the schema can contain properties other than those defined by the properties map.
  3176. </summary>
  3177. </member>
  3178. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AdditionalProperties">
  3179. <summary>
  3180. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3181. Value can be boolean or object. Inline or referenced schema
  3182. MUST be of a Schema Object and not a standard JSON Schema.
  3183. </summary>
  3184. </member>
  3185. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Discriminator">
  3186. <summary>
  3187. Adds support for polymorphism. The discriminator is an object name that is used to differentiate
  3188. between other schemas which may satisfy the payload description.
  3189. </summary>
  3190. </member>
  3191. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Example">
  3192. <summary>
  3193. A free-form property to include an example of an instance for this schema.
  3194. To represent examples that cannot be naturally represented in JSON or YAML,
  3195. a string value can be used to contain the example with escaping where necessary.
  3196. </summary>
  3197. </member>
  3198. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Enum">
  3199. <summary>
  3200. Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
  3201. </summary>
  3202. </member>
  3203. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Nullable">
  3204. <summary>
  3205. Allows sending a null value for the defined schema. Default value is false.
  3206. </summary>
  3207. </member>
  3208. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExternalDocs">
  3209. <summary>
  3210. Additional external documentation for this schema.
  3211. </summary>
  3212. </member>
  3213. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Deprecated">
  3214. <summary>
  3215. Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
  3216. Default value is false.
  3217. </summary>
  3218. </member>
  3219. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Xml">
  3220. <summary>
  3221. This MAY be used only on properties schemas. It has no effect on root schemas.
  3222. Adds additional metadata to describe the XML representation of this property.
  3223. </summary>
  3224. </member>
  3225. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Extensions">
  3226. <summary>
  3227. This object MAY be extended with Specification Extensions.
  3228. </summary>
  3229. </member>
  3230. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.UnresolvedReference">
  3231. <summary>
  3232. Indicates object is a placeholder reference to an actual object and does not contain valid data.
  3233. </summary>
  3234. </member>
  3235. <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Reference">
  3236. <summary>
  3237. Reference object.
  3238. </summary>
  3239. </member>
  3240. <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3241. <summary>
  3242. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v3.0
  3243. </summary>
  3244. </member>
  3245. <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3246. <summary>
  3247. Serialize to OpenAPI V3 document without using reference.
  3248. </summary>
  3249. </member>
  3250. <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3251. <summary>
  3252. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v2.0
  3253. </summary>
  3254. </member>
  3255. <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3256. <summary>
  3257. Serialize to OpenAPI V2 document without using reference.
  3258. </summary>
  3259. </member>
  3260. <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.ISet{System.String},System.String)">
  3261. <summary>
  3262. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v2.0 and handles not marking the provided property
  3263. as readonly if its included in the provided list of required properties of parent schema.
  3264. </summary>
  3265. <param name="writer">The open api writer.</param>
  3266. <param name="parentRequiredProperties">The list of required properties in parent schema.</param>
  3267. <param name="propertyName">The property name that will be serialized.</param>
  3268. </member>
  3269. <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.ISet{System.String},System.String)">
  3270. <summary>
  3271. Serialize to OpenAPI V2 document without using reference and handles not marking the provided property
  3272. as readonly if its included in the provided list of required properties of parent schema.
  3273. </summary>
  3274. <param name="writer">The open api writer.</param>
  3275. <param name="parentRequiredProperties">The list of required properties in parent schema.</param>
  3276. <param name="propertyName">The property name that will be serialized.</param>
  3277. </member>
  3278. <member name="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement">
  3279. <summary>
  3280. Security Requirement Object.
  3281. Each name MUST correspond to a security scheme which is declared in
  3282. the Security Schemes under the Components Object.
  3283. If the security scheme is of type "oauth2" or "openIdConnect",
  3284. then the value is a list of scope names required for the execution.
  3285. For other security scheme types, the array MUST be empty.
  3286. </summary>
  3287. </member>
  3288. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.#ctor">
  3289. <summary>
  3290. Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> class.
  3291. This constructor ensures that only Reference.Id is considered when two dictionary keys
  3292. of type <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> are compared.
  3293. </summary>
  3294. </member>
  3295. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3296. <summary>
  3297. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> to Open Api v3.0
  3298. </summary>
  3299. </member>
  3300. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3301. <summary>
  3302. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> to Open Api v2.0
  3303. </summary>
  3304. </member>
  3305. <member name="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer">
  3306. <summary>
  3307. Comparer for OpenApiSecurityScheme that only considers the Id in the Reference
  3308. (i.e. the string that will actually be displayed in the written document)
  3309. </summary>
  3310. </member>
  3311. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.Equals(Microsoft.OpenApi.Models.OpenApiSecurityScheme,Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
  3312. <summary>
  3313. Determines whether the specified objects are equal.
  3314. </summary>
  3315. </member>
  3316. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.GetHashCode(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
  3317. <summary>
  3318. Returns a hash code for the specified object.
  3319. </summary>
  3320. </member>
  3321. <member name="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme">
  3322. <summary>
  3323. Security Scheme Object.
  3324. </summary>
  3325. </member>
  3326. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Type">
  3327. <summary>
  3328. REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".
  3329. </summary>
  3330. </member>
  3331. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Description">
  3332. <summary>
  3333. A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
  3334. </summary>
  3335. </member>
  3336. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Name">
  3337. <summary>
  3338. REQUIRED. The name of the header, query or cookie parameter to be used.
  3339. </summary>
  3340. </member>
  3341. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.In">
  3342. <summary>
  3343. REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".
  3344. </summary>
  3345. </member>
  3346. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Scheme">
  3347. <summary>
  3348. REQUIRED. The name of the HTTP Authorization scheme to be used
  3349. in the Authorization header as defined in RFC7235.
  3350. </summary>
  3351. </member>
  3352. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.BearerFormat">
  3353. <summary>
  3354. A hint to the client to identify how the bearer token is formatted.
  3355. Bearer tokens are usually generated by an authorization server,
  3356. so this information is primarily for documentation purposes.
  3357. </summary>
  3358. </member>
  3359. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Flows">
  3360. <summary>
  3361. REQUIRED. An object containing configuration information for the flow types supported.
  3362. </summary>
  3363. </member>
  3364. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.OpenIdConnectUrl">
  3365. <summary>
  3366. REQUIRED. OpenId Connect URL to discover OAuth2 configuration values.
  3367. </summary>
  3368. </member>
  3369. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Extensions">
  3370. <summary>
  3371. Specification Extensions.
  3372. </summary>
  3373. </member>
  3374. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.UnresolvedReference">
  3375. <summary>
  3376. Indicates if object is populated with data or is just a reference to the data
  3377. </summary>
  3378. </member>
  3379. <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Reference">
  3380. <summary>
  3381. Reference object.
  3382. </summary>
  3383. </member>
  3384. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3385. <summary>
  3386. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> to Open Api v3.0
  3387. </summary>
  3388. </member>
  3389. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3390. <summary>
  3391. Serialize to OpenAPI V3 document without using reference.
  3392. </summary>
  3393. </member>
  3394. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3395. <summary>
  3396. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> to Open Api v2.0
  3397. </summary>
  3398. </member>
  3399. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3400. <summary>
  3401. Serialize to OpenAPI V2 document without using reference.
  3402. </summary>
  3403. </member>
  3404. <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.WriteOAuthFlowForV2(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.Models.OpenApiOAuthFlows)">
  3405. <summary>
  3406. Arbitrarily chooses one <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> object from the <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/>
  3407. to populate in V2 security scheme.
  3408. </summary>
  3409. </member>
  3410. <member name="T:Microsoft.OpenApi.Models.OpenApiServer">
  3411. <summary>
  3412. Server Object: an object representing a Server.
  3413. </summary>
  3414. </member>
  3415. <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Description">
  3416. <summary>
  3417. An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
  3418. </summary>
  3419. </member>
  3420. <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Url">
  3421. <summary>
  3422. REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative,
  3423. to indicate that the host location is relative to the location where the OpenAPI document is being served.
  3424. Variable substitutions will be made when a variable is named in {brackets}.
  3425. </summary>
  3426. </member>
  3427. <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Variables">
  3428. <summary>
  3429. A map between a variable name and its value. The value is used for substitution in the server's URL template.
  3430. </summary>
  3431. </member>
  3432. <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Extensions">
  3433. <summary>
  3434. This object MAY be extended with Specification Extensions.
  3435. </summary>
  3436. </member>
  3437. <member name="M:Microsoft.OpenApi.Models.OpenApiServer.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3438. <summary>
  3439. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> to Open Api v3.0
  3440. </summary>
  3441. </member>
  3442. <member name="M:Microsoft.OpenApi.Models.OpenApiServer.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3443. <summary>
  3444. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> to Open Api v2.0
  3445. </summary>
  3446. </member>
  3447. <member name="T:Microsoft.OpenApi.Models.OpenApiServerVariable">
  3448. <summary>
  3449. Server Variable Object.
  3450. </summary>
  3451. </member>
  3452. <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Description">
  3453. <summary>
  3454. An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
  3455. </summary>
  3456. </member>
  3457. <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Default">
  3458. <summary>
  3459. REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied.
  3460. Unlike the Schema Object's default, this value MUST be provided by the consumer.
  3461. </summary>
  3462. </member>
  3463. <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Enum">
  3464. <summary>
  3465. An enumeration of string values to be used if the substitution options are from a limited set.
  3466. </summary>
  3467. </member>
  3468. <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Extensions">
  3469. <summary>
  3470. This object MAY be extended with Specification Extensions.
  3471. </summary>
  3472. </member>
  3473. <member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3474. <summary>
  3475. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> to Open Api v3.0
  3476. </summary>
  3477. </member>
  3478. <member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3479. <summary>
  3480. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> to Open Api v2.0
  3481. </summary>
  3482. </member>
  3483. <member name="T:Microsoft.OpenApi.Models.OpenApiTag">
  3484. <summary>
  3485. Tag Object.
  3486. </summary>
  3487. </member>
  3488. <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Name">
  3489. <summary>
  3490. The name of the tag.
  3491. </summary>
  3492. </member>
  3493. <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Description">
  3494. <summary>
  3495. A short description for the tag.
  3496. </summary>
  3497. </member>
  3498. <member name="P:Microsoft.OpenApi.Models.OpenApiTag.ExternalDocs">
  3499. <summary>
  3500. Additional external documentation for this tag.
  3501. </summary>
  3502. </member>
  3503. <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Extensions">
  3504. <summary>
  3505. This object MAY be extended with Specification Extensions.
  3506. </summary>
  3507. </member>
  3508. <member name="P:Microsoft.OpenApi.Models.OpenApiTag.UnresolvedReference">
  3509. <summary>
  3510. Indicates if object is populated with data or is just a reference to the data
  3511. </summary>
  3512. </member>
  3513. <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Reference">
  3514. <summary>
  3515. Reference.
  3516. </summary>
  3517. </member>
  3518. <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3519. <summary>
  3520. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> to Open Api v3.0
  3521. </summary>
  3522. </member>
  3523. <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3524. <summary>
  3525. Serialize to OpenAPI V3 document without using reference.
  3526. </summary>
  3527. </member>
  3528. <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3529. <summary>
  3530. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> to Open Api v2.0
  3531. </summary>
  3532. </member>
  3533. <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3534. <summary>
  3535. Serialize to OpenAPI V2 document without using reference.
  3536. </summary>
  3537. </member>
  3538. <member name="T:Microsoft.OpenApi.Models.OpenApiXml">
  3539. <summary>
  3540. XML Object.
  3541. </summary>
  3542. </member>
  3543. <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Name">
  3544. <summary>
  3545. Replaces the name of the element/attribute used for the described schema property.
  3546. </summary>
  3547. </member>
  3548. <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Namespace">
  3549. <summary>
  3550. The URI of the namespace definition. Value MUST be in the form of an absolute URI.
  3551. </summary>
  3552. </member>
  3553. <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Prefix">
  3554. <summary>
  3555. The prefix to be used for the name
  3556. </summary>
  3557. </member>
  3558. <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Attribute">
  3559. <summary>
  3560. Declares whether the property definition translates to an attribute instead of an element.
  3561. Default value is false.
  3562. </summary>
  3563. </member>
  3564. <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Wrapped">
  3565. <summary>
  3566. Signifies whether the array is wrapped.
  3567. Default value is false.
  3568. </summary>
  3569. </member>
  3570. <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Extensions">
  3571. <summary>
  3572. Specification Extensions.
  3573. </summary>
  3574. </member>
  3575. <member name="M:Microsoft.OpenApi.Models.OpenApiXml.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3576. <summary>
  3577. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiXml"/> to Open Api v3.0
  3578. </summary>
  3579. </member>
  3580. <member name="M:Microsoft.OpenApi.Models.OpenApiXml.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3581. <summary>
  3582. Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiXml"/> to Open Api v2.0
  3583. </summary>
  3584. </member>
  3585. <member name="T:Microsoft.OpenApi.Models.OperationType">
  3586. <summary>
  3587. Operation type.
  3588. </summary>
  3589. </member>
  3590. <member name="F:Microsoft.OpenApi.Models.OperationType.Get">
  3591. <summary>
  3592. A definition of a GET operation on this path.
  3593. </summary>
  3594. </member>
  3595. <member name="F:Microsoft.OpenApi.Models.OperationType.Put">
  3596. <summary>
  3597. A definition of a PUT operation on this path.
  3598. </summary>
  3599. </member>
  3600. <member name="F:Microsoft.OpenApi.Models.OperationType.Post">
  3601. <summary>
  3602. A definition of a POST operation on this path.
  3603. </summary>
  3604. </member>
  3605. <member name="F:Microsoft.OpenApi.Models.OperationType.Delete">
  3606. <summary>
  3607. A definition of a DELETE operation on this path.
  3608. </summary>
  3609. </member>
  3610. <member name="F:Microsoft.OpenApi.Models.OperationType.Options">
  3611. <summary>
  3612. A definition of a OPTIONS operation on this path.
  3613. </summary>
  3614. </member>
  3615. <member name="F:Microsoft.OpenApi.Models.OperationType.Head">
  3616. <summary>
  3617. A definition of a HEAD operation on this path.
  3618. </summary>
  3619. </member>
  3620. <member name="F:Microsoft.OpenApi.Models.OperationType.Patch">
  3621. <summary>
  3622. A definition of a PATCH operation on this path.
  3623. </summary>
  3624. </member>
  3625. <member name="F:Microsoft.OpenApi.Models.OperationType.Trace">
  3626. <summary>
  3627. A definition of a TRACE operation on this path.
  3628. </summary>
  3629. </member>
  3630. <member name="T:Microsoft.OpenApi.Models.ParameterLocation">
  3631. <summary>
  3632. The location of the parameter.
  3633. </summary>
  3634. </member>
  3635. <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Query">
  3636. <summary>
  3637. Parameters that are appended to the URL.
  3638. </summary>
  3639. </member>
  3640. <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Header">
  3641. <summary>
  3642. Custom headers that are expected as part of the request.
  3643. </summary>
  3644. </member>
  3645. <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Path">
  3646. <summary>
  3647. Used together with Path Templating,
  3648. where the parameter value is actually part of the operation's URL
  3649. </summary>
  3650. </member>
  3651. <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Cookie">
  3652. <summary>
  3653. Used to pass a specific cookie value to the API.
  3654. </summary>
  3655. </member>
  3656. <member name="T:Microsoft.OpenApi.Models.ParameterStyle">
  3657. <summary>
  3658. The style of the parameter.
  3659. </summary>
  3660. </member>
  3661. <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Matrix">
  3662. <summary>
  3663. Path-style parameters.
  3664. </summary>
  3665. </member>
  3666. <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Label">
  3667. <summary>
  3668. Label style parameters.
  3669. </summary>
  3670. </member>
  3671. <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Form">
  3672. <summary>
  3673. Form style parameters.
  3674. </summary>
  3675. </member>
  3676. <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Simple">
  3677. <summary>
  3678. Simple style parameters.
  3679. </summary>
  3680. </member>
  3681. <member name="F:Microsoft.OpenApi.Models.ParameterStyle.SpaceDelimited">
  3682. <summary>
  3683. Space separated array values.
  3684. </summary>
  3685. </member>
  3686. <member name="F:Microsoft.OpenApi.Models.ParameterStyle.PipeDelimited">
  3687. <summary>
  3688. Pipe separated array values.
  3689. </summary>
  3690. </member>
  3691. <member name="F:Microsoft.OpenApi.Models.ParameterStyle.DeepObject">
  3692. <summary>
  3693. Provides a simple way of rendering nested objects using form parameters.
  3694. </summary>
  3695. </member>
  3696. <member name="T:Microsoft.OpenApi.Models.ReferenceType">
  3697. <summary>
  3698. The reference type.
  3699. </summary>
  3700. </member>
  3701. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Schema">
  3702. <summary>
  3703. Schema item.
  3704. </summary>
  3705. </member>
  3706. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Response">
  3707. <summary>
  3708. Responses item.
  3709. </summary>
  3710. </member>
  3711. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Parameter">
  3712. <summary>
  3713. Parameters item.
  3714. </summary>
  3715. </member>
  3716. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Example">
  3717. <summary>
  3718. Examples item.
  3719. </summary>
  3720. </member>
  3721. <member name="F:Microsoft.OpenApi.Models.ReferenceType.RequestBody">
  3722. <summary>
  3723. RequestBodies item.
  3724. </summary>
  3725. </member>
  3726. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Header">
  3727. <summary>
  3728. Headers item.
  3729. </summary>
  3730. </member>
  3731. <member name="F:Microsoft.OpenApi.Models.ReferenceType.SecurityScheme">
  3732. <summary>
  3733. SecuritySchemes item.
  3734. </summary>
  3735. </member>
  3736. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Link">
  3737. <summary>
  3738. Links item.
  3739. </summary>
  3740. </member>
  3741. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Callback">
  3742. <summary>
  3743. Callbacks item.
  3744. </summary>
  3745. </member>
  3746. <member name="F:Microsoft.OpenApi.Models.ReferenceType.Tag">
  3747. <summary>
  3748. Tags item.
  3749. </summary>
  3750. </member>
  3751. <member name="T:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper">
  3752. <summary>
  3753. The wrapper either for <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> or <see cref="T:Microsoft.OpenApi.Expressions.RuntimeExpression"/>
  3754. </summary>
  3755. </member>
  3756. <member name="P:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.Any">
  3757. <summary>
  3758. Gets/Sets the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
  3759. </summary>
  3760. </member>
  3761. <member name="P:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.Expression">
  3762. <summary>
  3763. Gets/Set the <see cref="T:Microsoft.OpenApi.Expressions.RuntimeExpression"/>
  3764. </summary>
  3765. </member>
  3766. <member name="M:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.WriteValue(Microsoft.OpenApi.Writers.IOpenApiWriter)">
  3767. <summary>
  3768. Write <see cref="T:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper"/>
  3769. </summary>
  3770. </member>
  3771. <member name="T:Microsoft.OpenApi.Models.SecuritySchemeType">
  3772. <summary>
  3773. The type of the security scheme
  3774. </summary>
  3775. </member>
  3776. <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.ApiKey">
  3777. <summary>
  3778. Use API key
  3779. </summary>
  3780. </member>
  3781. <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.Http">
  3782. <summary>
  3783. Use basic or bearer token authorization header.
  3784. </summary>
  3785. </member>
  3786. <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.OAuth2">
  3787. <summary>
  3788. Use OAuth2
  3789. </summary>
  3790. </member>
  3791. <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.OpenIdConnect">
  3792. <summary>
  3793. Use OAuth2 with OpenId Connect URL to discover OAuth2 configuration value.
  3794. </summary>
  3795. </member>
  3796. <member name="T:Microsoft.OpenApi.OpenApiFormat">
  3797. <summary>
  3798. Represents the Open Api document format.
  3799. </summary>
  3800. </member>
  3801. <member name="F:Microsoft.OpenApi.OpenApiFormat.Json">
  3802. <summary>
  3803. JSON format.
  3804. </summary>
  3805. </member>
  3806. <member name="F:Microsoft.OpenApi.OpenApiFormat.Yaml">
  3807. <summary>
  3808. Yaml format.
  3809. </summary>
  3810. </member>
  3811. <member name="T:Microsoft.OpenApi.OpenApiSpecVersion">
  3812. <summary>
  3813. Represents versions of OpenAPI specification.
  3814. </summary>
  3815. </member>
  3816. <member name="F:Microsoft.OpenApi.OpenApiSpecVersion.OpenApi2_0">
  3817. <summary>
  3818. Represents OpenAPI V2.0 spec
  3819. </summary>
  3820. </member>
  3821. <member name="F:Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0">
  3822. <summary>
  3823. Represents all patches of OpenAPI V3.0 spec (e.g. 3.0.0, 3.0.1)
  3824. </summary>
  3825. </member>
  3826. <member name="T:Microsoft.OpenApi.Properties.SRResource">
  3827. <summary>
  3828. A strongly-typed resource class, for looking up localized strings, etc.
  3829. </summary>
  3830. </member>
  3831. <member name="P:Microsoft.OpenApi.Properties.SRResource.ResourceManager">
  3832. <summary>
  3833. Returns the cached ResourceManager instance used by this class.
  3834. </summary>
  3835. </member>
  3836. <member name="P:Microsoft.OpenApi.Properties.SRResource.Culture">
  3837. <summary>
  3838. Overrides the current thread's CurrentUICulture property for all
  3839. resource lookups using this strongly typed resource class.
  3840. </summary>
  3841. </member>
  3842. <member name="P:Microsoft.OpenApi.Properties.SRResource.ActiveScopeNeededForPropertyNameWriting">
  3843. <summary>
  3844. Looks up a localized string similar to There must be an active scope for name &apos;{0}&apos; to be written..
  3845. </summary>
  3846. </member>
  3847. <member name="P:Microsoft.OpenApi.Properties.SRResource.ArgumentNullOrWhiteSpace">
  3848. <summary>
  3849. Looks up a localized string similar to The argument &apos;{0}&apos; is null, empty or consists only of white-space..
  3850. </summary>
  3851. </member>
  3852. <member name="P:Microsoft.OpenApi.Properties.SRResource.ExtensionFieldNameMustBeginWithXDash">
  3853. <summary>
  3854. Looks up a localized string similar to The filed name &apos;{0}&apos; of extension doesn&apos;t begin with x-..
  3855. </summary>
  3856. </member>
  3857. <member name="P:Microsoft.OpenApi.Properties.SRResource.IndentationLevelInvalid">
  3858. <summary>
  3859. Looks up a localized string similar to Indentation level cannot be lower than 0..
  3860. </summary>
  3861. </member>
  3862. <member name="P:Microsoft.OpenApi.Properties.SRResource.InputItemShouldBeType">
  3863. <summary>
  3864. Looks up a localized string similar to The input item should be in type of &apos;{0}&apos;..
  3865. </summary>
  3866. </member>
  3867. <member name="P:Microsoft.OpenApi.Properties.SRResource.InvalidReferenceId">
  3868. <summary>
  3869. Looks up a localized string similar to Invalid Reference identifier &apos;{0}&apos;..
  3870. </summary>
  3871. </member>
  3872. <member name="P:Microsoft.OpenApi.Properties.SRResource.InvalidReferenceType">
  3873. <summary>
  3874. Looks up a localized string similar to Invalid Reference Type..
  3875. </summary>
  3876. </member>
  3877. <member name="P:Microsoft.OpenApi.Properties.SRResource.LocalReferenceRequiresType">
  3878. <summary>
  3879. Looks up a localized string similar to Local reference must have type specified..
  3880. </summary>
  3881. </member>
  3882. <member name="P:Microsoft.OpenApi.Properties.SRResource.ObjectScopeNeededForPropertyNameWriting">
  3883. <summary>
  3884. Looks up a localized string similar to The active scope must be an object scope for property name &apos;{0}&apos; to be written..
  3885. </summary>
  3886. </member>
  3887. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiExceptionGenericError">
  3888. <summary>
  3889. Looks up a localized string similar to An error occurred while processing the Open API document..
  3890. </summary>
  3891. </member>
  3892. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiFormatNotSupported">
  3893. <summary>
  3894. Looks up a localized string similar to The given OpenAPI format &apos;{0}&apos; is not supported..
  3895. </summary>
  3896. </member>
  3897. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiObjectElementIsRequired">
  3898. <summary>
  3899. Looks up a localized string similar to The object element name &apos;{0}&apos; is required..
  3900. </summary>
  3901. </member>
  3902. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiObjectMarkAsReference">
  3903. <summary>
  3904. Looks up a localized string similar to The OpenApi element &apos;{0}&apos; is already marked as reference object..
  3905. </summary>
  3906. </member>
  3907. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiParameterRequiredPropertyMandatory">
  3908. <summary>
  3909. Looks up a localized string similar to If the parameter location is &quot;path&quot;, this property is REQUIRED and its value MUST be true.
  3910. </summary>
  3911. </member>
  3912. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiSpecVersionNotSupported">
  3913. <summary>
  3914. Looks up a localized string similar to The given OpenAPI specification version &apos;{0}&apos; is not supported..
  3915. </summary>
  3916. </member>
  3917. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiUnsupportedValueType">
  3918. <summary>
  3919. Looks up a localized string similar to The type &apos;{0}&apos; is not supported in Open API document..
  3920. </summary>
  3921. </member>
  3922. <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiWriterExceptionGenericError">
  3923. <summary>
  3924. Looks up a localized string similar to An error occurred while writing the Open API document..
  3925. </summary>
  3926. </member>
  3927. <member name="P:Microsoft.OpenApi.Properties.SRResource.PrimitiveTypeNotSupported">
  3928. <summary>
  3929. Looks up a localized string similar to The given primitive type &apos;{0}&apos; is not supported..
  3930. </summary>
  3931. </member>
  3932. <member name="P:Microsoft.OpenApi.Properties.SRResource.ReferenceHasInvalidFormat">
  3933. <summary>
  3934. Looks up a localized string similar to The reference string &apos;{0}&apos; has invalid format..
  3935. </summary>
  3936. </member>
  3937. <member name="P:Microsoft.OpenApi.Properties.SRResource.RemoteReferenceNotSupported">
  3938. <summary>
  3939. Looks up a localized string similar to Remote reference not supported..
  3940. </summary>
  3941. </member>
  3942. <member name="P:Microsoft.OpenApi.Properties.SRResource.RuntimeExpressionHasInvalidFormat">
  3943. <summary>
  3944. Looks up a localized string similar to The runtime expression &apos;{0}&apos; has invalid format..
  3945. </summary>
  3946. </member>
  3947. <member name="P:Microsoft.OpenApi.Properties.SRResource.RuntimeExpressionMustBeginWithDollar">
  3948. <summary>
  3949. Looks up a localized string similar to The runtime expression &apos;{0}&apos; should start with &apos;$&apos;.
  3950. </summary>
  3951. </member>
  3952. <member name="P:Microsoft.OpenApi.Properties.SRResource.ScopeMustBePresentToEnd">
  3953. <summary>
  3954. Looks up a localized string similar to Scope must be present to end..
  3955. </summary>
  3956. </member>
  3957. <member name="P:Microsoft.OpenApi.Properties.SRResource.ScopeToEndHasIncorrectType">
  3958. <summary>
  3959. Looks up a localized string similar to The scope to end is expected to be of type &apos;{0}&apos; but it is of type &apos;{0}&apos;..
  3960. </summary>
  3961. </member>
  3962. <member name="P:Microsoft.OpenApi.Properties.SRResource.SourceExpressionHasInvalidFormat">
  3963. <summary>
  3964. Looks up a localized string similar to The source expression &apos;{0}&apos; has invalid format..
  3965. </summary>
  3966. </member>
  3967. <member name="P:Microsoft.OpenApi.Properties.SRResource.UnknownVisitorType">
  3968. <summary>
  3969. Looks up a localized string similar to Can not find visitor type registered for type &apos;{0}&apos;..
  3970. </summary>
  3971. </member>
  3972. <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_ComponentsKeyMustMatchRegularExpr">
  3973. <summary>
  3974. Looks up a localized string similar to The key &apos;{0}&apos; in &apos;{1}&apos; of components MUST match the regular expression &apos;{2}&apos;..
  3975. </summary>
  3976. </member>
  3977. <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_ExtensionNameMustBeginWithXDash">
  3978. <summary>
  3979. Looks up a localized string similar to The extension name &apos;{0}&apos; in &apos;{1}&apos; object MUST begin with &apos;x-&apos;..
  3980. </summary>
  3981. </member>
  3982. <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_FieldIsRequired">
  3983. <summary>
  3984. Looks up a localized string similar to The field &apos;{0}&apos; in &apos;{1}&apos; object is REQUIRED..
  3985. </summary>
  3986. </member>
  3987. <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_PathItemMustBeginWithSlash">
  3988. <summary>
  3989. Looks up a localized string similar to The path item name &apos;{0}&apos; MUST begin with a slash..
  3990. </summary>
  3991. </member>
  3992. <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_RuleAddTwice">
  3993. <summary>
  3994. Looks up a localized string similar to The same rule cannot be in the same rule set twice..
  3995. </summary>
  3996. </member>
  3997. <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_SchemaRequiredFieldListMustContainThePropertySpecifiedInTheDiscriminator">
  3998. <summary>
  3999. Looks up a localized string similar to Schema {0} must contain property specified in the discriminator {1} in the required field list..
  4000. </summary>
  4001. </member>
  4002. <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_StringMustBeEmailAddress">
  4003. <summary>
  4004. Looks up a localized string similar to The string &apos;{0}&apos; MUST be in the format of an email address..
  4005. </summary>
  4006. </member>
  4007. <member name="M:Microsoft.OpenApi.Services.LoopDetector.PushLoop``1(``0)">
  4008. <summary>
  4009. Maintain history of traversals to avoid stack overflows from cycles
  4010. </summary>
  4011. <param name="key">Identifier used for current context.</param>
  4012. <returns>If method returns false a loop was detected and the key is not added.</returns>
  4013. </member>
  4014. <member name="M:Microsoft.OpenApi.Services.LoopDetector.PopLoop``1">
  4015. <summary>
  4016. Exit from the context in cycle detection
  4017. </summary>
  4018. </member>
  4019. <member name="P:Microsoft.OpenApi.Services.LoopDetector.Loops">
  4020. <summary>
  4021. List of Loops detected
  4022. </summary>
  4023. </member>
  4024. <member name="M:Microsoft.OpenApi.Services.LoopDetector.ClearLoop``1">
  4025. <summary>
  4026. Reset loop tracking stack
  4027. </summary>
  4028. </member>
  4029. <member name="T:Microsoft.OpenApi.Services.OpenApiVisitorBase">
  4030. <summary>
  4031. Open API visitor base provides common logic for concrete visitors
  4032. </summary>
  4033. </member>
  4034. <member name="P:Microsoft.OpenApi.Services.OpenApiVisitorBase.CurrentKeys">
  4035. <summary>
  4036. Properties available to identify context of where an object is within OpenAPI Document
  4037. </summary>
  4038. </member>
  4039. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Enter(System.String)">
  4040. <summary>
  4041. Allow Rule to indicate validation error occured at a deeper context level.
  4042. </summary>
  4043. <param name="segment">Identifier for context</param>
  4044. </member>
  4045. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Exit">
  4046. <summary>
  4047. Exit from path context elevel. Enter and Exit calls should be matched.
  4048. </summary>
  4049. </member>
  4050. <member name="P:Microsoft.OpenApi.Services.OpenApiVisitorBase.PathString">
  4051. <summary>
  4052. Pointer to source of validation error in document
  4053. </summary>
  4054. </member>
  4055. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiDocument)">
  4056. <summary>
  4057. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>
  4058. </summary>
  4059. </member>
  4060. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiInfo)">
  4061. <summary>
  4062. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>
  4063. </summary>
  4064. </member>
  4065. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiContact)">
  4066. <summary>
  4067. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>
  4068. </summary>
  4069. </member>
  4070. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiLicense)">
  4071. <summary>
  4072. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>
  4073. </summary>
  4074. </member>
  4075. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiServer})">
  4076. <summary>
  4077. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
  4078. </summary>
  4079. </member>
  4080. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiServer)">
  4081. <summary>
  4082. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
  4083. </summary>
  4084. </member>
  4085. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiPaths)">
  4086. <summary>
  4087. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>
  4088. </summary>
  4089. </member>
  4090. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiPathItem)">
  4091. <summary>
  4092. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/>
  4093. </summary>
  4094. </member>
  4095. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiServerVariable)">
  4096. <summary>
  4097. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/>
  4098. </summary>
  4099. </member>
  4100. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation})">
  4101. <summary>
  4102. Visits the operations.
  4103. </summary>
  4104. </member>
  4105. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiOperation)">
  4106. <summary>
  4107. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/>
  4108. </summary>
  4109. </member>
  4110. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
  4111. <summary>
  4112. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
  4113. </summary>
  4114. </member>
  4115. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiParameter)">
  4116. <summary>
  4117. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
  4118. </summary>
  4119. </member>
  4120. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiRequestBody)">
  4121. <summary>
  4122. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/>
  4123. </summary>
  4124. </member>
  4125. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
  4126. <summary>
  4127. Visits headers.
  4128. </summary>
  4129. </member>
  4130. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
  4131. <summary>
  4132. Visits callbacks.
  4133. </summary>
  4134. </member>
  4135. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiResponse)">
  4136. <summary>
  4137. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>
  4138. </summary>
  4139. </member>
  4140. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiResponses)">
  4141. <summary>
  4142. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>
  4143. </summary>
  4144. </member>
  4145. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiMediaType})">
  4146. <summary>
  4147. Visits media type content.
  4148. </summary>
  4149. </member>
  4150. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiMediaType)">
  4151. <summary>
  4152. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
  4153. </summary>
  4154. </member>
  4155. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiEncoding)">
  4156. <summary>
  4157. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
  4158. </summary>
  4159. </member>
  4160. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
  4161. <summary>
  4162. Visits the examples.
  4163. </summary>
  4164. </member>
  4165. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiComponents)">
  4166. <summary>
  4167. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
  4168. </summary>
  4169. </member>
  4170. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
  4171. <summary>
  4172. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
  4173. </summary>
  4174. </member>
  4175. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
  4176. <summary>
  4177. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>
  4178. </summary>
  4179. </member>
  4180. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
  4181. <summary>
  4182. Visits the links.
  4183. </summary>
  4184. </member>
  4185. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiLink)">
  4186. <summary>
  4187. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/>
  4188. </summary>
  4189. </member>
  4190. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiCallback)">
  4191. <summary>
  4192. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
  4193. </summary>
  4194. </member>
  4195. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiTag)">
  4196. <summary>
  4197. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
  4198. </summary>
  4199. </member>
  4200. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiHeader)">
  4201. <summary>
  4202. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
  4203. </summary>
  4204. </member>
  4205. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
  4206. <summary>
  4207. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>
  4208. </summary>
  4209. </member>
  4210. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
  4211. <summary>
  4212. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
  4213. </summary>
  4214. </member>
  4215. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
  4216. <summary>
  4217. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/>
  4218. </summary>
  4219. </member>
  4220. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiExample)">
  4221. <summary>
  4222. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
  4223. </summary>
  4224. </member>
  4225. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiTag})">
  4226. <summary>
  4227. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
  4228. </summary>
  4229. </member>
  4230. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSecurityRequirement})">
  4231. <summary>
  4232. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
  4233. </summary>
  4234. </member>
  4235. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
  4236. <summary>
  4237. Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>
  4238. </summary>
  4239. </member>
  4240. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
  4241. <summary>
  4242. Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
  4243. </summary>
  4244. </member>
  4245. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
  4246. <summary>
  4247. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
  4248. </summary>
  4249. </member>
  4250. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiServerVariable})">
  4251. <summary>
  4252. Visits a dictionary of server variables
  4253. </summary>
  4254. </member>
  4255. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiEncoding})">
  4256. <summary>
  4257. Visits a dictionary of encodings
  4258. </summary>
  4259. <param name="encodings"></param>
  4260. </member>
  4261. <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
  4262. <summary>
  4263. Visits IOpenApiReferenceable instances that are references and not in components
  4264. </summary>
  4265. <param name="referenceable">referenced object</param>
  4266. </member>
  4267. <member name="T:Microsoft.OpenApi.Services.OpenApiWalker">
  4268. <summary>
  4269. The walker to visit multiple Open API elements.
  4270. </summary>
  4271. </member>
  4272. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.#ctor(Microsoft.OpenApi.Services.OpenApiVisitorBase)">
  4273. <summary>
  4274. Initializes the <see cref="T:Microsoft.OpenApi.Services.OpenApiWalker"/> class.
  4275. </summary>
  4276. </member>
  4277. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiDocument)">
  4278. <summary>
  4279. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> and child objects
  4280. </summary>
  4281. <param name="doc">OpenApiDocument to be walked</param>
  4282. </member>
  4283. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiTag})">
  4284. <summary>
  4285. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> and child objects
  4286. </summary>
  4287. </member>
  4288. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
  4289. <summary>
  4290. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> and child objects
  4291. </summary>
  4292. </member>
  4293. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiComponents)">
  4294. <summary>
  4295. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> and child objects
  4296. </summary>
  4297. </member>
  4298. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiPaths)">
  4299. <summary>
  4300. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/> and child objects
  4301. </summary>
  4302. </member>
  4303. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiServer})">
  4304. <summary>
  4305. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> and child objects
  4306. </summary>
  4307. </member>
  4308. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiInfo)">
  4309. <summary>
  4310. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> and child objects
  4311. </summary>
  4312. </member>
  4313. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
  4314. <summary>
  4315. Visits dictionary of extensions
  4316. </summary>
  4317. </member>
  4318. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
  4319. <summary>
  4320. Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
  4321. </summary>
  4322. </member>
  4323. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiLicense)">
  4324. <summary>
  4325. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> and child objects
  4326. </summary>
  4327. </member>
  4328. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiContact)">
  4329. <summary>
  4330. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> and child objects
  4331. </summary>
  4332. </member>
  4333. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiCallback,System.Boolean)">
  4334. <summary>
  4335. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> and child objects
  4336. </summary>
  4337. </member>
  4338. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiTag)">
  4339. <summary>
  4340. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> and child objects
  4341. </summary>
  4342. </member>
  4343. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiServer)">
  4344. <summary>
  4345. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> and child objects
  4346. </summary>
  4347. </member>
  4348. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiServerVariable})">
  4349. <summary>
  4350. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/>
  4351. </summary>
  4352. </member>
  4353. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiServerVariable)">
  4354. <summary>
  4355. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> and child objects
  4356. </summary>
  4357. </member>
  4358. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiPathItem)">
  4359. <summary>
  4360. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> and child objects
  4361. </summary>
  4362. </member>
  4363. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation})">
  4364. <summary>
  4365. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/>
  4366. </summary>
  4367. </member>
  4368. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOperation)">
  4369. <summary>
  4370. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> and child objects
  4371. </summary>
  4372. <param name="operation"></param>
  4373. </member>
  4374. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSecurityRequirement})">
  4375. <summary>
  4376. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
  4377. </summary>
  4378. </member>
  4379. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
  4380. <summary>
  4381. Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
  4382. </summary>
  4383. </member>
  4384. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiParameter,System.Boolean)">
  4385. <summary>
  4386. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> and child objects
  4387. </summary>
  4388. </member>
  4389. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiResponses)">
  4390. <summary>
  4391. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/> and child objects
  4392. </summary>
  4393. </member>
  4394. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiResponse,System.Boolean)">
  4395. <summary>
  4396. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> and child objects
  4397. </summary>
  4398. </member>
  4399. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiRequestBody,System.Boolean)">
  4400. <summary>
  4401. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> and child objects
  4402. </summary>
  4403. </member>
  4404. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
  4405. <summary>
  4406. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
  4407. </summary>
  4408. </member>
  4409. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
  4410. <summary>
  4411. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
  4412. </summary>
  4413. </member>
  4414. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiMediaType})">
  4415. <summary>
  4416. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
  4417. </summary>
  4418. </member>
  4419. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiMediaType)">
  4420. <summary>
  4421. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> and child objects
  4422. </summary>
  4423. </member>
  4424. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiEncoding})">
  4425. <summary>
  4426. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
  4427. </summary>
  4428. </member>
  4429. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiEncoding)">
  4430. <summary>
  4431. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/> and child objects
  4432. </summary>
  4433. </member>
  4434. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSchema,System.Boolean)">
  4435. <summary>
  4436. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> and child objects
  4437. </summary>
  4438. </member>
  4439. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
  4440. <summary>
  4441. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
  4442. </summary>
  4443. </member>
  4444. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Any.IOpenApiAny)">
  4445. <summary>
  4446. Visits <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> and child objects
  4447. </summary>
  4448. </member>
  4449. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiExample,System.Boolean)">
  4450. <summary>
  4451. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> and child objects
  4452. </summary>
  4453. </member>
  4454. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
  4455. <summary>
  4456. Visits the list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> and child objects
  4457. </summary>
  4458. </member>
  4459. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSchema})">
  4460. <summary>
  4461. Visits a list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> and child objects
  4462. </summary>
  4463. </member>
  4464. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOAuthFlows)">
  4465. <summary>
  4466. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> and child objects
  4467. </summary>
  4468. </member>
  4469. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
  4470. <summary>
  4471. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> and child objects
  4472. </summary>
  4473. </member>
  4474. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
  4475. <summary>
  4476. Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> and child objects
  4477. </summary>
  4478. </member>
  4479. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiLink,System.Boolean)">
  4480. <summary>
  4481. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> and child objects
  4482. </summary>
  4483. </member>
  4484. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiHeader,System.Boolean)">
  4485. <summary>
  4486. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> and child objects
  4487. </summary>
  4488. </member>
  4489. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
  4490. <summary>
  4491. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> and child objects
  4492. </summary>
  4493. </member>
  4494. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
  4495. <summary>
  4496. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> and child objects
  4497. </summary>
  4498. </member>
  4499. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
  4500. <summary>
  4501. Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> and child objects
  4502. </summary>
  4503. </member>
  4504. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiElement)">
  4505. <summary>
  4506. Dispatcher method that enables using a single method to walk the model
  4507. starting from any <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/>
  4508. </summary>
  4509. </member>
  4510. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.String,System.Action)">
  4511. <summary>
  4512. Adds a segment to the context path to enable pointing to the current location in the document
  4513. </summary>
  4514. <param name="context">An identifier for the context.</param>
  4515. <param name="walk">An action that walks objects within the context.</param>
  4516. </member>
  4517. <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.ProcessAsReference(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable,System.Boolean)">
  4518. <summary>
  4519. Identify if an element is just a reference to a component, or an actual component
  4520. </summary>
  4521. </member>
  4522. <member name="T:Microsoft.OpenApi.Services.CurrentKeys">
  4523. <summary>
  4524. Object containing contextual information based on where the walker is currently referencing in an OpenApiDocument
  4525. </summary>
  4526. </member>
  4527. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Path">
  4528. <summary>
  4529. Current Path key
  4530. </summary>
  4531. </member>
  4532. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Operation">
  4533. <summary>
  4534. Current Operation Type
  4535. </summary>
  4536. </member>
  4537. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Response">
  4538. <summary>
  4539. Current Response Status Code
  4540. </summary>
  4541. </member>
  4542. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Content">
  4543. <summary>
  4544. Current Content Media Type
  4545. </summary>
  4546. </member>
  4547. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Callback">
  4548. <summary>
  4549. Current Callback Key
  4550. </summary>
  4551. </member>
  4552. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Link">
  4553. <summary>
  4554. Current Link Key
  4555. </summary>
  4556. </member>
  4557. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Header">
  4558. <summary>
  4559. Current Header Key
  4560. </summary>
  4561. </member>
  4562. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Encoding">
  4563. <summary>
  4564. Current Encoding Key
  4565. </summary>
  4566. </member>
  4567. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Example">
  4568. <summary>
  4569. Current Example Key
  4570. </summary>
  4571. </member>
  4572. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Extension">
  4573. <summary>
  4574. Current Extension Key
  4575. </summary>
  4576. </member>
  4577. <member name="P:Microsoft.OpenApi.Services.CurrentKeys.ServerVariable">
  4578. <summary>
  4579. Current ServerVariable
  4580. </summary>
  4581. </member>
  4582. <member name="T:Microsoft.OpenApi.Validations.IValidationContext">
  4583. <summary>
  4584. Constrained interface used to provide context to rule implementation
  4585. </summary>
  4586. </member>
  4587. <member name="M:Microsoft.OpenApi.Validations.IValidationContext.AddError(Microsoft.OpenApi.Validations.OpenApiValidatorError)">
  4588. <summary>
  4589. Register an error with the validation context.
  4590. </summary>
  4591. <param name="error">Error to register.</param>
  4592. </member>
  4593. <member name="M:Microsoft.OpenApi.Validations.IValidationContext.Enter(System.String)">
  4594. <summary>
  4595. Allow Rule to indicate validation error occured at a deeper context level.
  4596. </summary>
  4597. <param name="segment">Identifier for context</param>
  4598. </member>
  4599. <member name="M:Microsoft.OpenApi.Validations.IValidationContext.Exit">
  4600. <summary>
  4601. Exit from path context elevel. Enter and Exit calls should be matched.
  4602. </summary>
  4603. </member>
  4604. <member name="P:Microsoft.OpenApi.Validations.IValidationContext.PathString">
  4605. <summary>
  4606. Pointer to source of validation error in document
  4607. </summary>
  4608. </member>
  4609. <member name="T:Microsoft.OpenApi.Validations.OpenApiValidator">
  4610. <summary>
  4611. Class containing dispatchers to execute validation rules on for Open API document.
  4612. </summary>
  4613. </member>
  4614. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.#ctor(Microsoft.OpenApi.Validations.ValidationRuleSet)">
  4615. <summary>
  4616. Create a vistor that will validate an OpenAPIDocument
  4617. </summary>
  4618. <param name="ruleSet"></param>
  4619. </member>
  4620. <member name="P:Microsoft.OpenApi.Validations.OpenApiValidator.Errors">
  4621. <summary>
  4622. Gets the validation errors.
  4623. </summary>
  4624. </member>
  4625. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.AddError(Microsoft.OpenApi.Validations.OpenApiValidatorError)">
  4626. <summary>
  4627. Register an error with the validation context.
  4628. </summary>
  4629. <param name="error">Error to register.</param>
  4630. </member>
  4631. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiDocument)">
  4632. <summary>
  4633. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>
  4634. </summary>
  4635. <param name="item">The object to be validated</param>
  4636. </member>
  4637. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiInfo)">
  4638. <summary>
  4639. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>
  4640. </summary>
  4641. <param name="item">The object to be validated</param>
  4642. </member>
  4643. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiContact)">
  4644. <summary>
  4645. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>
  4646. </summary>
  4647. <param name="item">The object to be validated</param>
  4648. </member>
  4649. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiComponents)">
  4650. <summary>
  4651. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
  4652. </summary>
  4653. <param name="item">The object to be validated</param>
  4654. </member>
  4655. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiHeader)">
  4656. <summary>
  4657. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
  4658. </summary>
  4659. <param name="item">The object to be validated</param>
  4660. </member>
  4661. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiResponse)">
  4662. <summary>
  4663. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>
  4664. </summary>
  4665. <param name="item">The object to be validated</param>
  4666. </member>
  4667. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiMediaType)">
  4668. <summary>
  4669. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
  4670. </summary>
  4671. <param name="item">The object to be validated</param>
  4672. </member>
  4673. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiResponses)">
  4674. <summary>
  4675. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>
  4676. </summary>
  4677. <param name="item">The object to be validated</param>
  4678. </member>
  4679. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
  4680. <summary>
  4681. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/>
  4682. </summary>
  4683. <param name="item">The object to be validated</param>
  4684. </member>
  4685. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiLicense)">
  4686. <summary>
  4687. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>
  4688. </summary>
  4689. <param name="item">The object to be validated</param>
  4690. </member>
  4691. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
  4692. <summary>
  4693. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>
  4694. </summary>
  4695. <param name="item">The object to be validated</param>
  4696. </member>
  4697. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiTag)">
  4698. <summary>
  4699. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
  4700. </summary>
  4701. <param name="item">The object to be validated</param>
  4702. </member>
  4703. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiParameter)">
  4704. <summary>
  4705. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
  4706. </summary>
  4707. <param name="item">The object to be validated</param>
  4708. </member>
  4709. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
  4710. <summary>
  4711. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>
  4712. </summary>
  4713. <param name="item">The object to be validated</param>
  4714. </member>
  4715. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiServer)">
  4716. <summary>
  4717. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
  4718. </summary>
  4719. <param name="item">The object to be validated</param>
  4720. </member>
  4721. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiEncoding)">
  4722. <summary>
  4723. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
  4724. </summary>
  4725. <param name="item">The object to be validated</param>
  4726. </member>
  4727. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiCallback)">
  4728. <summary>
  4729. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
  4730. </summary>
  4731. <param name="item">The object to be validated</param>
  4732. </member>
  4733. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
  4734. <summary>
  4735. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>
  4736. </summary>
  4737. <param name="item">The object to be validated</param>
  4738. </member>
  4739. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
  4740. <summary>
  4741. Execute validation rules against an <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
  4742. </summary>
  4743. <param name="item">The object to be validated</param>
  4744. </member>
  4745. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
  4746. <summary>
  4747. Execute validation rules against a list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
  4748. </summary>
  4749. <param name="items">The object to be validated</param>
  4750. </member>
  4751. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Validate(System.Object,System.Type)">
  4752. <summary>
  4753. This overload allows applying rules based on actual object type, rather than matched interface. This is
  4754. needed for validating extensions.
  4755. </summary>
  4756. </member>
  4757. <member name="T:Microsoft.OpenApi.Validations.OpenApiValidatorError">
  4758. <summary>
  4759. Errors detected when validating an OpenAPI Element
  4760. </summary>
  4761. </member>
  4762. <member name="M:Microsoft.OpenApi.Validations.OpenApiValidatorError.#ctor(System.String,System.String,System.String)">
  4763. <summary>
  4764. Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class.
  4765. </summary>
  4766. </member>
  4767. <member name="P:Microsoft.OpenApi.Validations.OpenApiValidatorError.RuleName">
  4768. <summary>
  4769. Name of rule that detected the error.
  4770. </summary>
  4771. </member>
  4772. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules">
  4773. <summary>
  4774. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>.
  4775. </summary>
  4776. </member>
  4777. <member name="F:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules.KeyRegex">
  4778. <summary>
  4779. The key regex.
  4780. </summary>
  4781. </member>
  4782. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules.KeyMustBeRegularExpression">
  4783. <summary>
  4784. All the fixed fields declared above are objects
  4785. that MUST use keys that match the regular expression: ^[a-zA-Z0-9\.\-_]+$.
  4786. </summary>
  4787. </member>
  4788. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiContactRules">
  4789. <summary>
  4790. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>.
  4791. </summary>
  4792. </member>
  4793. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiContactRules.EmailMustBeEmailFormat">
  4794. <summary>
  4795. Email field MUST be email address.
  4796. </summary>
  4797. </member>
  4798. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiDocumentRules">
  4799. <summary>
  4800. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>.
  4801. </summary>
  4802. </member>
  4803. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiDocumentRules.OpenApiDocumentFieldIsMissing">
  4804. <summary>
  4805. The Info field is required.
  4806. </summary>
  4807. </member>
  4808. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiExtensibleRules">
  4809. <summary>
  4810. The validation rules for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>.
  4811. </summary>
  4812. </member>
  4813. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiExtensibleRules.ExtensionNameMustStartWithXDash">
  4814. <summary>
  4815. Extension name MUST start with "x-".
  4816. </summary>
  4817. </member>
  4818. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiExternalDocsRules">
  4819. <summary>
  4820. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/>.
  4821. </summary>
  4822. </member>
  4823. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiExternalDocsRules.UrlIsRequired">
  4824. <summary>
  4825. Validate the field is required.
  4826. </summary>
  4827. </member>
  4828. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiHeaderRules">
  4829. <summary>
  4830. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>.
  4831. </summary>
  4832. </member>
  4833. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiHeaderRules.HeaderMismatchedDataType">
  4834. <summary>
  4835. Validate the data matches with the given data type.
  4836. </summary>
  4837. </member>
  4838. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiInfoRules">
  4839. <summary>
  4840. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>.
  4841. </summary>
  4842. </member>
  4843. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiInfoRules.InfoRequiredFields">
  4844. <summary>
  4845. Validate the field is required.
  4846. </summary>
  4847. </member>
  4848. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiLicenseRules">
  4849. <summary>
  4850. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>.
  4851. </summary>
  4852. </member>
  4853. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiLicenseRules.LicenseRequiredFields">
  4854. <summary>
  4855. REQUIRED.
  4856. </summary>
  4857. </member>
  4858. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiMediaTypeRules">
  4859. <summary>
  4860. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>.
  4861. </summary>
  4862. </member>
  4863. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiMediaTypeRules.MediaTypeMismatchedDataType">
  4864. <summary>
  4865. Validate the data matches with the given data type.
  4866. </summary>
  4867. </member>
  4868. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiOAuthFlowRules">
  4869. <summary>
  4870. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>.
  4871. </summary>
  4872. </member>
  4873. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiOAuthFlowRules.OAuthFlowRequiredFields">
  4874. <summary>
  4875. Validate the field is required.
  4876. </summary>
  4877. </member>
  4878. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules">
  4879. <summary>
  4880. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>.
  4881. </summary>
  4882. </member>
  4883. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.ParameterRequiredFields">
  4884. <summary>
  4885. Validate the field is required.
  4886. </summary>
  4887. </member>
  4888. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.RequiredMustBeTrueWhenInIsPath">
  4889. <summary>
  4890. Validate the "required" field is true when "in" is path.
  4891. </summary>
  4892. </member>
  4893. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.ParameterMismatchedDataType">
  4894. <summary>
  4895. Validate the data matches with the given data type.
  4896. </summary>
  4897. </member>
  4898. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiPathsRules">
  4899. <summary>
  4900. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>.
  4901. </summary>
  4902. </member>
  4903. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiPathsRules.PathNameMustBeginWithSlash">
  4904. <summary>
  4905. A relative path to an individual endpoint. The field name MUST begin with a slash.
  4906. </summary>
  4907. </member>
  4908. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiResponseRules">
  4909. <summary>
  4910. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>.
  4911. </summary>
  4912. </member>
  4913. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponseRules.ResponseRequiredFields">
  4914. <summary>
  4915. Validate the field is required.
  4916. </summary>
  4917. </member>
  4918. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules">
  4919. <summary>
  4920. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>.
  4921. </summary>
  4922. </member>
  4923. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules.ResponsesMustContainAtLeastOneResponse">
  4924. <summary>
  4925. An OpenAPI operation must contain at least one response
  4926. </summary>
  4927. </member>
  4928. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules.ResponsesMustBeIdentifiedByDefaultOrStatusCode">
  4929. <summary>
  4930. The response key must either be "default" or an HTTP status code (1xx, 2xx, 3xx, 4xx, 5xx).
  4931. </summary>
  4932. </member>
  4933. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiRuleAttribute">
  4934. <summary>
  4935. The Validator attribute.
  4936. </summary>
  4937. </member>
  4938. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules">
  4939. <summary>
  4940. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>.
  4941. </summary>
  4942. </member>
  4943. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules.SchemaMismatchedDataType">
  4944. <summary>
  4945. Validate the data matches with the given data type.
  4946. </summary>
  4947. </member>
  4948. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules.ValidateSchemaDiscriminator">
  4949. <summary>
  4950. Validates Schema Discriminator
  4951. </summary>
  4952. </member>
  4953. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiServerRules">
  4954. <summary>
  4955. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>.
  4956. </summary>
  4957. </member>
  4958. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiServerRules.ServerRequiredFields">
  4959. <summary>
  4960. Validate the field is required.
  4961. </summary>
  4962. </member>
  4963. <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiTagRules">
  4964. <summary>
  4965. The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>.
  4966. </summary>
  4967. </member>
  4968. <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiTagRules.TagRequiredFields">
  4969. <summary>
  4970. Validate the field is required.
  4971. </summary>
  4972. </member>
  4973. <member name="M:Microsoft.OpenApi.Validations.Rules.RuleHelpers.IsEmailAddress(System.String)">
  4974. <summary>
  4975. Input string must be in the format of an email address
  4976. </summary>
  4977. <param name="input">The input string.</param>
  4978. <returns>True if it's an email address. Otherwise False.</returns>
  4979. </member>
  4980. <member name="T:Microsoft.OpenApi.Validations.ValidationContextExtensions">
  4981. <summary>
  4982. Helper methods to simplify creating validation rules
  4983. </summary>
  4984. </member>
  4985. <member name="M:Microsoft.OpenApi.Validations.ValidationContextExtensions.CreateError(Microsoft.OpenApi.Validations.IValidationContext,System.String,System.String)">
  4986. <summary>
  4987. Helper method to simplify validation rules
  4988. </summary>
  4989. </member>
  4990. <member name="T:Microsoft.OpenApi.Validations.ValidationRule">
  4991. <summary>
  4992. Class containing validation rule logic.
  4993. </summary>
  4994. </member>
  4995. <member name="P:Microsoft.OpenApi.Validations.ValidationRule.ElementType">
  4996. <summary>
  4997. Element Type.
  4998. </summary>
  4999. </member>
  5000. <member name="M:Microsoft.OpenApi.Validations.ValidationRule.Evaluate(Microsoft.OpenApi.Validations.IValidationContext,System.Object)">
  5001. <summary>
  5002. Validate the object.
  5003. </summary>
  5004. <param name="context">The context.</param>
  5005. <param name="item">The object item.</param>
  5006. </member>
  5007. <member name="T:Microsoft.OpenApi.Validations.ValidationRule`1">
  5008. <summary>
  5009. Class containing validation rule logic for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/>.
  5010. </summary>
  5011. <typeparam name="T"></typeparam>
  5012. </member>
  5013. <member name="M:Microsoft.OpenApi.Validations.ValidationRule`1.#ctor(System.Action{Microsoft.OpenApi.Validations.IValidationContext,`0})">
  5014. <summary>
  5015. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRule"/> class.
  5016. </summary>
  5017. <param name="validate">Action to perform the validation.</param>
  5018. </member>
  5019. <member name="T:Microsoft.OpenApi.Validations.ValidationRuleSet">
  5020. <summary>
  5021. The rule set of the validation.
  5022. </summary>
  5023. </member>
  5024. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.FindRules(System.Type)">
  5025. <summary>
  5026. Retrieve the rules that are related to a specific type
  5027. </summary>
  5028. <param name="type">The type that is to be validated</param>
  5029. <returns>Either the rules related to the type, or an empty list.</returns>
  5030. </member>
  5031. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.GetDefaultRuleSet">
  5032. <summary>
  5033. Gets the default validation rule sets.
  5034. </summary>
  5035. <remarks>
  5036. This is a method instead of a property to signal that a new default ruleset object is created
  5037. per call. Making this a property may be misleading callers to think the returned rulesets from multiple calls
  5038. are the same objects.
  5039. </remarks>
  5040. </member>
  5041. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.GetEmptyRuleSet">
  5042. <summary>
  5043. Return Ruleset with no rules
  5044. </summary>
  5045. </member>
  5046. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor">
  5047. <summary>
  5048. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
  5049. </summary>
  5050. </member>
  5051. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor(Microsoft.OpenApi.Validations.ValidationRuleSet)">
  5052. <summary>
  5053. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
  5054. </summary>
  5055. <param name="ruleSet">Rule set to be copied from.</param>
  5056. </member>
  5057. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor(System.Collections.Generic.IEnumerable{Microsoft.OpenApi.Validations.ValidationRule})">
  5058. <summary>
  5059. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
  5060. </summary>
  5061. <param name="rules">Rules to be contained in this ruleset.</param>
  5062. </member>
  5063. <member name="P:Microsoft.OpenApi.Validations.ValidationRuleSet.Rules">
  5064. <summary>
  5065. Gets the rules in this rule set.
  5066. </summary>
  5067. </member>
  5068. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.Add(Microsoft.OpenApi.Validations.ValidationRule)">
  5069. <summary>
  5070. Add the new rule into the rule set.
  5071. </summary>
  5072. <param name="rule">The rule.</param>
  5073. </member>
  5074. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.GetEnumerator">
  5075. <summary>
  5076. Get the enumerator.
  5077. </summary>
  5078. <returns>The enumerator.</returns>
  5079. </member>
  5080. <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.System#Collections#IEnumerable#GetEnumerator">
  5081. <summary>
  5082. Get the enumerator.
  5083. </summary>
  5084. <returns>The enumerator.</returns>
  5085. </member>
  5086. <member name="T:Microsoft.OpenApi.Writers.FormattingStreamWriter">
  5087. <summary>
  5088. A custom <see cref="T:System.IO.StreamWriter"/> which supports setting a <see cref="T:System.IFormatProvider"/>.
  5089. </summary>
  5090. </member>
  5091. <member name="M:Microsoft.OpenApi.Writers.FormattingStreamWriter.#ctor(System.IO.Stream,System.IFormatProvider)">
  5092. <summary>
  5093. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.FormattingStreamWriter"/> class.
  5094. </summary>
  5095. <param name="stream"></param>
  5096. <param name="formatProvider"></param>
  5097. </member>
  5098. <member name="P:Microsoft.OpenApi.Writers.FormattingStreamWriter.FormatProvider">
  5099. <summary>
  5100. The <see cref="T:System.IFormatProvider"/> associated with this <see cref="T:Microsoft.OpenApi.Writers.FormattingStreamWriter"/>.
  5101. </summary>
  5102. </member>
  5103. <member name="T:Microsoft.OpenApi.Writers.IOpenApiWriter">
  5104. <summary>
  5105. Interface for writing Open API documentation.
  5106. </summary>
  5107. </member>
  5108. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteStartObject">
  5109. <summary>
  5110. Write the start object.
  5111. </summary>
  5112. </member>
  5113. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteEndObject">
  5114. <summary>
  5115. Write the end object.
  5116. </summary>
  5117. </member>
  5118. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteStartArray">
  5119. <summary>
  5120. Write the start array.
  5121. </summary>
  5122. </member>
  5123. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteEndArray">
  5124. <summary>
  5125. Write the end array.
  5126. </summary>
  5127. </member>
  5128. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WritePropertyName(System.String)">
  5129. <summary>
  5130. Write the property name.
  5131. </summary>
  5132. </member>
  5133. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.String)">
  5134. <summary>
  5135. Write the string value.
  5136. </summary>
  5137. </member>
  5138. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Decimal)">
  5139. <summary>
  5140. Write the decimal value.
  5141. </summary>
  5142. </member>
  5143. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Int32)">
  5144. <summary>
  5145. Write the int value.
  5146. </summary>
  5147. </member>
  5148. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Boolean)">
  5149. <summary>
  5150. Write the boolean value.
  5151. </summary>
  5152. </member>
  5153. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteNull">
  5154. <summary>
  5155. Write the null value.
  5156. </summary>
  5157. </member>
  5158. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteRaw(System.String)">
  5159. <summary>
  5160. Write the raw content value.
  5161. </summary>
  5162. </member>
  5163. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Object)">
  5164. <summary>
  5165. Write the object value.
  5166. </summary>
  5167. </member>
  5168. <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.Flush">
  5169. <summary>
  5170. Flush the writer.
  5171. </summary>
  5172. </member>
  5173. <member name="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter">
  5174. <summary>
  5175. JSON Writer.
  5176. </summary>
  5177. </member>
  5178. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.#ctor(System.IO.TextWriter)">
  5179. <summary>
  5180. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter"/> class.
  5181. </summary>
  5182. <param name="textWriter">The text writer.</param>
  5183. </member>
  5184. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
  5185. <summary>
  5186. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter"/> class.
  5187. </summary>
  5188. <param name="textWriter">The text writer.</param>
  5189. <param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
  5190. </member>
  5191. <member name="P:Microsoft.OpenApi.Writers.OpenApiJsonWriter.BaseIndentation">
  5192. <summary>
  5193. Base Indentation Level.
  5194. This denotes how many indentations are needed for the property in the base object.
  5195. </summary>
  5196. </member>
  5197. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteStartObject">
  5198. <summary>
  5199. Write JSON start object.
  5200. </summary>
  5201. </member>
  5202. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteEndObject">
  5203. <summary>
  5204. Write JSON end object.
  5205. </summary>
  5206. </member>
  5207. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteStartArray">
  5208. <summary>
  5209. Write JSON start array.
  5210. </summary>
  5211. </member>
  5212. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteEndArray">
  5213. <summary>
  5214. Write JSON end array.
  5215. </summary>
  5216. </member>
  5217. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WritePropertyName(System.String)">
  5218. <summary>
  5219. Write property name.
  5220. </summary>
  5221. <param name="name">The property name.</param>
  5222. public override void WritePropertyName(string name)
  5223. </member>
  5224. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteValue(System.String)">
  5225. <summary>
  5226. Write string value.
  5227. </summary>
  5228. <param name="value">The string value.</param>
  5229. </member>
  5230. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteNull">
  5231. <summary>
  5232. Write null value.
  5233. </summary>
  5234. </member>
  5235. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteValueSeparator">
  5236. <summary>
  5237. Writes a separator of a value if it's needed for the next value to be written.
  5238. </summary>
  5239. </member>
  5240. <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteRaw(System.String)">
  5241. <summary>
  5242. Writes the content raw value.
  5243. </summary>
  5244. </member>
  5245. <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterAnyExtensions">
  5246. <summary>
  5247. Extensions methods for writing the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
  5248. </summary>
  5249. </member>
  5250. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterAnyExtensions.WriteExtensions(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Interfaces.IOpenApiExtension},Microsoft.OpenApi.OpenApiSpecVersion)">
  5251. <summary>
  5252. Write the specification extensions
  5253. </summary>
  5254. <param name="writer">The Open API writer.</param>
  5255. <param name="extensions">The specification extensions.</param>
  5256. <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
  5257. </member>
  5258. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterAnyExtensions.WriteAny``1(Microsoft.OpenApi.Writers.IOpenApiWriter,``0)">
  5259. <summary>
  5260. Write the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> value.
  5261. </summary>
  5262. <typeparam name="T">The Open API Any type.</typeparam>
  5263. <param name="writer">The Open API writer.</param>
  5264. <param name="any">The Any value</param>
  5265. </member>
  5266. <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterBase">
  5267. <summary>
  5268. Base class for Open API writer.
  5269. </summary>
  5270. </member>
  5271. <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterBase.Settings">
  5272. <summary>
  5273. Settings for controlling how the OpenAPI document will be written out.
  5274. </summary>
  5275. </member>
  5276. <member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase.IndentationString">
  5277. <summary>
  5278. The indentation string to prepand to each line for each indentation level.
  5279. </summary>
  5280. </member>
  5281. <member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase.Scopes">
  5282. <summary>
  5283. Scope of the Open API element - object, array, property.
  5284. </summary>
  5285. </member>
  5286. <member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase._indentLevel">
  5287. <summary>
  5288. Number which specifies the level of indentation.
  5289. </summary>
  5290. </member>
  5291. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.#ctor(System.IO.TextWriter)">
  5292. <summary>
  5293. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiWriterBase"/> class.
  5294. </summary>
  5295. <param name="textWriter">The text writer.</param>
  5296. </member>
  5297. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
  5298. <summary>
  5299. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiWriterBase"/> class.
  5300. </summary>
  5301. <param name="textWriter"></param>
  5302. <param name="settings"></param>
  5303. </member>
  5304. <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterBase.BaseIndentation">
  5305. <summary>
  5306. Base Indentation Level.
  5307. This denotes how many indentations are needed for the property in the base object.
  5308. </summary>
  5309. </member>
  5310. <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterBase.Writer">
  5311. <summary>
  5312. The text writer.
  5313. </summary>
  5314. </member>
  5315. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteStartObject">
  5316. <summary>
  5317. Write start object.
  5318. </summary>
  5319. </member>
  5320. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteEndObject">
  5321. <summary>
  5322. Write end object.
  5323. </summary>
  5324. </member>
  5325. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteStartArray">
  5326. <summary>
  5327. Write start array.
  5328. </summary>
  5329. </member>
  5330. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteEndArray">
  5331. <summary>
  5332. Write end array.
  5333. </summary>
  5334. </member>
  5335. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WritePropertyName(System.String)">
  5336. <summary>
  5337. Write the start property.
  5338. </summary>
  5339. </member>
  5340. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValueSeparator">
  5341. <summary>
  5342. Writes a separator of a value if it's needed for the next value to be written.
  5343. </summary>
  5344. </member>
  5345. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteNull">
  5346. <summary>
  5347. Write null value.
  5348. </summary>
  5349. </member>
  5350. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteRaw(System.String)">
  5351. <summary>
  5352. Write content raw value.
  5353. </summary>
  5354. </member>
  5355. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.Flush">
  5356. <summary>
  5357. Flush the writer.
  5358. </summary>
  5359. </member>
  5360. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.String)">
  5361. <summary>
  5362. Write string value.
  5363. </summary>
  5364. <param name="value">The string value.</param>
  5365. </member>
  5366. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Single)">
  5367. <summary>
  5368. Write float value.
  5369. </summary>
  5370. <param name="value">The float value.</param>
  5371. </member>
  5372. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Double)">
  5373. <summary>
  5374. Write double value.
  5375. </summary>
  5376. <param name="value">The double value.</param>
  5377. </member>
  5378. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Decimal)">
  5379. <summary>
  5380. Write decimal value.
  5381. </summary>
  5382. <param name="value">The decimal value.</param>
  5383. </member>
  5384. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Int32)">
  5385. <summary>
  5386. Write integer value.
  5387. </summary>
  5388. <param name="value">The integer value.</param>
  5389. </member>
  5390. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Int64)">
  5391. <summary>
  5392. Write long value.
  5393. </summary>
  5394. <param name="value">The long value.</param>
  5395. </member>
  5396. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.DateTime)">
  5397. <summary>
  5398. Write DateTime value.
  5399. </summary>
  5400. <param name="value">The DateTime value.</param>
  5401. </member>
  5402. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.DateTimeOffset)">
  5403. <summary>
  5404. Write DateTimeOffset value.
  5405. </summary>
  5406. <param name="value">The DateTimeOffset value.</param>
  5407. </member>
  5408. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Boolean)">
  5409. <summary>
  5410. Write boolean value.
  5411. </summary>
  5412. <param name="value">The boolean value.</param>
  5413. </member>
  5414. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Object)">
  5415. <summary>
  5416. Write object value.
  5417. </summary>
  5418. <param name="value">The object value.</param>
  5419. </member>
  5420. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IncreaseIndentation">
  5421. <summary>
  5422. Increases the level of indentation applied to the output.
  5423. </summary>
  5424. </member>
  5425. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.DecreaseIndentation">
  5426. <summary>
  5427. Decreases the level of indentation applied to the output.
  5428. </summary>
  5429. </member>
  5430. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteIndentation">
  5431. <summary>
  5432. Write the indentation.
  5433. </summary>
  5434. </member>
  5435. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.CurrentScope">
  5436. <summary>
  5437. Get current scope.
  5438. </summary>
  5439. <returns></returns>
  5440. </member>
  5441. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.StartScope(Microsoft.OpenApi.Writers.ScopeType)">
  5442. <summary>
  5443. Start the scope given the scope type.
  5444. </summary>
  5445. <param name="type">The scope type to start.</param>
  5446. </member>
  5447. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.EndScope(Microsoft.OpenApi.Writers.ScopeType)">
  5448. <summary>
  5449. End the scope of the given scope type.
  5450. </summary>
  5451. <param name="type"></param>
  5452. <returns></returns>
  5453. </member>
  5454. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsTopLevelScope">
  5455. <summary>
  5456. Whether the current scope is the top level (outermost) scope.
  5457. </summary>
  5458. </member>
  5459. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsObjectScope">
  5460. <summary>
  5461. Whether the current scope is an object scope.
  5462. </summary>
  5463. </member>
  5464. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsArrayScope">
  5465. <summary>
  5466. Whether the current scope is an array scope.
  5467. </summary>
  5468. <returns></returns>
  5469. </member>
  5470. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.VerifyCanWritePropertyName(System.String)">
  5471. <summary>
  5472. Verifies whether a property name can be written based on whether
  5473. the property name is a valid string and whether the current scope is an object scope.
  5474. </summary>
  5475. <param name="name">property name</param>
  5476. </member>
  5477. <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterExtensions">
  5478. <summary>
  5479. Extension methods for writing Open API documentation.
  5480. </summary>
  5481. </member>
  5482. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.String)">
  5483. <summary>
  5484. Write a string property.
  5485. </summary>
  5486. <param name="writer">The writer.</param>
  5487. <param name="name">The property name.</param>
  5488. <param name="value">The property value.</param>
  5489. </member>
  5490. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteRequiredProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.String)">
  5491. <summary>
  5492. Write required string property.
  5493. </summary>
  5494. <param name="writer">The writer.</param>
  5495. <param name="name">The property name.</param>
  5496. <param name="value">The property value.</param>
  5497. </member>
  5498. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Boolean,System.Boolean)">
  5499. <summary>
  5500. Write a boolean property.
  5501. </summary>
  5502. <param name="writer">The writer.</param>
  5503. <param name="name">The property name.</param>
  5504. <param name="value">The property value.</param>
  5505. <param name="defaultValue">The default boolean value.</param>
  5506. </member>
  5507. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Nullable{System.Boolean},System.Boolean)">
  5508. <summary>
  5509. Write a boolean property.
  5510. </summary>
  5511. <param name="writer">The writer.</param>
  5512. <param name="name">The property name.</param>
  5513. <param name="value">The property value.</param>
  5514. <param name="defaultValue">The default boolean value.</param>
  5515. </member>
  5516. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Nullable{``0})">
  5517. <summary>
  5518. Write a primitive property.
  5519. </summary>
  5520. <param name="writer">The writer.</param>
  5521. <param name="name">The property name.</param>
  5522. <param name="value">The property value.</param>
  5523. </member>
  5524. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0)">
  5525. <summary>
  5526. Write a string/number property.
  5527. </summary>
  5528. <param name="writer">The writer.</param>
  5529. <param name="name">The property name.</param>
  5530. <param name="value">The property value.</param>
  5531. </member>
  5532. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteOptionalObject``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
  5533. <summary>
  5534. Write the optional Open API object/element.
  5535. </summary>
  5536. <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  5537. <param name="writer">The Open API writer.</param>
  5538. <param name="name">The property name.</param>
  5539. <param name="value">The property value.</param>
  5540. <param name="action">The proprety value writer action.</param>
  5541. </member>
  5542. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteRequiredObject``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
  5543. <summary>
  5544. Write the required Open API object/element.
  5545. </summary>
  5546. <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  5547. <param name="writer">The Open API writer.</param>
  5548. <param name="name">The property name.</param>
  5549. <param name="value">The property value.</param>
  5550. <param name="action">The proprety value writer action.</param>
  5551. </member>
  5552. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteOptionalCollection(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{System.String},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,System.String})">
  5553. <summary>
  5554. Write the optional of collection string.
  5555. </summary>
  5556. <param name="writer">The Open API writer.</param>
  5557. <param name="name">The property name.</param>
  5558. <param name="elements">The collection values.</param>
  5559. <param name="action">The collection string writer action.</param>
  5560. </member>
  5561. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteOptionalCollection``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{``0},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
  5562. <summary>
  5563. Write the optional Open API object/element collection.
  5564. </summary>
  5565. <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  5566. <param name="writer">The Open API writer.</param>
  5567. <param name="name">The property name.</param>
  5568. <param name="elements">The collection values.</param>
  5569. <param name="action">The collection element writer action.</param>
  5570. </member>
  5571. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteRequiredCollection``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IEnumerable{``0},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
  5572. <summary>
  5573. Write the required Open API object/element collection.
  5574. </summary>
  5575. <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  5576. <param name="writer">The Open API writer.</param>
  5577. <param name="name">The property name.</param>
  5578. <param name="elements">The collection values.</param>
  5579. <param name="action">The collection element writer action.</param>
  5580. </member>
  5581. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteOptionalMap(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,System.String})">
  5582. <summary>
  5583. Write the optional Open API element map (string to string mapping).
  5584. </summary>
  5585. <param name="writer">The Open API writer.</param>
  5586. <param name="name">The property name.</param>
  5587. <param name="elements">The map values.</param>
  5588. <param name="action">The map element writer action.</param>
  5589. </member>
  5590. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteRequiredMap(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,System.String},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,System.String})">
  5591. <summary>
  5592. Write the required Open API element map (string to string mapping).
  5593. </summary>
  5594. <param name="writer">The Open API writer.</param>
  5595. <param name="name">The property name.</param>
  5596. <param name="elements">The map values.</param>
  5597. <param name="action">The map element writer action.</param>
  5598. </member>
  5599. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteOptionalMap``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
  5600. <summary>
  5601. Write the optional Open API element map.
  5602. </summary>
  5603. <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  5604. <param name="writer">The Open API writer.</param>
  5605. <param name="name">The property name.</param>
  5606. <param name="elements">The map values.</param>
  5607. <param name="action">The map element writer action with writer and value as input.</param>
  5608. </member>
  5609. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteOptionalMap``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0})">
  5610. <summary>
  5611. Write the optional Open API element map.
  5612. </summary>
  5613. <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  5614. <param name="writer">The Open API writer.</param>
  5615. <param name="name">The property name.</param>
  5616. <param name="elements">The map values.</param>
  5617. <param name="action">The map element writer action with writer, key, and value as input.</param>
  5618. </member>
  5619. <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteRequiredMap``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Collections.Generic.IDictionary{System.String,``0},System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
  5620. <summary>
  5621. Write the required Open API element map.
  5622. </summary>
  5623. <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
  5624. <param name="writer">The Open API writer.</param>
  5625. <param name="name">The property name.</param>
  5626. <param name="elements">The map values.</param>
  5627. <param name="action">The map element writer action.</param>
  5628. </member>
  5629. <member name="T:Microsoft.OpenApi.Writers.ReferenceInlineSetting">
  5630. <summary>
  5631. Indicates if and when the reader should convert references into complete object renderings
  5632. </summary>
  5633. </member>
  5634. <member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.DoNotInlineReferences">
  5635. <summary>
  5636. Create placeholder objects with an OpenApiReference instance and UnresolvedReference set to true.
  5637. </summary>
  5638. </member>
  5639. <member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.InlineLocalReferences">
  5640. <summary>
  5641. Convert local references to references of valid domain objects.
  5642. </summary>
  5643. </member>
  5644. <member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.InlineAllReferences">
  5645. <summary>
  5646. Convert all references to references of valid domain objects.
  5647. </summary>
  5648. </member>
  5649. <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterSettings">
  5650. <summary>
  5651. Configuration settings to control how OpenAPI documents are written
  5652. </summary>
  5653. </member>
  5654. <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterSettings.ReferenceInline">
  5655. <summary>
  5656. Indicates how references in the source document should be handled.
  5657. </summary>
  5658. </member>
  5659. <member name="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter">
  5660. <summary>
  5661. YAML writer.
  5662. </summary>
  5663. </member>
  5664. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.#ctor(System.IO.TextWriter)">
  5665. <summary>
  5666. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter"/> class.
  5667. </summary>
  5668. <param name="textWriter">The text writer.</param>
  5669. </member>
  5670. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
  5671. <summary>
  5672. Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter"/> class.
  5673. </summary>
  5674. <param name="textWriter">The text writer.</param>
  5675. <param name="settings"></param>
  5676. </member>
  5677. <member name="P:Microsoft.OpenApi.Writers.OpenApiYamlWriter.BaseIndentation">
  5678. <summary>
  5679. Base Indentation Level.
  5680. This denotes how many indentations are needed for the property in the base object.
  5681. </summary>
  5682. </member>
  5683. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteStartObject">
  5684. <summary>
  5685. Write YAML start object.
  5686. </summary>
  5687. </member>
  5688. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteEndObject">
  5689. <summary>
  5690. Write YAML end object.
  5691. </summary>
  5692. </member>
  5693. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteStartArray">
  5694. <summary>
  5695. Write YAML start array.
  5696. </summary>
  5697. </member>
  5698. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteEndArray">
  5699. <summary>
  5700. Write YAML end array.
  5701. </summary>
  5702. </member>
  5703. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WritePropertyName(System.String)">
  5704. <summary>
  5705. Write the property name and the delimiter.
  5706. </summary>
  5707. </member>
  5708. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteValue(System.String)">
  5709. <summary>
  5710. Write string value.
  5711. </summary>
  5712. <param name="value">The string value.</param>
  5713. </member>
  5714. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteNull">
  5715. <summary>
  5716. Write null value.
  5717. </summary>
  5718. </member>
  5719. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteValueSeparator">
  5720. <summary>
  5721. Write value separator.
  5722. </summary>
  5723. </member>
  5724. <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteRaw(System.String)">
  5725. <summary>
  5726. Writes the content raw value.
  5727. </summary>
  5728. </member>
  5729. <member name="T:Microsoft.OpenApi.Writers.ScopeType">
  5730. <summary>
  5731. Various scope types for Open API writer.
  5732. </summary>
  5733. </member>
  5734. <member name="F:Microsoft.OpenApi.Writers.ScopeType.Object">
  5735. <summary>
  5736. Object scope.
  5737. </summary>
  5738. </member>
  5739. <member name="F:Microsoft.OpenApi.Writers.ScopeType.Array">
  5740. <summary>
  5741. Array scope.
  5742. </summary>
  5743. </member>
  5744. <member name="T:Microsoft.OpenApi.Writers.Scope">
  5745. <summary>
  5746. Class representing scope information.
  5747. </summary>
  5748. </member>
  5749. <member name="F:Microsoft.OpenApi.Writers.Scope._type">
  5750. <summary>
  5751. The type of the scope.
  5752. </summary>
  5753. </member>
  5754. <member name="M:Microsoft.OpenApi.Writers.Scope.#ctor(Microsoft.OpenApi.Writers.ScopeType)">
  5755. <summary>
  5756. Constructor.
  5757. </summary>
  5758. <param name="type">The type of the scope.</param>
  5759. </member>
  5760. <member name="P:Microsoft.OpenApi.Writers.Scope.ObjectCount">
  5761. <summary>
  5762. Get/Set the object count for this scope.
  5763. </summary>
  5764. </member>
  5765. <member name="P:Microsoft.OpenApi.Writers.Scope.Type">
  5766. <summary>
  5767. Gets the scope type for this scope.
  5768. </summary>
  5769. </member>
  5770. <member name="P:Microsoft.OpenApi.Writers.Scope.IsInArray">
  5771. <summary>
  5772. Get/Set the whether it is in previous array scope.
  5773. </summary>
  5774. </member>
  5775. <member name="T:Microsoft.OpenApi.Writers.SpecialCharacterStringExtensions">
  5776. <summary>
  5777. Extensions class for strings to handle special characters.
  5778. </summary>
  5779. </member>
  5780. <member name="M:Microsoft.OpenApi.Writers.SpecialCharacterStringExtensions.GetYamlCompatibleString(System.String)">
  5781. <summary>
  5782. Escapes all special characters and put the string in quotes if necessary to
  5783. get a YAML-compatible string.
  5784. </summary>
  5785. </member>
  5786. <member name="M:Microsoft.OpenApi.Writers.SpecialCharacterStringExtensions.GetJsonCompatibleString(System.String)">
  5787. <summary>
  5788. Handles control characters and backslashes and adds double quotes
  5789. to get JSON-compatible string.
  5790. </summary>
  5791. </member>
  5792. <member name="T:Microsoft.OpenApi.Writers.WriterConstants">
  5793. <summary>
  5794. Constants for the writer.
  5795. </summary>
  5796. </member>
  5797. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeFormat">
  5798. <summary>
  5799. JSON datetime format.
  5800. </summary>
  5801. </member>
  5802. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeOffsetFormat">
  5803. <summary>
  5804. JSON datetime offset format.
  5805. </summary>
  5806. </member>
  5807. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeOffsetPlusSign">
  5808. <summary>
  5809. A plus sign for the date time offset format.
  5810. </summary>
  5811. </member>
  5812. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonTrueLiteral">
  5813. <summary>
  5814. The true value literal.
  5815. </summary>
  5816. </member>
  5817. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonFalseLiteral">
  5818. <summary>
  5819. The false value literal.
  5820. </summary>
  5821. </member>
  5822. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonNullLiteral">
  5823. <summary>
  5824. The null value literal.
  5825. </summary>
  5826. </member>
  5827. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartObjectScope">
  5828. <summary>
  5829. Character which starts the object scope.
  5830. </summary>
  5831. </member>
  5832. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndObjectScope">
  5833. <summary>
  5834. Character which ends the object scope.
  5835. </summary>
  5836. </member>
  5837. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartArrayScope">
  5838. <summary>
  5839. Character which starts the array scope.
  5840. </summary>
  5841. </member>
  5842. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndArrayScope">
  5843. <summary>
  5844. Character which ends the array scope.
  5845. </summary>
  5846. </member>
  5847. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartPaddingFunctionScope">
  5848. <summary>
  5849. "(" Json Padding Function scope open parens.
  5850. </summary>
  5851. </member>
  5852. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndPaddingFunctionScope">
  5853. <summary>
  5854. ")" Json Padding Function scope close parens.
  5855. </summary>
  5856. </member>
  5857. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ObjectMemberSeparator">
  5858. <summary>
  5859. The separator between object members.
  5860. </summary>
  5861. </member>
  5862. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ArrayElementSeparator">
  5863. <summary>
  5864. The separator between array elements.
  5865. </summary>
  5866. </member>
  5867. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.NameValueSeparator">
  5868. <summary>
  5869. The separator between the name and the value.
  5870. </summary>
  5871. </member>
  5872. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForEmptyObject">
  5873. <summary>
  5874. The white space for empty object
  5875. </summary>
  5876. </member>
  5877. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForEmptyArray">
  5878. <summary>
  5879. The white space for empty array
  5880. </summary>
  5881. </member>
  5882. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.PrefixOfArrayItem">
  5883. <summary>
  5884. The prefix of array item
  5885. </summary>
  5886. </member>
  5887. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForIndent">
  5888. <summary>
  5889. The white space for indent
  5890. </summary>
  5891. </member>
  5892. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EmptyObject">
  5893. <summary>
  5894. Empty object
  5895. </summary>
  5896. <remarks>To indicate empty object in YAML.</remarks>
  5897. </member>
  5898. <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EmptyArray">
  5899. <summary>
  5900. Empty array
  5901. </summary>
  5902. <remarks>To indicate empty array in YAML.</remarks>
  5903. </member>
  5904. </members>
  5905. </doc>