1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Microsoft.OpenApi</name>
- </assembly>
- <members>
- <member name="T:Microsoft.OpenApi.Any.AnyType">
- <summary>
- Type of an <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.AnyType.Primitive">
- <summary>
- Primitive.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.AnyType.Null">
- <summary>
- Null.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.AnyType.Array">
- <summary>
- Array.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.AnyType.Object">
- <summary>
- Object.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.IOpenApiAny">
- <summary>
- Base interface for all the types that represent Open API Any.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.IOpenApiAny.AnyType">
- <summary>
- Type of an <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.PrimitiveType">
- <summary>
- Primitive type.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Integer">
- <summary>
- Integer
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Long">
- <summary>
- Long
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Float">
- <summary>
- Float
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Double">
- <summary>
- Double
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.String">
- <summary>
- String
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Byte">
- <summary>
- Byte
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Binary">
- <summary>
- Binary
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Boolean">
- <summary>
- Boolean
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Date">
- <summary>
- Date
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.DateTime">
- <summary>
- DateTime
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Any.PrimitiveType.Password">
- <summary>
- Password
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.IOpenApiPrimitive">
- <summary>
- Base interface for the Primitive type.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.IOpenApiPrimitive.PrimitiveType">
- <summary>
- Primitive type.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiArray">
- <summary>
- Open API array.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiArray.AnyType">
- <summary>
- The type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiArray.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Write out contents of OpenApiArray to passed writer
- </summary>
- <param name="writer">Instance of JSON or YAML writer.</param>
- <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiBinary">
- <summary>
- Open API binary.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiBinary.#ctor(System.Byte[])">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiBinary"/> class.
- </summary>
- <param name="value"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiBinary.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiBoolean">
- <summary>
- Open API boolean.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiBoolean.#ctor(System.Boolean)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiBoolean"/> class.
- </summary>
- <param name="value"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiBoolean.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiByte">
- <summary>
- Open API Byte
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiByte.#ctor(System.Byte)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiByte"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiByte.#ctor(System.Byte[])">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiByte"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiByte.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiDate">
- <summary>
- Open API Date
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiDate.#ctor(System.DateTime)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDate"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiDate.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiDateTime">
- <summary>
- Open API Datetime
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiDateTime.#ctor(System.DateTimeOffset)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDateTime"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiDateTime.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiDouble">
- <summary>
- Open API Double
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiDouble.#ctor(System.Double)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiDouble"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiDouble.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiFloat">
- <summary>
- Open API Float
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiFloat.#ctor(System.Single)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiFloat"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiFloat.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiInteger">
- <summary>
- Open API Integer
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiInteger.#ctor(System.Int32)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiInteger"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiInteger.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiLong">
- <summary>
- Open API long.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiLong.#ctor(System.Int64)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiLong"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiLong.PrimitiveType">
- <summary>
- Primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiNull">
- <summary>
- Open API null.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiNull.AnyType">
- <summary>
- The type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiNull.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Write out null representation
- </summary>
- <param name="writer"></param>
- <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiObject">
- <summary>
- Open API object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiObject.AnyType">
- <summary>
- Type of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiObject.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Serialize OpenApiObject to writer
- </summary>
- <param name="writer"></param>
- <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiPassword">
- <summary>
- Open API password.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiPassword.#ctor(System.String)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiPassword"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiPassword.PrimitiveType">
- <summary>
- The primitive type this object represents.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiPrimitive`1">
- <summary>
- Open API primitive class.
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiPrimitive`1.#ctor(`0)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.IOpenApiPrimitive"/> class with the given value.
- </summary>
- <param name="value"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.AnyType">
- <summary>
- The kind of <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.PrimitiveType">
- <summary>
- The primitive class this object represents.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiPrimitive`1.Value">
- <summary>
- Value of this <see cref="T:Microsoft.OpenApi.Any.IOpenApiPrimitive"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiPrimitive`1.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Write out content of primitive element
- </summary>
- <param name="writer"></param>
- <param name="specVersion"></param>
- </member>
- <member name="T:Microsoft.OpenApi.Any.OpenApiString">
- <summary>
- Open API string type.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiString.#ctor(System.String)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiString"/> class.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiString.#ctor(System.String,System.Boolean)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Any.OpenApiString"/> class.
- </summary>
- <param name="value"></param>
- <param name="isExplicit">Used to indicate if a string is quoted.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Any.OpenApiString.PrimitiveType">
- <summary>
- The primitive class this object represents.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Any.OpenApiString.IsExplicit">
- <summary>
- True if string was specified explicitly by the means of double quotes, single quotes, or literal or folded style.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Attributes.DisplayAttribute">
- <summary>
- Represents the Open Api Data type metadata attribute.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Attributes.DisplayAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Attributes.DisplayAttribute"/> class.
- </summary>
- <param name="name">The display name.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Attributes.DisplayAttribute.Name">
- <summary>
- The display Name.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Error">
- <summary>
- Utility class for creating and unwrapping <see cref="T:System.Exception"/> instances.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Error.Format(System.String,System.Object[])">
- <summary>
- Formats the specified resource string using <see cref="M:CultureInfo.CurrentCulture"/>.
- </summary>
- <param name="format">A composite format string.</param>
- <param name="args">An object array that contains zero or more objects to format.</param>
- <returns>The formatted string.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Error.Argument(System.String,System.Object[])">
- <summary>
- Creates an <see cref="T:System.ArgumentException"/> with the provided properties.
- </summary>
- <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
- <param name="messageArgs">An object array that contains zero or more objects to format.</param>
- <returns>The logged <see cref="T:System.Exception"/>.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Error.Argument(System.String,System.String,System.Object[])">
- <summary>
- Creates an <see cref="T:System.ArgumentException"/> with the provided properties.
- </summary>
- <param name="parameterName">The name of the parameter that caused the current exception.</param>
- <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
- <param name="messageArgs">An object array that contains zero or more objects to format.</param>
- <returns>The logged <see cref="T:System.Exception"/>.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Error.ArgumentNull(System.String)">
- <summary>
- Creates an <see cref="T:System.ArgumentNullException"/> with the provided properties.
- </summary>
- <param name="parameterName">The name of the parameter that caused the current exception.</param>
- <returns>The logged <see cref="T:System.Exception"/>.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Error.ArgumentNull(System.String,System.String,System.Object[])">
- <summary>
- Creates an <see cref="T:System.ArgumentNullException"/> with the provided properties.
- </summary>
- <param name="parameterName">The name of the parameter that caused the current exception.</param>
- <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
- <param name="messageArgs">An object array that contains zero or more objects to format.</param>
- <returns>The logged <see cref="T:System.Exception"/>.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Error.ArgumentNullOrWhiteSpace(System.String)">
- <summary>
- Creates an <see cref="T:System.ArgumentException"/> with a default message.
- </summary>
- <param name="parameterName">The name of the parameter that caused the current exception.</param>
- <returns>The logged <see cref="T:System.Exception"/>.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Error.NotSupported(System.String,System.Object[])">
- <summary>
- Creates an <see cref="T:System.NotSupportedException"/>.
- </summary>
- <param name="messageFormat">A composite format string explaining the reason for the exception.</param>
- <param name="messageArgs">An object array that contains zero or more objects to format.</param>
- <returns>The logged <see cref="T:System.Exception"/>.</returns>
- </member>
- <member name="T:Microsoft.OpenApi.Exceptions.OpenApiException">
- <summary>
- Exception type representing exceptions in the Open API library.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor">
- <summary>
- Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiException"/> class with default values.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor(System.String)">
- <summary>
- Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiException"/> class with an error message.
- </summary>
- <param name="message">The plain text error message for this exception.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Exceptions.OpenApiException.#ctor(System.String,System.Exception)">
- <summary>
- Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiException"/> class with an error message and an inner exception.
- </summary>
- <param name="message">The plain text error message for this exception.</param>
- <param name="innerException">The inner exception that is the cause of this exception to be thrown.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Exceptions.OpenApiException.Pointer">
- <summary>
- The reference pointer.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException">
- <summary>
- Exception type representing exceptions in the OpenAPI writer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor">
- <summary>
- Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException"/> class with default values.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor(System.String)">
- <summary>
- Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException"/> class with an error message.
- </summary>
- <param name="message">The plain text error message for this exception.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Exceptions.OpenApiWriterException.#ctor(System.String,System.Exception)">
- <summary>
- Creates a new instance of the <see cref="T:Microsoft.OpenApi.Exceptions.OpenApiWriterException"/> class with an error message and an inner exception.
- </summary>
- <param name="message">The plain text error message for this exception.</param>
- <param name="innerException">The inner exception that is the cause of this exception to be thrown.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.BodyExpression">
- <summary>
- Body expression.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.BodyExpression.Body">
- <summary>
- body string
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.BodyExpression.PointerPrefix">
- <summary>
- Prefix for a pointer
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.BodyExpression.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.BodyExpression"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.BodyExpression.#ctor(Microsoft.OpenApi.JsonPointer)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.BodyExpression"/> class.
- </summary>
- <param name="pointer">a JSON Pointer [RFC 6901](https://tools.ietf.org/html/rfc6901).</param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.BodyExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.BodyExpression.Fragment">
- <summary>
- Gets the fragment string.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.CompositeExpression">
- <summary>
- String literal with embedded expressions
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.CompositeExpression.ContainedExpressions">
- <summary>
- Expressions embedded into string literal
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.CompositeExpression.#ctor(System.String)">
- <summary>
- Create a composite expression from a string literal with an embedded expression
- </summary>
- <param name="expression"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.CompositeExpression.Expression">
- <summary>
- Return original string literal with embedded expression
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.HeaderExpression">
- <summary>
- Header expression, The token identifier in header is case-insensitive.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.HeaderExpression.Header">
- <summary>
- header. string
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.HeaderExpression.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.HeaderExpression"/> class.
- </summary>
- <param name="token">The token string, it's case-insensitive.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.HeaderExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.HeaderExpression.Token">
- <summary>
- Gets the token string.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.MethodExpression">
- <summary>
- Method expression.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.MethodExpression.Method">
- <summary>
- $method. string
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.MethodExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.MethodExpression.#ctor">
- <summary>
- Private constructor.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.PathExpression">
- <summary>
- Path expression, the name in path is case-sensitive.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.PathExpression.Path">
- <summary>
- path. string
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.PathExpression.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.PathExpression"/> class.
- </summary>
- <param name="name">The name string, it's case-insensitive.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.PathExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.PathExpression.Name">
- <summary>
- Gets the name string.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.QueryExpression">
- <summary>
- Query expression, the name in query is case-sensitive.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.QueryExpression.Query">
- <summary>
- query. string
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.QueryExpression.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.QueryExpression"/> class.
- </summary>
- <param name="name">The name string, it's case-insensitive.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.QueryExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.QueryExpression.Name">
- <summary>
- Gets the name string.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.RequestExpression">
- <summary>
- $request. expression.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.RequestExpression.Request">
- <summary>
- $request. string
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.RequestExpression.#ctor(Microsoft.OpenApi.Expressions.SourceExpression)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.RequestExpression"/> class.
- </summary>
- <param name="source">The source of the request.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.RequestExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.RequestExpression.Source">
- <summary>
- The <see cref="T:Microsoft.OpenApi.Expressions.SourceExpression"/> expression.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.ResponseExpression">
- <summary>
- $response. expression.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.ResponseExpression.Response">
- <summary>
- $response. string
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.ResponseExpression.#ctor(Microsoft.OpenApi.Expressions.SourceExpression)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.ResponseExpression"/> class.
- </summary>
- <param name="source">The source of the response.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.ResponseExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.ResponseExpression.Source">
- <summary>
- The <see cref="T:Microsoft.OpenApi.Expressions.SourceExpression"/> expression.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.RuntimeExpression">
- <summary>
- Base class for the Open API runtime expression.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.RuntimeExpression.Prefix">
- <summary>
- The dollar sign prefix for a runtime expression.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.RuntimeExpression.Expression">
- <summary>
- The expression string.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Build(System.String)">
- <summary>
- Build the runtime expression from input string.
- </summary>
- <param name="expression">The runtime expression.</param>
- <returns>The built runtime expression object.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.GetHashCode">
- <summary>
- GetHashCode implementation for IEquatable.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Equals(System.Object)">
- <summary>
- Equals implementation for IEquatable.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.Equals(Microsoft.OpenApi.Expressions.RuntimeExpression)">
- <summary>
- Equals implementation for object of the same type.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.RuntimeExpression.ToString">
- <inheritdoc />
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.SourceExpression">
- <summary>
- Source expression.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.SourceExpression.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Expressions.QueryExpression"/> class.
- </summary>
- <param name="value">The value string.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.SourceExpression.Value">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.SourceExpression.Build(System.String)">
- <summary>
- Build the source expression from input string.
- </summary>
- <param name="expression">The source expression.</param>
- <returns>The built source expression.</returns>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.StatusCodeExpression">
- <summary>
- StatusCode expression.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.StatusCodeExpression.StatusCode">
- <summary>
- $statusCode string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.StatusCodeExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.StatusCodeExpression.#ctor">
- <summary>
- Private constructor.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Expressions.UrlExpression">
- <summary>
- Url expression.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Expressions.UrlExpression.Url">
- <summary>
- $url string.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Expressions.UrlExpression.Expression">
- <summary>
- Gets the expression string.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Expressions.UrlExpression.#ctor">
- <summary>
- Private constructor.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Extensions.EnumExtensions">
- <summary>
- Enumeration type extension methods.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.EnumExtensions.GetAttributeOfType``1(System.Enum)">
- <summary>
- Gets an attribute on an enum field value.
- </summary>
- <typeparam name="T">The type of the attribute to retrieve.</typeparam>
- <param name="enumValue">The enum value.</param>
- <returns>
- The attribute of the specified type or null.
- </returns>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.EnumExtensions.GetDisplayName(System.Enum)">
- <summary>
- Gets the enum display name.
- </summary>
- <param name="enumValue">The enum value.</param>
- <returns>
- Use <see cref="T:Microsoft.OpenApi.Attributes.DisplayAttribute"/> if exists.
- Otherwise, use the standard string representation.
- </returns>
- </member>
- <member name="T:Microsoft.OpenApi.Extensions.OpenApiElementExtensions">
- <summary>
- Extension methods that apply across all OpenAPIElements
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiElementExtensions.Validate(Microsoft.OpenApi.Interfaces.IOpenApiElement,Microsoft.OpenApi.Validations.ValidationRuleSet)">
- <summary>
- Validate element and all child elements
- </summary>
- <param name="element">Element to validate</param>
- <param name="ruleSet">Optional set of rules to use for validation</param>
- <returns>An IEnumerable of errors. This function will never return null.</returns>
- </member>
- <member name="T:Microsoft.OpenApi.Extensions.OpenApiExtensibleExtensions">
- <summary>
- Extension methods to verify validatity and add an extension to Extensions property.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiExtensibleExtensions.AddExtension``1(``0,System.String,Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
- <summary>
- Add extension into the Extensions
- </summary>
- <typeparam name="T"><see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>.</typeparam>
- <param name="element">The extensible Open API element. </param>
- <param name="name">The extension name.</param>
- <param name="any">The extension value.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions">
- <summary>
- Extension methods for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> serialization.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsJson``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Serialize the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document (JSON) using the given stream and specification version.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="stream">The output stream.</param>
- <param name="specVersion">The Open API specification version.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsYaml``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document (YAML) using the given stream and specification version.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="stream">The output stream.</param>
- <param name="specVersion">The Open API specification version.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat)">
- <summary>
- Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document using
- the given stream, specification version and the format.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="stream">The given stream.</param>
- <param name="specVersion">The Open API specification version.</param>
- <param name="format">The output format (JSON or YAML).</param>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,System.IO.Stream,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
- <summary>
- Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document using
- the given stream, specification version and the format.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="stream">The given stream.</param>
- <param name="specVersion">The Open API specification version.</param>
- <param name="format">The output format (JSON or YAML).</param>
- <param name="settings">Provide configuration settings for controlling writing output</param>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to Open API document using the given specification version and writer.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="writer">The output writer.</param>
- <param name="specVersion">Version of the specification the output should conform to</param>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsJson``1(``0,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in JSON format.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="specVersion">The Open API specification version.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.SerializeAsYaml``1(``0,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in YAML format.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="specVersion">The Open API specification version.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.OpenApiSerializableExtensions.Serialize``1(``0,Microsoft.OpenApi.OpenApiSpecVersion,Microsoft.OpenApi.OpenApiFormat)">
- <summary>
- Serializes the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/> to the Open API document as a string in the given format.
- </summary>
- <typeparam name="T">the <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable"/></typeparam>
- <param name="element">The Open API element.</param>
- <param name="specVersion">The Open API specification version.</param>
- <param name="format">Open API document format.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Extensions.StringExtensions">
- <summary>
- String extension methods.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Extensions.StringExtensions.GetEnumFromDisplayName``1(System.String)">
- <summary>
- Gets the enum value based on the given enum type and display name.
- </summary>
- <param name="displayName">The display name.</param>
- </member>
- <member name="M:Microsoft.OpenApi.OpenAPIWriterExtensions.GetSettings(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Temporary extension method until we add Settings property to IOpenApiWriter in next major version
- </summary>
- <param name="openApiWriter"></param>
- <returns></returns>
- </member>
- <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiElement">
- <summary>
- Represents an Open API element.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible">
- <summary>
- Represents an Extensible Open API element.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Interfaces.IOpenApiExtensible.Extensions">
- <summary>
- Specification extensions.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension">
- <summary>
- Interface requuired for implementing any custom extension
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiExtension.Write(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.OpenApiSpecVersion)">
- <summary>
- Write out contents of custom extension
- </summary>
- <param name="writer"></param>
- <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable">
- <summary>
- Represents an Open API element is referenceable.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.Reference">
- <summary>
- Reference object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Interfaces.IOpenApiSerializable">
- <summary>
- Represents an Open API element that comes with serialzation functionality.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiSerializable.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize Open API element to v3.0.
- </summary>
- <param name="writer">The writer.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Interfaces.IOpenApiSerializable.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize Open API element to v2.0.
- </summary>
- <param name="writer">The writer.</param>
- </member>
- <member name="T:Microsoft.OpenApi.JsonPointer">
- <summary>
- JSON pointer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.JsonPointer.#ctor(System.String)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.JsonPointer"/> class.
- </summary>
- <param name="pointer">Pointer as string.</param>
- </member>
- <member name="M:Microsoft.OpenApi.JsonPointer.#ctor(System.String[])">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.JsonPointer"/> class.
- </summary>
- <param name="tokens">Pointer as tokenized string.</param>
- </member>
- <member name="P:Microsoft.OpenApi.JsonPointer.Tokens">
- <summary>
- Tokens.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.JsonPointer.ParentPointer">
- <summary>
- Gets the parent pointer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.JsonPointer.Decode(System.String)">
- <summary>
- Decode the string.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.JsonPointer.ToString">
- <summary>
- Gets the string representation of this JSON pointer.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiCallback">
- <summary>
- Callback Object: A map of possible out-of band callbacks related to the parent operation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.PathItems">
- <summary>
- A Path Item Object used to define a callback request and expected responses.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.Reference">
- <summary>
- Reference pointer.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiCallback.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.AddPathItem(Microsoft.OpenApi.Expressions.RuntimeExpression,Microsoft.OpenApi.Models.OpenApiPathItem)">
- <summary>
- Add a <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> into the <see cref="P:Microsoft.OpenApi.Models.OpenApiCallback.PathItems"/>.
- </summary>
- <param name="expression">The runtime expression.</param>
- <param name="pathItem">The path item.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiCallback.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiComponents">
- <summary>
- Components Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Schemas">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Responses">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Parameters">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Examples">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.RequestBodies">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Headers">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.SecuritySchemes">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Links">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Callbacks">
- <summary>
- An object to hold reusable <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiComponents.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiComponents.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiComponents.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> to Open Api v2.0.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiConstants">
- <summary>
- Constants used in the Open API document.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OpenApi">
- <summary>
- Field: OpenApi
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Info">
- <summary>
- Field: Info
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Title">
- <summary>
- Field: Title
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Type">
- <summary>
- Field: Type
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Format">
- <summary>
- Field: Format
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Version">
- <summary>
- Field: Version
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Contact">
- <summary>
- Field: Contact
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.License">
- <summary>
- Field: License
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.TermsOfService">
- <summary>
- Field: TermsOfService
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Servers">
- <summary>
- Field: Servers
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Server">
- <summary>
- Field: Server
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Paths">
- <summary>
- Field: Paths
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Components">
- <summary>
- Field: Components
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Security">
- <summary>
- Field: Security
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Tags">
- <summary>
- Field: Tags
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExternalDocs">
- <summary>
- Field: ExternalDocs
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OperationRef">
- <summary>
- Field: OperationRef
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OperationId">
- <summary>
- Field: OperationId
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Parameters">
- <summary>
- Field: Parameters
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RequestBody">
- <summary>
- Field: RequestBody
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExtensionFieldNamePrefix">
- <summary>
- Field: ExtensionFieldNamePrefix
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Name">
- <summary>
- Field: Name
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Namespace">
- <summary>
- Field: Namespace
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Prefix">
- <summary>
- Field: Prefix
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Attribute">
- <summary>
- Field: Attribute
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Wrapped">
- <summary>
- Field: Wrapped
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.In">
- <summary>
- Field: In
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Summary">
- <summary>
- Field: Summary
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Variables">
- <summary>
- Field: Variables
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Description">
- <summary>
- Field: Description
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Required">
- <summary>
- Field: Required
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Deprecated">
- <summary>
- Field: Deprecated
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Style">
- <summary>
- Field: Style
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Explode">
- <summary>
- Field: Explode
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllowReserved">
- <summary>
- Field: AllowReserved
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schema">
- <summary>
- Field: Schema
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schemas">
- <summary>
- Field: Schemas
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Responses">
- <summary>
- Field: Responses
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Example">
- <summary>
- Field: Example
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Examples">
- <summary>
- Field: Examples
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Encoding">
- <summary>
- Field: Encoding
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RequestBodies">
- <summary>
- Field: RequestBodies
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllowEmptyValue">
- <summary>
- Field: AllowEmptyValue
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Value">
- <summary>
- Field: Value
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExternalValue">
- <summary>
- Field: ExternalValue
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DollarRef">
- <summary>
- Field: DollarRef
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Headers">
- <summary>
- Field: Headers
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.SecuritySchemes">
- <summary>
- Field: SecuritySchemes
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Content">
- <summary>
- Field: Content
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Links">
- <summary>
- Field: Links
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Callbacks">
- <summary>
- Field: Callbacks
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Url">
- <summary>
- Field: Url
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Email">
- <summary>
- Field: Email
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Default">
- <summary>
- Field: Default
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Enum">
- <summary>
- Field: Enum
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MultipleOf">
- <summary>
- Field: MultipleOf
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Maximum">
- <summary>
- Field: Maximum
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExclusiveMaximum">
- <summary>
- Field: ExclusiveMaximum
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Minimum">
- <summary>
- Field: Minimum
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ExclusiveMinimum">
- <summary>
- Field: ExclusiveMinimum
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxLength">
- <summary>
- Field: MaxLength
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinLength">
- <summary>
- Field: MinLength
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Pattern">
- <summary>
- Field: Pattern
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxItems">
- <summary>
- Field: MaxItems
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinItems">
- <summary>
- Field: MinItems
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.UniqueItems">
- <summary>
- Field: UniqueItems
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MaxProperties">
- <summary>
- Field: MaxProperties
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.MinProperties">
- <summary>
- Field: MinProperties
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AllOf">
- <summary>
- Field: AllOf
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OneOf">
- <summary>
- Field: OneOf
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AnyOf">
- <summary>
- Field: AnyOf
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Not">
- <summary>
- Field: Not
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Items">
- <summary>
- Field: Items
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Properties">
- <summary>
- Field: Properties
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AdditionalProperties">
- <summary>
- Field: AdditionalProperties
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Nullable">
- <summary>
- Field: Nullable
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Discriminator">
- <summary>
- Field: Discriminator
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ReadOnly">
- <summary>
- Field: ReadOnly
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.WriteOnly">
- <summary>
- Field: WriteOnly
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Xml">
- <summary>
- Field: Xml
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Flow">
- <summary>
- Field: Flow
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Application">
- <summary>
- Field: Application
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AccessCode">
- <summary>
- Field: AccessCode
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Implicit">
- <summary>
- Field: Implicit
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Password">
- <summary>
- Field: Password
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ClientCredentials">
- <summary>
- Field: ClientCredentials
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AuthorizationCode">
- <summary>
- Field: AuthorizationCode
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.AuthorizationUrl">
- <summary>
- Field: AuthorizationUrl
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.TokenUrl">
- <summary>
- Field: TokenUrl
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.RefreshUrl">
- <summary>
- Field: RefreshUrl
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Scopes">
- <summary>
- Field: Scopes
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.ContentType">
- <summary>
- Field: ContentType
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Get">
- <summary>
- Field: Get
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Put">
- <summary>
- Field: Put
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Post">
- <summary>
- Field: Post
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Delete">
- <summary>
- Field: Delete
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Options">
- <summary>
- Field: Options
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Head">
- <summary>
- Field: Head
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Patch">
- <summary>
- Field: Patch
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Trace">
- <summary>
- Field: Trace
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.PropertyName">
- <summary>
- Field: PropertyName
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Mapping">
- <summary>
- Field: Mapping
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Scheme">
- <summary>
- Field: Scheme
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BearerFormat">
- <summary>
- Field: BearerFormat
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Flows">
- <summary>
- Field: Flows
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.OpenIdConnectUrl">
- <summary>
- Field: OpenIdConnectUrl
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultName">
- <summary>
- Field: DefaultName
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultDefault">
- <summary>
- Field: DefaultDefault
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultTitle">
- <summary>
- Field: DefaultTitle
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.DefaultDescription">
- <summary>
- Field: DefaultDescription
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BodyName">
- <summary>
- Field: BodyName extensions
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.version3_0_0">
- <summary>
- Field: version3_0_0
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.defaultUrl">
- <summary>
- Field: defaultUrl
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Host">
- <summary>
- Field: Host
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Swagger">
- <summary>
- Field: Swagger
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.version2_0">
- <summary>
- Field: version2_0
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.BasePath">
- <summary>
- Field: BasePath
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Schemes">
- <summary>
- Field: Schemes
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.SecurityDefinitions">
- <summary>
- Field: SecurityDefinitions
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Definitions">
- <summary>
- Field: Definitions
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Basic">
- <summary>
- Field: Basic
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Consumes">
- <summary>
- Field: Consumes
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiConstants.Produces">
- <summary>
- Field: Produces
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiContact">
- <summary>
- Contact Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Name">
- <summary>
- The identifying name of the contact person/organization.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Url">
- <summary>
- The URL pointing to the contact information. MUST be in the format of a URL.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Email">
- <summary>
- The email address of the contact person/organization.
- MUST be in the format of an email address.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiContact.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiContact.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiContact.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiDiscriminator">
- <summary>
- Discriminator object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDiscriminator.PropertyName">
- <summary>
- REQUIRED. The name of the property in the payload that will hold the discriminator value.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDiscriminator.Mapping">
- <summary>
- An object to hold mappings between payload values and schema names or references.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDiscriminator"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiDiscriminator.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDiscriminator"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiDocument">
- <summary>
- Describes an OpenAPI object (OpenAPI document). See: https://swagger.io/specification
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Info">
- <summary>
- REQUIRED. Provides metadata about the API. The metadata MAY be used by tooling as required.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Servers">
- <summary>
- An array of Server Objects, which provide connectivity information to a target server.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Paths">
- <summary>
- REQUIRED. The available paths and operations for the API.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Components">
- <summary>
- An element to hold various schemas for the specification.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.SecurityRequirements">
- <summary>
- A declaration of which security mechanisms can be used across the API.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Tags">
- <summary>
- A list of tags used by the specification with additional metadata.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.ExternalDocs">
- <summary>
- Additional external documentation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiDocument.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiDocument.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> to the latest patch of OpenAPI object V3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiDocument.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> to OpenAPI object V2.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiDocument.ResolveReference(Microsoft.OpenApi.Models.OpenApiReference)">
- <summary>
- Load the referenced <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiReferenceable"/> object from a <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> object
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiEncoding">
- <summary>
- ExternalDocs object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.ContentType">
- <summary>
- The Content-Type for encoding a specific property.
- The value can be a specific media type (e.g. application/json),
- a wildcard media type (e.g. image/*), or a comma-separated list of the two types.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Headers">
- <summary>
- A map allowing additional information to be provided as headers.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Style">
- <summary>
- Describes how a specific property value will be serialized depending on its type.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Explode">
- <summary>
- When this is true, property values of type array or object generate separate parameters
- for each value of the array, or key-value-pair of the map. For other types of properties
- this property has no effect. When style is form, the default value is true.
- For all other styles, the default value is false.
- This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.AllowReserved">
- <summary>
- Determines whether the parameter value SHOULD allow reserved characters,
- as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding.
- The default value is false. This property SHALL be ignored
- if the request body media type is not application/x-www-form-urlencoded.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiEncoding.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiEncoding.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v2.0.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiError">
- <summary>
- Error related to the Open API Document.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiError.#ctor(Microsoft.OpenApi.Exceptions.OpenApiException)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class using the message and pointer from the given exception.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiError.#ctor(System.String,System.String)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiError.Message">
- <summary>
- Message explaining the error.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiError.Pointer">
- <summary>
- Pointer to the location of the error.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiError.ToString">
- <summary>
- Gets the string representation of <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/>.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiExample">
- <summary>
- Example Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Summary">
- <summary>
- Short description for the example.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Description">
- <summary>
- Long description for the example.
- CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Value">
- <summary>
- Embedded literal example. The value field and externalValue field are mutually
- exclusive. To represent examples of media types that cannot naturally represented
- in JSON or YAML, use a string value to contain the example, escaping where necessary.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExample.ExternalValue">
- <summary>
- A URL that points to the literal example.
- This provides the capability to reference examples that cannot easily be
- included in JSON or YAML documents.
- The value field and externalValue field are mutually exclusive.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExample.Reference">
- <summary>
- Reference object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExample.UnresolvedReference">
- <summary>
- Indicates object is a placeholder reference to an actual object and does not contain valid data.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExample.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1">
- <summary>
- Generic dictionary type for Open API dictionary element.
- </summary>
- <typeparam name="T">The Open API element, <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExtensibleDictionary`1.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiExternalDocs">
- <summary>
- ExternalDocs object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExternalDocs.Description">
- <summary>
- A short description of the target documentation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExternalDocs.Url">
- <summary>
- REQUIRED. The URL for the target documentation. Value MUST be in the format of a URL.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiExternalDocs.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiExternalDocs.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v2.0.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiHeader">
- <summary>
- Header Object.
- The Header Object follows the structure of the Parameter Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Reference">
- <summary>
- Reference pointer.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Description">
- <summary>
- A brief description of the header.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Required">
- <summary>
- Determines whether this header is mandatory.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Deprecated">
- <summary>
- Specifies that a header is deprecated and SHOULD be transitioned out of usage.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.AllowEmptyValue">
- <summary>
- Sets the ability to pass empty-valued headers.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Style">
- <summary>
- Describes how the header value will be serialized depending on the type of the header value.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Explode">
- <summary>
- When this is true, header values of type array or object generate separate parameters
- for each value of the array or key-value pair of the map.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.AllowReserved">
- <summary>
- Determines whether the header value SHOULD allow reserved characters, as defined by RFC3986.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Schema">
- <summary>
- The schema defining the type used for the header.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Example">
- <summary>
- Example of the media type.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Examples">
- <summary>
- Examples of the media type.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Content">
- <summary>
- A map containing the representations for the header.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiHeader.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiHeader.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiInfo">
- <summary>
- Open API Info Object, it provides the metadata about the Open API.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Title">
- <summary>
- REQUIRED. The title of the application.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Description">
- <summary>
- A short description of the application.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Version">
- <summary>
- REQUIRED. The version of the OpenAPI document.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.TermsOfService">
- <summary>
- A URL to the Terms of Service for the API. MUST be in the format of a URL.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Contact">
- <summary>
- The contact information for the exposed API.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.License">
- <summary>
- The license information for the exposed API.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiInfo.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiInfo.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiInfo.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiLicense">
- <summary>
- License Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLicense.Name">
- <summary>
- REQUIRED. The license name used for the API.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLicense.Url">
- <summary>
- The URL pointing to the contact information. MUST be in the format of a URL.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLicense.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiLicense.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiLicense.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiLink">
- <summary>
- Link Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.OperationRef">
- <summary>
- A relative or absolute reference to an OAS operation.
- This field is mutually exclusive of the operationId field, and MUST point to an Operation Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.OperationId">
- <summary>
- The name of an existing, resolvable OAS operation, as defined with a unique operationId.
- This field is mutually exclusive of the operationRef field.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Parameters">
- <summary>
- A map representing parameters to pass to an operation as specified with operationId or identified via operationRef.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.RequestBody">
- <summary>
- A literal value or {expression} to use as a request body when calling the target operation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Description">
- <summary>
- A description of the link.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Server">
- <summary>
- A server object to be used by the target operation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiLink.Reference">
- <summary>
- Reference pointer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiLink.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiMediaType">
- <summary>
- Media Type Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Schema">
- <summary>
- The schema defining the type used for the request body.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Example">
- <summary>
- Example of the media type.
- The example object SHOULD be in the correct format as specified by the media type.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Examples">
- <summary>
- Examples of the media type.
- Each example object SHOULD match the media type and specified schema if present.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Encoding">
- <summary>
- A map between a property name and its encoding information.
- The key, being the property name, MUST exist in the schema as a property.
- The encoding object SHALL only apply to requestBody objects
- when the media type is multipart or application/x-www-form-urlencoded.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiMediaType.Extensions">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiMediaType.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> to Open Api v2.0.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow">
- <summary>
- OAuth Flow Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.AuthorizationUrl">
- <summary>
- REQUIRED. The authorization URL to be used for this flow.
- Applies to implicit and authorizationCode OAuthFlow.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.TokenUrl">
- <summary>
- REQUIRED. The token URL to be used for this flow.
- Applies to password, clientCredentials, and authorizationCode OAuthFlow.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.RefreshUrl">
- <summary>
- The URL to be used for obtaining refresh tokens.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.Scopes">
- <summary>
- REQUIRED. A map between the scope name and a short description for it.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlow.Extensions">
- <summary>
- Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlow.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows">
- <summary>
- OAuth Flows Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Implicit">
- <summary>
- Configuration for the OAuth Implicit flow
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Password">
- <summary>
- Configuration for the OAuth Resource Owner Password flow.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.ClientCredentials">
- <summary>
- Configuration for the OAuth Client Credentials flow.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.AuthorizationCode">
- <summary>
- Configuration for the OAuth Authorization Code flow.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOAuthFlows.Extensions">
- <summary>
- Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiOAuthFlows.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiOperation">
- <summary>
- Operation Object.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OpenApiOperation.DeprecatedDefault">
- <summary>
- Default value for <see cref="P:Microsoft.OpenApi.Models.OpenApiOperation.Deprecated"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Tags">
- <summary>
- A list of tags for API documentation control.
- Tags can be used for logical grouping of operations by resources or any other qualifier.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Summary">
- <summary>
- A short summary of what the operation does.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Description">
- <summary>
- A verbose explanation of the operation behavior.
- CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.ExternalDocs">
- <summary>
- Additional external documentation for this operation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.OperationId">
- <summary>
- Unique string used to identify the operation. The id MUST be unique among all operations described in the API.
- Tools and libraries MAY use the operationId to uniquely identify an operation, therefore,
- it is RECOMMENDED to follow common programming naming conventions.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Parameters">
- <summary>
- A list of parameters that are applicable for this operation.
- If a parameter is already defined at the Path Item, the new definition will override it but can never remove it.
- The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location.
- The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.RequestBody">
- <summary>
- The request body applicable for this operation.
- The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231
- has explicitly defined semantics for request bodies.
- In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Responses">
- <summary>
- REQUIRED. The list of possible responses as they are returned from executing this operation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Callbacks">
- <summary>
- A map of possible out-of band callbacks related to the parent operation.
- The key is a unique identifier for the Callback Object.
- Each value in the map is a Callback Object that describes a request
- that may be initiated by the API provider and the expected responses.
- The key value used to identify the callback object is an expression, evaluated at runtime,
- that identifies a URL to use for the callback operation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Deprecated">
- <summary>
- Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Security">
- <summary>
- A declaration of which security mechanisms can be used for this operation.
- The list of values includes alternative security requirement objects that can be used.
- Only one of the security requirement objects need to be satisfied to authorize a request.
- This definition overrides any declared top-level security.
- To remove a top-level security declaration, an empty array can be used.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Servers">
- <summary>
- An alternative server array to service this operation.
- If an alternative server object is specified at the Path Item Object or Root level,
- it will be overridden by this value.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiOperation.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiOperation.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiOperation.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> to Open Api v2.0.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiParameter">
- <summary>
- Parameter Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Reference">
- <summary>
- Reference object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Name">
- <summary>
- REQUIRED. The name of the parameter. Parameter names are case sensitive.
- If in is "path", the name field MUST correspond to the associated path segment from the path field in the Paths Object.
- If in is "header" and the name field is "Accept", "Content-Type" or "Authorization", the parameter definition SHALL be ignored.
- For all other cases, the name corresponds to the parameter name used by the in property.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.In">
- <summary>
- REQUIRED. The location of the parameter.
- Possible values are "query", "header", "path" or "cookie".
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Description">
- <summary>
- A brief description of the parameter. This could contain examples of use.
- CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Required">
- <summary>
- Determines whether this parameter is mandatory.
- If the parameter location is "path", this property is REQUIRED and its value MUST be true.
- Otherwise, the property MAY be included and its default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Deprecated">
- <summary>
- Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.AllowEmptyValue">
- <summary>
- Sets the ability to pass empty-valued parameters.
- This is valid only for query parameters and allows sending a parameter with an empty value.
- Default value is false.
- If style is used, and if behavior is n/a (cannot be serialized),
- the value of allowEmptyValue SHALL be ignored.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Style">
- <summary>
- Describes how the parameter value will be serialized depending on the type of the parameter value.
- Default values (based on value of in): for query - form; for path - simple; for header - simple;
- for cookie - form.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Explode">
- <summary>
- When this is true, parameter values of type array or object generate separate parameters
- for each value of the array or key-value pair of the map.
- For other types of parameters this property has no effect.
- When style is form, the default value is true.
- For all other styles, the default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.AllowReserved">
- <summary>
- Determines whether the parameter value SHOULD allow reserved characters,
- as defined by RFC3986 :/?#[]@!$&'()*+,;= to be included without percent-encoding.
- This property only applies to parameters with an in value of query.
- The default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Schema">
- <summary>
- The schema defining the type used for the parameter.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Examples">
- <summary>
- Examples of the media type. Each example SHOULD contain a value
- in the correct format as specified in the parameter encoding.
- The examples object is mutually exclusive of the example object.
- Furthermore, if referencing a schema which contains an example,
- the examples value SHALL override the example provided by the schema.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Example">
- <summary>
- Example of the media type. The example SHOULD match the specified schema and encoding properties
- if present. The example object is mutually exclusive of the examples object.
- Furthermore, if referencing a schema which contains an example,
- the example value SHALL override the example provided by the schema.
- To represent examples of media types that cannot naturally be represented in JSON or YAML,
- a string value can contain the example with escaping where necessary.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Content">
- <summary>
- A map containing the representations for the parameter.
- The key is the media type and the value describes it.
- The map MUST only contain one entry.
- For more complex scenarios, the content property can define the media type and schema of the parameter.
- A parameter MUST contain either a schema property, or a content property, but not both.
- When example or examples are provided in conjunction with the schema object,
- the example MUST follow the prescribed serialization strategy for the parameter.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiParameter.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiBodyParameter">
- <summary>
- Body parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)"/>
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiFormDataParameter">
- <summary>
- Form parameter class to propagate information needed for <see cref="M:Microsoft.OpenApi.Models.OpenApiParameter.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)"/>
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiPathItem">
- <summary>
- Path Item Object: to describe the operations available on a single path.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Summary">
- <summary>
- An optional, string summary, intended to apply to all operations in this path.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Description">
- <summary>
- An optional, string description, intended to apply to all operations in this path.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Operations">
- <summary>
- Gets the definition of operations on this path.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Servers">
- <summary>
- An alternative server array to service all operations in this path.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Parameters">
- <summary>
- A list of parameters that are applicable for all the operations described under this path.
- These parameters can be overridden at the operation level, but cannot be removed there.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiPathItem.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.AddOperation(Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation)">
- <summary>
- Add one operation into this path item.
- </summary>
- <param name="operationType">The operation type kind.</param>
- <param name="operation">The operation item.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiPathItem.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiPaths">
- <summary>
- Paths object.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiReference">
- <summary>
- A simple object to allow referencing other components in the specification, internally and externally.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiReference.ExternalResource">
- <summary>
- External resource in the reference.
- It maybe:
- 1. a absolute/relative file path, for example: ../commons/pet.json
- 2. a Url, for example: http://localhost/pet.json
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiReference.Type">
- <summary>
- The element type referenced.
- </summary>
- <remarks>This must be present if <see cref="P:Microsoft.OpenApi.Models.OpenApiReference.ExternalResource"/> is not present.</remarks>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiReference.Id">
- <summary>
- The identifier of the reusable component of one particular ReferenceType.
- If ExternalResource is present, this is the path to the component after the '#/'.
- For example, if the reference is 'example.json#/path/to/component', the Id is 'path/to/component'.
- If ExternalResource is not present, this is the name of the component without the reference type name.
- For example, if the reference is '#/components/schemas/componentName', the Id is 'componentName'.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiReference.IsExternal">
- <summary>
- Gets a flag indicating whether this reference is an external reference.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiReference.IsLocal">
- <summary>
- Gets a flag indicating whether this reference is a local reference.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiReference.ReferenceV3">
- <summary>
- Gets the full reference string for v3.0.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiReference.ReferenceV2">
- <summary>
- Gets the full reference string for V2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiReference.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiReference.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiReference"/> to Open Api v2.0.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiRequestBody">
- <summary>
- Request Body Object
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Reference">
- <summary>
- Reference object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Description">
- <summary>
- A brief description of the request body. This could contain examples of use.
- CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Required">
- <summary>
- Determines if the request body is required in the request. Defaults to false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Content">
- <summary>
- REQUIRED. The content of the request body. The key is a media type or media type range and the value describes it.
- For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiRequestBody.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiRequestBody.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiResponse">
- <summary>
- Response object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Description">
- <summary>
- REQUIRED. A short description of the response.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Headers">
- <summary>
- Maps a header name to its definition.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Content">
- <summary>
- A map containing descriptions of potential response payloads.
- The key is a media type or media type range and the value describes it.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Links">
- <summary>
- A map of operations links that can be followed from the response.
- The key of the map is a short name for the link,
- following the naming constraints of the names for Component Objects.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiResponse.Reference">
- <summary>
- Reference pointer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> to Open Api v3.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> to Open Api v2.0.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiResponse.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiResponses">
- <summary>
- Responses object.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiSchema">
- <summary>
- Schema Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Title">
- <summary>
- Follow JSON Schema definition. Short text providing information about the data.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Type">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Value MUST be a string. Multiple types via an array are not supported.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Format">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- While relying on JSON Schema's defined formats,
- the OAS offers a few additional predefined formats.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Description">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Maximum">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExclusiveMaximum">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Minimum">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExclusiveMinimum">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxLength">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinLength">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Pattern">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- This string SHOULD be a valid regular expression, according to the ECMA 262 regular expression dialect
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MultipleOf">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Default">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- 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.
- Unlike JSON Schema, the value MUST conform to the defined type for the Schema Object defined at the same level.
- For example, if type is string, then default can be "foo" but cannot be 1.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ReadOnly">
- <summary>
- Relevant only for Schema "properties" definitions. Declares the property as "read only".
- This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request.
- If the property is marked as readOnly being true and is in the required list,
- the required will take effect on the response only.
- A property MUST NOT be marked as both readOnly and writeOnly being true.
- Default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.WriteOnly">
- <summary>
- Relevant only for Schema "properties" definitions. Declares the property as "write only".
- Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response.
- If the property is marked as writeOnly being true and is in the required list,
- the required will take effect on the request only.
- A property MUST NOT be marked as both readOnly and writeOnly being true.
- Default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AllOf">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.OneOf">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AnyOf">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Not">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Inline or referenced schema MUST be of a Schema Object and not a standard JSON Schema.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Required">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Items">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Value MUST be an object and not an array. Inline or referenced schema MUST be of a Schema Object
- and not a standard JSON Schema. items MUST be present if the type is array.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxItems">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinItems">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.UniqueItems">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Properties">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Property definitions MUST be a Schema Object and not a standard JSON Schema (inline or referenced).
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MaxProperties">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.MinProperties">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AdditionalPropertiesAllowed">
- <summary>
- Indicates if the schema can contain properties other than those defined by the properties map.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.AdditionalProperties">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- Value can be boolean or object. Inline or referenced schema
- MUST be of a Schema Object and not a standard JSON Schema.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Discriminator">
- <summary>
- Adds support for polymorphism. The discriminator is an object name that is used to differentiate
- between other schemas which may satisfy the payload description.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Example">
- <summary>
- A free-form property to include an example of an instance for this schema.
- To represent examples that cannot be naturally represented in JSON or YAML,
- a string value can be used to contain the example with escaping where necessary.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Enum">
- <summary>
- Follow JSON Schema definition: https://tools.ietf.org/html/draft-fge-json-schema-validation-00
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Nullable">
- <summary>
- Allows sending a null value for the defined schema. Default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.ExternalDocs">
- <summary>
- Additional external documentation for this schema.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Deprecated">
- <summary>
- Specifies that a schema is deprecated and SHOULD be transitioned out of usage.
- Default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Xml">
- <summary>
- This MAY be used only on properties schemas. It has no effect on root schemas.
- Adds additional metadata to describe the XML representation of this property.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.UnresolvedReference">
- <summary>
- Indicates object is a placeholder reference to an actual object and does not contain valid data.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSchema.Reference">
- <summary>
- Reference object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.ISet{System.String},System.String)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> to Open Api v2.0 and handles not marking the provided property
- as readonly if its included in the provided list of required properties of parent schema.
- </summary>
- <param name="writer">The open api writer.</param>
- <param name="parentRequiredProperties">The list of required properties in parent schema.</param>
- <param name="propertyName">The property name that will be serialized.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSchema.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter,System.Collections.Generic.ISet{System.String},System.String)">
- <summary>
- Serialize to OpenAPI V2 document without using reference and handles not marking the provided property
- as readonly if its included in the provided list of required properties of parent schema.
- </summary>
- <param name="writer">The open api writer.</param>
- <param name="parentRequiredProperties">The list of required properties in parent schema.</param>
- <param name="propertyName">The property name that will be serialized.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement">
- <summary>
- Security Requirement Object.
- Each name MUST correspond to a security scheme which is declared in
- the Security Schemes under the Components Object.
- If the security scheme is of type "oauth2" or "openIdConnect",
- then the value is a list of scope names required for the execution.
- For other security scheme types, the array MUST be empty.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.#ctor">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> class.
- This constructor ensures that only Reference.Id is considered when two dictionary keys
- of type <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> are compared.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer">
- <summary>
- Comparer for OpenApiSecurityScheme that only considers the Id in the Reference
- (i.e. the string that will actually be displayed in the written document)
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.Equals(Microsoft.OpenApi.Models.OpenApiSecurityScheme,Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
- <summary>
- Determines whether the specified objects are equal.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityRequirement.OpenApiSecuritySchemeReferenceEqualityComparer.GetHashCode(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
- <summary>
- Returns a hash code for the specified object.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme">
- <summary>
- Security Scheme Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Type">
- <summary>
- REQUIRED. The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Description">
- <summary>
- A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Name">
- <summary>
- REQUIRED. The name of the header, query or cookie parameter to be used.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.In">
- <summary>
- REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Scheme">
- <summary>
- REQUIRED. The name of the HTTP Authorization scheme to be used
- in the Authorization header as defined in RFC7235.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.BearerFormat">
- <summary>
- A hint to the client to identify how the bearer token is formatted.
- Bearer tokens are usually generated by an authorization server,
- so this information is primarily for documentation purposes.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Flows">
- <summary>
- REQUIRED. An object containing configuration information for the flow types supported.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.OpenIdConnectUrl">
- <summary>
- REQUIRED. OpenId Connect URL to discover OAuth2 configuration values.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Extensions">
- <summary>
- Specification Extensions.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiSecurityScheme.Reference">
- <summary>
- Reference object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiSecurityScheme.WriteOAuthFlowForV2(Microsoft.OpenApi.Writers.IOpenApiWriter,Microsoft.OpenApi.Models.OpenApiOAuthFlows)">
- <summary>
- Arbitrarily chooses one <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> object from the <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/>
- to populate in V2 security scheme.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiServer">
- <summary>
- Server Object: an object representing a Server.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Description">
- <summary>
- An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Url">
- <summary>
- REQUIRED. A URL to the target host. This URL supports Server Variables and MAY be relative,
- to indicate that the host location is relative to the location where the OpenAPI document is being served.
- Variable substitutions will be made when a variable is named in {brackets}.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Variables">
- <summary>
- A map between a variable name and its value. The value is used for substitution in the server's URL template.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServer.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiServer.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiServer.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiServerVariable">
- <summary>
- Server Variable Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Description">
- <summary>
- An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Default">
- <summary>
- REQUIRED. The default value to use for substitution, and to send, if an alternate value is not supplied.
- Unlike the Schema Object's default, this value MUST be provided by the consumer.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Enum">
- <summary>
- An enumeration of string values to be used if the substitution options are from a limited set.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiServerVariable.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiServerVariable.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiTag">
- <summary>
- Tag Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Name">
- <summary>
- The name of the tag.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Description">
- <summary>
- A short description for the tag.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiTag.ExternalDocs">
- <summary>
- Additional external documentation for this tag.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Extensions">
- <summary>
- This object MAY be extended with Specification Extensions.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiTag.UnresolvedReference">
- <summary>
- Indicates if object is populated with data or is just a reference to the data
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiTag.Reference">
- <summary>
- Reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV3WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V3 document without using reference.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> to Open Api v2.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiTag.SerializeAsV2WithoutReference(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize to OpenAPI V2 document without using reference.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OpenApiXml">
- <summary>
- XML Object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Name">
- <summary>
- Replaces the name of the element/attribute used for the described schema property.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Namespace">
- <summary>
- The URI of the namespace definition. Value MUST be in the form of an absolute URI.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Prefix">
- <summary>
- The prefix to be used for the name
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Attribute">
- <summary>
- Declares whether the property definition translates to an attribute instead of an element.
- Default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Wrapped">
- <summary>
- Signifies whether the array is wrapped.
- Default value is false.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.OpenApiXml.Extensions">
- <summary>
- Specification Extensions.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiXml.SerializeAsV3(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiXml"/> to Open Api v3.0
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.OpenApiXml.SerializeAsV2(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Serialize <see cref="T:Microsoft.OpenApi.Models.OpenApiXml"/> to Open Api v2.0
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.OperationType">
- <summary>
- Operation type.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Get">
- <summary>
- A definition of a GET operation on this path.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Put">
- <summary>
- A definition of a PUT operation on this path.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Post">
- <summary>
- A definition of a POST operation on this path.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Delete">
- <summary>
- A definition of a DELETE operation on this path.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Options">
- <summary>
- A definition of a OPTIONS operation on this path.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Head">
- <summary>
- A definition of a HEAD operation on this path.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Patch">
- <summary>
- A definition of a PATCH operation on this path.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.OperationType.Trace">
- <summary>
- A definition of a TRACE operation on this path.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.ParameterLocation">
- <summary>
- The location of the parameter.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Query">
- <summary>
- Parameters that are appended to the URL.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Header">
- <summary>
- Custom headers that are expected as part of the request.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Path">
- <summary>
- Used together with Path Templating,
- where the parameter value is actually part of the operation's URL
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterLocation.Cookie">
- <summary>
- Used to pass a specific cookie value to the API.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.ParameterStyle">
- <summary>
- The style of the parameter.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Matrix">
- <summary>
- Path-style parameters.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Label">
- <summary>
- Label style parameters.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Form">
- <summary>
- Form style parameters.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterStyle.Simple">
- <summary>
- Simple style parameters.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterStyle.SpaceDelimited">
- <summary>
- Space separated array values.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterStyle.PipeDelimited">
- <summary>
- Pipe separated array values.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ParameterStyle.DeepObject">
- <summary>
- Provides a simple way of rendering nested objects using form parameters.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.ReferenceType">
- <summary>
- The reference type.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Schema">
- <summary>
- Schema item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Response">
- <summary>
- Responses item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Parameter">
- <summary>
- Parameters item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Example">
- <summary>
- Examples item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.RequestBody">
- <summary>
- RequestBodies item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Header">
- <summary>
- Headers item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.SecurityScheme">
- <summary>
- SecuritySchemes item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Link">
- <summary>
- Links item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Callback">
- <summary>
- Callbacks item.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.ReferenceType.Tag">
- <summary>
- Tags item.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper">
- <summary>
- The wrapper either for <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> or <see cref="T:Microsoft.OpenApi.Expressions.RuntimeExpression"/>
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.Any">
- <summary>
- Gets/Sets the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.Expression">
- <summary>
- Gets/Set the <see cref="T:Microsoft.OpenApi.Expressions.RuntimeExpression"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper.WriteValue(Microsoft.OpenApi.Writers.IOpenApiWriter)">
- <summary>
- Write <see cref="T:Microsoft.OpenApi.Models.RuntimeExpressionAnyWrapper"/>
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Models.SecuritySchemeType">
- <summary>
- The type of the security scheme
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.ApiKey">
- <summary>
- Use API key
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.Http">
- <summary>
- Use basic or bearer token authorization header.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.OAuth2">
- <summary>
- Use OAuth2
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Models.SecuritySchemeType.OpenIdConnect">
- <summary>
- Use OAuth2 with OpenId Connect URL to discover OAuth2 configuration value.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.OpenApiFormat">
- <summary>
- Represents the Open Api document format.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.OpenApiFormat.Json">
- <summary>
- JSON format.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.OpenApiFormat.Yaml">
- <summary>
- Yaml format.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.OpenApiSpecVersion">
- <summary>
- Represents versions of OpenAPI specification.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.OpenApiSpecVersion.OpenApi2_0">
- <summary>
- Represents OpenAPI V2.0 spec
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.OpenApiSpecVersion.OpenApi3_0">
- <summary>
- Represents all patches of OpenAPI V3.0 spec (e.g. 3.0.0, 3.0.1)
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Properties.SRResource">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ActiveScopeNeededForPropertyNameWriting">
- <summary>
- Looks up a localized string similar to There must be an active scope for name '{0}' to be written..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ArgumentNullOrWhiteSpace">
- <summary>
- Looks up a localized string similar to The argument '{0}' is null, empty or consists only of white-space..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ExtensionFieldNameMustBeginWithXDash">
- <summary>
- Looks up a localized string similar to The filed name '{0}' of extension doesn't begin with x-..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.IndentationLevelInvalid">
- <summary>
- Looks up a localized string similar to Indentation level cannot be lower than 0..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.InputItemShouldBeType">
- <summary>
- Looks up a localized string similar to The input item should be in type of '{0}'..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.InvalidReferenceId">
- <summary>
- Looks up a localized string similar to Invalid Reference identifier '{0}'..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.InvalidReferenceType">
- <summary>
- Looks up a localized string similar to Invalid Reference Type..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.LocalReferenceRequiresType">
- <summary>
- Looks up a localized string similar to Local reference must have type specified..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ObjectScopeNeededForPropertyNameWriting">
- <summary>
- Looks up a localized string similar to The active scope must be an object scope for property name '{0}' to be written..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiExceptionGenericError">
- <summary>
- Looks up a localized string similar to An error occurred while processing the Open API document..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiFormatNotSupported">
- <summary>
- Looks up a localized string similar to The given OpenAPI format '{0}' is not supported..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiObjectElementIsRequired">
- <summary>
- Looks up a localized string similar to The object element name '{0}' is required..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiObjectMarkAsReference">
- <summary>
- Looks up a localized string similar to The OpenApi element '{0}' is already marked as reference object..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiParameterRequiredPropertyMandatory">
- <summary>
- Looks up a localized string similar to If the parameter location is "path", this property is REQUIRED and its value MUST be true.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiSpecVersionNotSupported">
- <summary>
- Looks up a localized string similar to The given OpenAPI specification version '{0}' is not supported..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiUnsupportedValueType">
- <summary>
- Looks up a localized string similar to The type '{0}' is not supported in Open API document..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.OpenApiWriterExceptionGenericError">
- <summary>
- Looks up a localized string similar to An error occurred while writing the Open API document..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.PrimitiveTypeNotSupported">
- <summary>
- Looks up a localized string similar to The given primitive type '{0}' is not supported..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ReferenceHasInvalidFormat">
- <summary>
- Looks up a localized string similar to The reference string '{0}' has invalid format..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.RemoteReferenceNotSupported">
- <summary>
- Looks up a localized string similar to Remote reference not supported..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.RuntimeExpressionHasInvalidFormat">
- <summary>
- Looks up a localized string similar to The runtime expression '{0}' has invalid format..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.RuntimeExpressionMustBeginWithDollar">
- <summary>
- Looks up a localized string similar to The runtime expression '{0}' should start with '$'.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ScopeMustBePresentToEnd">
- <summary>
- Looks up a localized string similar to Scope must be present to end..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.ScopeToEndHasIncorrectType">
- <summary>
- Looks up a localized string similar to The scope to end is expected to be of type '{0}' but it is of type '{0}'..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.SourceExpressionHasInvalidFormat">
- <summary>
- Looks up a localized string similar to The source expression '{0}' has invalid format..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.UnknownVisitorType">
- <summary>
- Looks up a localized string similar to Can not find visitor type registered for type '{0}'..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_ComponentsKeyMustMatchRegularExpr">
- <summary>
- Looks up a localized string similar to The key '{0}' in '{1}' of components MUST match the regular expression '{2}'..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_ExtensionNameMustBeginWithXDash">
- <summary>
- Looks up a localized string similar to The extension name '{0}' in '{1}' object MUST begin with 'x-'..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_FieldIsRequired">
- <summary>
- Looks up a localized string similar to The field '{0}' in '{1}' object is REQUIRED..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_PathItemMustBeginWithSlash">
- <summary>
- Looks up a localized string similar to The path item name '{0}' MUST begin with a slash..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_RuleAddTwice">
- <summary>
- Looks up a localized string similar to The same rule cannot be in the same rule set twice..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_SchemaRequiredFieldListMustContainThePropertySpecifiedInTheDiscriminator">
- <summary>
- Looks up a localized string similar to Schema {0} must contain property specified in the discriminator {1} in the required field list..
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Properties.SRResource.Validation_StringMustBeEmailAddress">
- <summary>
- Looks up a localized string similar to The string '{0}' MUST be in the format of an email address..
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.LoopDetector.PushLoop``1(``0)">
- <summary>
- Maintain history of traversals to avoid stack overflows from cycles
- </summary>
- <param name="key">Identifier used for current context.</param>
- <returns>If method returns false a loop was detected and the key is not added.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Services.LoopDetector.PopLoop``1">
- <summary>
- Exit from the context in cycle detection
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.LoopDetector.Loops">
- <summary>
- List of Loops detected
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.LoopDetector.ClearLoop``1">
- <summary>
- Reset loop tracking stack
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Services.OpenApiVisitorBase">
- <summary>
- Open API visitor base provides common logic for concrete visitors
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.OpenApiVisitorBase.CurrentKeys">
- <summary>
- Properties available to identify context of where an object is within OpenAPI Document
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Enter(System.String)">
- <summary>
- Allow Rule to indicate validation error occured at a deeper context level.
- </summary>
- <param name="segment">Identifier for context</param>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Exit">
- <summary>
- Exit from path context elevel. Enter and Exit calls should be matched.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.OpenApiVisitorBase.PathString">
- <summary>
- Pointer to source of validation error in document
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiDocument)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiInfo)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiContact)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiLicense)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiServer})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiServer)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiPaths)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiPathItem)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiServerVariable)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation})">
- <summary>
- Visits the operations.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiOperation)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiParameter)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiRequestBody)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
- <summary>
- Visits headers.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
- <summary>
- Visits callbacks.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiResponse)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiResponses)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiMediaType})">
- <summary>
- Visits media type content.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiMediaType)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiEncoding)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
- <summary>
- Visits the examples.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiComponents)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
- <summary>
- Visits the links.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiLink)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiCallback)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiTag)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiHeader)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Models.OpenApiExample)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiTag})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSecurityRequirement})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiServerVariable})">
- <summary>
- Visits a dictionary of server variables
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiEncoding})">
- <summary>
- Visits a dictionary of encodings
- </summary>
- <param name="encodings"></param>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiVisitorBase.Visit(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
- <summary>
- Visits IOpenApiReferenceable instances that are references and not in components
- </summary>
- <param name="referenceable">referenced object</param>
- </member>
- <member name="T:Microsoft.OpenApi.Services.OpenApiWalker">
- <summary>
- The walker to visit multiple Open API elements.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.#ctor(Microsoft.OpenApi.Services.OpenApiVisitorBase)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Services.OpenApiWalker"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiDocument)">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/> and child objects
- </summary>
- <param name="doc">OpenApiDocument to be walked</param>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiTag})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiComponents)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiPaths)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiServer})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiInfo)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
- <summary>
- Visits dictionary of extensions
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiLicense)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiContact)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiCallback,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiTag)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiServer)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiServerVariable})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiServerVariable)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiServerVariable"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiPathItem)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiPathItem"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{Microsoft.OpenApi.Models.OperationType,Microsoft.OpenApi.Models.OpenApiOperation})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOperation)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOperation"/> and child objects
- </summary>
- <param name="operation"></param>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSecurityRequirement})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiParameter})">
- <summary>
- Visits list of <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiParameter,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiResponses)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiResponse,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiRequestBody,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiRequestBody"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiHeader})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiCallback})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiMediaType})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiMediaType)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiEncoding})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiEncoding)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSchema,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiExample})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Any.IOpenApiAny)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiExample,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
- <summary>
- Visits the list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiSchema})">
- <summary>
- Visits a list of <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOAuthFlows)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlows"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.Collections.Generic.IDictionary{System.String,Microsoft.OpenApi.Models.OpenApiLink})">
- <summary>
- Visits dictionary of <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiLink,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiLink"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiHeader,System.Boolean)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSecurityRequirement)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityRequirement"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Models.OpenApiSecurityScheme)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable)">
- <summary>
- Visits <see cref="T:Microsoft.OpenApi.Models.OpenApiSecurityScheme"/> and child objects
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(Microsoft.OpenApi.Interfaces.IOpenApiElement)">
- <summary>
- Dispatcher method that enables using a single method to walk the model
- starting from any <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/>
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.Walk(System.String,System.Action)">
- <summary>
- Adds a segment to the context path to enable pointing to the current location in the document
- </summary>
- <param name="context">An identifier for the context.</param>
- <param name="walk">An action that walks objects within the context.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Services.OpenApiWalker.ProcessAsReference(Microsoft.OpenApi.Interfaces.IOpenApiReferenceable,System.Boolean)">
- <summary>
- Identify if an element is just a reference to a component, or an actual component
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Services.CurrentKeys">
- <summary>
- Object containing contextual information based on where the walker is currently referencing in an OpenApiDocument
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Path">
- <summary>
- Current Path key
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Operation">
- <summary>
- Current Operation Type
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Response">
- <summary>
- Current Response Status Code
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Content">
- <summary>
- Current Content Media Type
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Callback">
- <summary>
- Current Callback Key
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Link">
- <summary>
- Current Link Key
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Header">
- <summary>
- Current Header Key
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Encoding">
- <summary>
- Current Encoding Key
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Example">
- <summary>
- Current Example Key
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.Extension">
- <summary>
- Current Extension Key
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Services.CurrentKeys.ServerVariable">
- <summary>
- Current ServerVariable
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.IValidationContext">
- <summary>
- Constrained interface used to provide context to rule implementation
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.IValidationContext.AddError(Microsoft.OpenApi.Validations.OpenApiValidatorError)">
- <summary>
- Register an error with the validation context.
- </summary>
- <param name="error">Error to register.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.IValidationContext.Enter(System.String)">
- <summary>
- Allow Rule to indicate validation error occured at a deeper context level.
- </summary>
- <param name="segment">Identifier for context</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.IValidationContext.Exit">
- <summary>
- Exit from path context elevel. Enter and Exit calls should be matched.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.IValidationContext.PathString">
- <summary>
- Pointer to source of validation error in document
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.OpenApiValidator">
- <summary>
- Class containing dispatchers to execute validation rules on for Open API document.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.#ctor(Microsoft.OpenApi.Validations.ValidationRuleSet)">
- <summary>
- Create a vistor that will validate an OpenAPIDocument
- </summary>
- <param name="ruleSet"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.OpenApiValidator.Errors">
- <summary>
- Gets the validation errors.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.AddError(Microsoft.OpenApi.Validations.OpenApiValidatorError)">
- <summary>
- Register an error with the validation context.
- </summary>
- <param name="error">Error to register.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiDocument)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiInfo)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiContact)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiComponents)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiHeader)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiResponse)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiMediaType)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiResponses)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiExternalDocs)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiLicense)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiOAuthFlow)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiTag)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiParameter)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiSchema)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiServer)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiEncoding)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiEncoding"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Models.OpenApiCallback)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Models.OpenApiCallback"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtensible)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(Microsoft.OpenApi.Interfaces.IOpenApiExtension)">
- <summary>
- Execute validation rules against an <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtension"/>
- </summary>
- <param name="item">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Visit(System.Collections.Generic.IList{Microsoft.OpenApi.Models.OpenApiExample})">
- <summary>
- Execute validation rules against a list of <see cref="T:Microsoft.OpenApi.Models.OpenApiExample"/>
- </summary>
- <param name="items">The object to be validated</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidator.Validate(System.Object,System.Type)">
- <summary>
- This overload allows applying rules based on actual object type, rather than matched interface. This is
- needed for validating extensions.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.OpenApiValidatorError">
- <summary>
- Errors detected when validating an OpenAPI Element
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.OpenApiValidatorError.#ctor(System.String,System.String,System.String)">
- <summary>
- Initializes the <see cref="T:Microsoft.OpenApi.Models.OpenApiError"/> class.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.OpenApiValidatorError.RuleName">
- <summary>
- Name of rule that detected the error.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiComponents"/>.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules.KeyRegex">
- <summary>
- The key regex.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiComponentsRules.KeyMustBeRegularExpression">
- <summary>
- All the fixed fields declared above are objects
- that MUST use keys that match the regular expression: ^[a-zA-Z0-9\.\-_]+$.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiContactRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiContact"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiContactRules.EmailMustBeEmailFormat">
- <summary>
- Email field MUST be email address.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiDocumentRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiDocument"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiDocumentRules.OpenApiDocumentFieldIsMissing">
- <summary>
- The Info field is required.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiExtensibleRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiExtensible"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiExtensibleRules.ExtensionNameMustStartWithXDash">
- <summary>
- Extension name MUST start with "x-".
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiExternalDocsRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiExternalDocs"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiExternalDocsRules.UrlIsRequired">
- <summary>
- Validate the field is required.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiHeaderRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiHeader"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiHeaderRules.HeaderMismatchedDataType">
- <summary>
- Validate the data matches with the given data type.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiInfoRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiInfo"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiInfoRules.InfoRequiredFields">
- <summary>
- Validate the field is required.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiLicenseRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiLicense"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiLicenseRules.LicenseRequiredFields">
- <summary>
- REQUIRED.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiMediaTypeRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiMediaType"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiMediaTypeRules.MediaTypeMismatchedDataType">
- <summary>
- Validate the data matches with the given data type.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiOAuthFlowRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiOAuthFlow"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiOAuthFlowRules.OAuthFlowRequiredFields">
- <summary>
- Validate the field is required.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiParameter"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.ParameterRequiredFields">
- <summary>
- Validate the field is required.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.RequiredMustBeTrueWhenInIsPath">
- <summary>
- Validate the "required" field is true when "in" is path.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiParameterRules.ParameterMismatchedDataType">
- <summary>
- Validate the data matches with the given data type.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiPathsRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiPaths"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiPathsRules.PathNameMustBeginWithSlash">
- <summary>
- A relative path to an individual endpoint. The field name MUST begin with a slash.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiResponseRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiResponse"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponseRules.ResponseRequiredFields">
- <summary>
- Validate the field is required.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiResponses"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules.ResponsesMustContainAtLeastOneResponse">
- <summary>
- An OpenAPI operation must contain at least one response
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiResponsesRules.ResponsesMustBeIdentifiedByDefaultOrStatusCode">
- <summary>
- The response key must either be "default" or an HTTP status code (1xx, 2xx, 3xx, 4xx, 5xx).
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiRuleAttribute">
- <summary>
- The Validator attribute.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiSchema"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules.SchemaMismatchedDataType">
- <summary>
- Validate the data matches with the given data type.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiSchemaRules.ValidateSchemaDiscriminator">
- <summary>
- Validates Schema Discriminator
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiServerRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiServer"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiServerRules.ServerRequiredFields">
- <summary>
- Validate the field is required.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.Rules.OpenApiTagRules">
- <summary>
- The validation rules for <see cref="T:Microsoft.OpenApi.Models.OpenApiTag"/>.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.Rules.OpenApiTagRules.TagRequiredFields">
- <summary>
- Validate the field is required.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.Rules.RuleHelpers.IsEmailAddress(System.String)">
- <summary>
- Input string must be in the format of an email address
- </summary>
- <param name="input">The input string.</param>
- <returns>True if it's an email address. Otherwise False.</returns>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.ValidationContextExtensions">
- <summary>
- Helper methods to simplify creating validation rules
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationContextExtensions.CreateError(Microsoft.OpenApi.Validations.IValidationContext,System.String,System.String)">
- <summary>
- Helper method to simplify validation rules
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.ValidationRule">
- <summary>
- Class containing validation rule logic.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.ValidationRule.ElementType">
- <summary>
- Element Type.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRule.Evaluate(Microsoft.OpenApi.Validations.IValidationContext,System.Object)">
- <summary>
- Validate the object.
- </summary>
- <param name="context">The context.</param>
- <param name="item">The object item.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.ValidationRule`1">
- <summary>
- Class containing validation rule logic for <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/>.
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRule`1.#ctor(System.Action{Microsoft.OpenApi.Validations.IValidationContext,`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRule"/> class.
- </summary>
- <param name="validate">Action to perform the validation.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Validations.ValidationRuleSet">
- <summary>
- The rule set of the validation.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.FindRules(System.Type)">
- <summary>
- Retrieve the rules that are related to a specific type
- </summary>
- <param name="type">The type that is to be validated</param>
- <returns>Either the rules related to the type, or an empty list.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.GetDefaultRuleSet">
- <summary>
- Gets the default validation rule sets.
- </summary>
- <remarks>
- This is a method instead of a property to signal that a new default ruleset object is created
- per call. Making this a property may be misleading callers to think the returned rulesets from multiple calls
- are the same objects.
- </remarks>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.GetEmptyRuleSet">
- <summary>
- Return Ruleset with no rules
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor(Microsoft.OpenApi.Validations.ValidationRuleSet)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
- </summary>
- <param name="ruleSet">Rule set to be copied from.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.#ctor(System.Collections.Generic.IEnumerable{Microsoft.OpenApi.Validations.ValidationRule})">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Validations.ValidationRuleSet"/> class.
- </summary>
- <param name="rules">Rules to be contained in this ruleset.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Validations.ValidationRuleSet.Rules">
- <summary>
- Gets the rules in this rule set.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.Add(Microsoft.OpenApi.Validations.ValidationRule)">
- <summary>
- Add the new rule into the rule set.
- </summary>
- <param name="rule">The rule.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.GetEnumerator">
- <summary>
- Get the enumerator.
- </summary>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:Microsoft.OpenApi.Validations.ValidationRuleSet.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Get the enumerator.
- </summary>
- <returns>The enumerator.</returns>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.FormattingStreamWriter">
- <summary>
- A custom <see cref="T:System.IO.StreamWriter"/> which supports setting a <see cref="T:System.IFormatProvider"/>.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.FormattingStreamWriter.#ctor(System.IO.Stream,System.IFormatProvider)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.FormattingStreamWriter"/> class.
- </summary>
- <param name="stream"></param>
- <param name="formatProvider"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.FormattingStreamWriter.FormatProvider">
- <summary>
- The <see cref="T:System.IFormatProvider"/> associated with this <see cref="T:Microsoft.OpenApi.Writers.FormattingStreamWriter"/>.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.IOpenApiWriter">
- <summary>
- Interface for writing Open API documentation.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteStartObject">
- <summary>
- Write the start object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteEndObject">
- <summary>
- Write the end object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteStartArray">
- <summary>
- Write the start array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteEndArray">
- <summary>
- Write the end array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WritePropertyName(System.String)">
- <summary>
- Write the property name.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.String)">
- <summary>
- Write the string value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Decimal)">
- <summary>
- Write the decimal value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Int32)">
- <summary>
- Write the int value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Boolean)">
- <summary>
- Write the boolean value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteNull">
- <summary>
- Write the null value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteRaw(System.String)">
- <summary>
- Write the raw content value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.WriteValue(System.Object)">
- <summary>
- Write the object value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.IOpenApiWriter.Flush">
- <summary>
- Flush the writer.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter">
- <summary>
- JSON Writer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.#ctor(System.IO.TextWriter)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter"/> class.
- </summary>
- <param name="textWriter">The text writer.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiJsonWriter"/> class.
- </summary>
- <param name="textWriter">The text writer.</param>
- <param name="settings">Settings for controlling how the OpenAPI document will be written out.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.OpenApiJsonWriter.BaseIndentation">
- <summary>
- Base Indentation Level.
- This denotes how many indentations are needed for the property in the base object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteStartObject">
- <summary>
- Write JSON start object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteEndObject">
- <summary>
- Write JSON end object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteStartArray">
- <summary>
- Write JSON start array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteEndArray">
- <summary>
- Write JSON end array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WritePropertyName(System.String)">
- <summary>
- Write property name.
- </summary>
- <param name="name">The property name.</param>
- public override void WritePropertyName(string name)
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteValue(System.String)">
- <summary>
- Write string value.
- </summary>
- <param name="value">The string value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteNull">
- <summary>
- Write null value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteValueSeparator">
- <summary>
- Writes a separator of a value if it's needed for the next value to be written.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiJsonWriter.WriteRaw(System.String)">
- <summary>
- Writes the content raw value.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterAnyExtensions">
- <summary>
- Extensions methods for writing the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/>
- </summary>
- </member>
- <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)">
- <summary>
- Write the specification extensions
- </summary>
- <param name="writer">The Open API writer.</param>
- <param name="extensions">The specification extensions.</param>
- <param name="specVersion">Version of the OpenAPI specification that that will be output.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterAnyExtensions.WriteAny``1(Microsoft.OpenApi.Writers.IOpenApiWriter,``0)">
- <summary>
- Write the <see cref="T:Microsoft.OpenApi.Any.IOpenApiAny"/> value.
- </summary>
- <typeparam name="T">The Open API Any type.</typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="any">The Any value</param>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterBase">
- <summary>
- Base class for Open API writer.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterBase.Settings">
- <summary>
- Settings for controlling how the OpenAPI document will be written out.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase.IndentationString">
- <summary>
- The indentation string to prepand to each line for each indentation level.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase.Scopes">
- <summary>
- Scope of the Open API element - object, array, property.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.OpenApiWriterBase._indentLevel">
- <summary>
- Number which specifies the level of indentation.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.#ctor(System.IO.TextWriter)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiWriterBase"/> class.
- </summary>
- <param name="textWriter">The text writer.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiWriterBase"/> class.
- </summary>
- <param name="textWriter"></param>
- <param name="settings"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterBase.BaseIndentation">
- <summary>
- Base Indentation Level.
- This denotes how many indentations are needed for the property in the base object.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterBase.Writer">
- <summary>
- The text writer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteStartObject">
- <summary>
- Write start object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteEndObject">
- <summary>
- Write end object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteStartArray">
- <summary>
- Write start array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteEndArray">
- <summary>
- Write end array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WritePropertyName(System.String)">
- <summary>
- Write the start property.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValueSeparator">
- <summary>
- Writes a separator of a value if it's needed for the next value to be written.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteNull">
- <summary>
- Write null value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteRaw(System.String)">
- <summary>
- Write content raw value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.Flush">
- <summary>
- Flush the writer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.String)">
- <summary>
- Write string value.
- </summary>
- <param name="value">The string value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Single)">
- <summary>
- Write float value.
- </summary>
- <param name="value">The float value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Double)">
- <summary>
- Write double value.
- </summary>
- <param name="value">The double value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Decimal)">
- <summary>
- Write decimal value.
- </summary>
- <param name="value">The decimal value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Int32)">
- <summary>
- Write integer value.
- </summary>
- <param name="value">The integer value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Int64)">
- <summary>
- Write long value.
- </summary>
- <param name="value">The long value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.DateTime)">
- <summary>
- Write DateTime value.
- </summary>
- <param name="value">The DateTime value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.DateTimeOffset)">
- <summary>
- Write DateTimeOffset value.
- </summary>
- <param name="value">The DateTimeOffset value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Boolean)">
- <summary>
- Write boolean value.
- </summary>
- <param name="value">The boolean value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteValue(System.Object)">
- <summary>
- Write object value.
- </summary>
- <param name="value">The object value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IncreaseIndentation">
- <summary>
- Increases the level of indentation applied to the output.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.DecreaseIndentation">
- <summary>
- Decreases the level of indentation applied to the output.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.WriteIndentation">
- <summary>
- Write the indentation.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.CurrentScope">
- <summary>
- Get current scope.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.StartScope(Microsoft.OpenApi.Writers.ScopeType)">
- <summary>
- Start the scope given the scope type.
- </summary>
- <param name="type">The scope type to start.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.EndScope(Microsoft.OpenApi.Writers.ScopeType)">
- <summary>
- End the scope of the given scope type.
- </summary>
- <param name="type"></param>
- <returns></returns>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsTopLevelScope">
- <summary>
- Whether the current scope is the top level (outermost) scope.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsObjectScope">
- <summary>
- Whether the current scope is an object scope.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.IsArrayScope">
- <summary>
- Whether the current scope is an array scope.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterBase.VerifyCanWritePropertyName(System.String)">
- <summary>
- Verifies whether a property name can be written based on whether
- the property name is a valid string and whether the current scope is an object scope.
- </summary>
- <param name="name">property name</param>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterExtensions">
- <summary>
- Extension methods for writing Open API documentation.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.String)">
- <summary>
- Write a string property.
- </summary>
- <param name="writer">The writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteRequiredProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.String)">
- <summary>
- Write required string property.
- </summary>
- <param name="writer">The writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Boolean,System.Boolean)">
- <summary>
- Write a boolean property.
- </summary>
- <param name="writer">The writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- <param name="defaultValue">The default boolean value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Nullable{System.Boolean},System.Boolean)">
- <summary>
- Write a boolean property.
- </summary>
- <param name="writer">The writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- <param name="defaultValue">The default boolean value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,System.Nullable{``0})">
- <summary>
- Write a primitive property.
- </summary>
- <param name="writer">The writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteProperty``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0)">
- <summary>
- Write a string/number property.
- </summary>
- <param name="writer">The writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteOptionalObject``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
- <summary>
- Write the optional Open API object/element.
- </summary>
- <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- <param name="action">The proprety value writer action.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiWriterExtensions.WriteRequiredObject``1(Microsoft.OpenApi.Writers.IOpenApiWriter,System.String,``0,System.Action{Microsoft.OpenApi.Writers.IOpenApiWriter,``0})">
- <summary>
- Write the required Open API object/element.
- </summary>
- <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="value">The property value.</param>
- <param name="action">The proprety value writer action.</param>
- </member>
- <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})">
- <summary>
- Write the optional of collection string.
- </summary>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The collection values.</param>
- <param name="action">The collection string writer action.</param>
- </member>
- <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})">
- <summary>
- Write the optional Open API object/element collection.
- </summary>
- <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The collection values.</param>
- <param name="action">The collection element writer action.</param>
- </member>
- <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})">
- <summary>
- Write the required Open API object/element collection.
- </summary>
- <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The collection values.</param>
- <param name="action">The collection element writer action.</param>
- </member>
- <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})">
- <summary>
- Write the optional Open API element map (string to string mapping).
- </summary>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The map values.</param>
- <param name="action">The map element writer action.</param>
- </member>
- <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})">
- <summary>
- Write the required Open API element map (string to string mapping).
- </summary>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The map values.</param>
- <param name="action">The map element writer action.</param>
- </member>
- <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})">
- <summary>
- Write the optional Open API element map.
- </summary>
- <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The map values.</param>
- <param name="action">The map element writer action with writer and value as input.</param>
- </member>
- <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})">
- <summary>
- Write the optional Open API element map.
- </summary>
- <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The map values.</param>
- <param name="action">The map element writer action with writer, key, and value as input.</param>
- </member>
- <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})">
- <summary>
- Write the required Open API element map.
- </summary>
- <typeparam name="T">The Open API element type. <see cref="T:Microsoft.OpenApi.Interfaces.IOpenApiElement"/></typeparam>
- <param name="writer">The Open API writer.</param>
- <param name="name">The property name.</param>
- <param name="elements">The map values.</param>
- <param name="action">The map element writer action.</param>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.ReferenceInlineSetting">
- <summary>
- Indicates if and when the reader should convert references into complete object renderings
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.DoNotInlineReferences">
- <summary>
- Create placeholder objects with an OpenApiReference instance and UnresolvedReference set to true.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.InlineLocalReferences">
- <summary>
- Convert local references to references of valid domain objects.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.ReferenceInlineSetting.InlineAllReferences">
- <summary>
- Convert all references to references of valid domain objects.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.OpenApiWriterSettings">
- <summary>
- Configuration settings to control how OpenAPI documents are written
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.OpenApiWriterSettings.ReferenceInline">
- <summary>
- Indicates how references in the source document should be handled.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter">
- <summary>
- YAML writer.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.#ctor(System.IO.TextWriter)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter"/> class.
- </summary>
- <param name="textWriter">The text writer.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.#ctor(System.IO.TextWriter,Microsoft.OpenApi.Writers.OpenApiWriterSettings)">
- <summary>
- Initializes a new instance of the <see cref="T:Microsoft.OpenApi.Writers.OpenApiYamlWriter"/> class.
- </summary>
- <param name="textWriter">The text writer.</param>
- <param name="settings"></param>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.OpenApiYamlWriter.BaseIndentation">
- <summary>
- Base Indentation Level.
- This denotes how many indentations are needed for the property in the base object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteStartObject">
- <summary>
- Write YAML start object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteEndObject">
- <summary>
- Write YAML end object.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteStartArray">
- <summary>
- Write YAML start array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteEndArray">
- <summary>
- Write YAML end array.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WritePropertyName(System.String)">
- <summary>
- Write the property name and the delimiter.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteValue(System.String)">
- <summary>
- Write string value.
- </summary>
- <param name="value">The string value.</param>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteNull">
- <summary>
- Write null value.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteValueSeparator">
- <summary>
- Write value separator.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.OpenApiYamlWriter.WriteRaw(System.String)">
- <summary>
- Writes the content raw value.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.ScopeType">
- <summary>
- Various scope types for Open API writer.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.ScopeType.Object">
- <summary>
- Object scope.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.ScopeType.Array">
- <summary>
- Array scope.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.Scope">
- <summary>
- Class representing scope information.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.Scope._type">
- <summary>
- The type of the scope.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.Scope.#ctor(Microsoft.OpenApi.Writers.ScopeType)">
- <summary>
- Constructor.
- </summary>
- <param name="type">The type of the scope.</param>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.Scope.ObjectCount">
- <summary>
- Get/Set the object count for this scope.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.Scope.Type">
- <summary>
- Gets the scope type for this scope.
- </summary>
- </member>
- <member name="P:Microsoft.OpenApi.Writers.Scope.IsInArray">
- <summary>
- Get/Set the whether it is in previous array scope.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.SpecialCharacterStringExtensions">
- <summary>
- Extensions class for strings to handle special characters.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.SpecialCharacterStringExtensions.GetYamlCompatibleString(System.String)">
- <summary>
- Escapes all special characters and put the string in quotes if necessary to
- get a YAML-compatible string.
- </summary>
- </member>
- <member name="M:Microsoft.OpenApi.Writers.SpecialCharacterStringExtensions.GetJsonCompatibleString(System.String)">
- <summary>
- Handles control characters and backslashes and adds double quotes
- to get JSON-compatible string.
- </summary>
- </member>
- <member name="T:Microsoft.OpenApi.Writers.WriterConstants">
- <summary>
- Constants for the writer.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeFormat">
- <summary>
- JSON datetime format.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeOffsetFormat">
- <summary>
- JSON datetime offset format.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ODataDateTimeOffsetPlusSign">
- <summary>
- A plus sign for the date time offset format.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonTrueLiteral">
- <summary>
- The true value literal.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonFalseLiteral">
- <summary>
- The false value literal.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.JsonNullLiteral">
- <summary>
- The null value literal.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartObjectScope">
- <summary>
- Character which starts the object scope.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndObjectScope">
- <summary>
- Character which ends the object scope.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartArrayScope">
- <summary>
- Character which starts the array scope.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndArrayScope">
- <summary>
- Character which ends the array scope.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.StartPaddingFunctionScope">
- <summary>
- "(" Json Padding Function scope open parens.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EndPaddingFunctionScope">
- <summary>
- ")" Json Padding Function scope close parens.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ObjectMemberSeparator">
- <summary>
- The separator between object members.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.ArrayElementSeparator">
- <summary>
- The separator between array elements.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.NameValueSeparator">
- <summary>
- The separator between the name and the value.
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForEmptyObject">
- <summary>
- The white space for empty object
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForEmptyArray">
- <summary>
- The white space for empty array
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.PrefixOfArrayItem">
- <summary>
- The prefix of array item
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.WhiteSpaceForIndent">
- <summary>
- The white space for indent
- </summary>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EmptyObject">
- <summary>
- Empty object
- </summary>
- <remarks>To indicate empty object in YAML.</remarks>
- </member>
- <member name="F:Microsoft.OpenApi.Writers.WriterConstants.EmptyArray">
- <summary>
- Empty array
- </summary>
- <remarks>To indicate empty array in YAML.</remarks>
- </member>
- </members>
- </doc>
|