@|h]dZddlmZddlZddlZddlmZddlmZddl m Z ddl m Z m Z mZmZmZdd lmZmZmZej*rdd lmZgd Zed gzZeed Ze dZe dZGddZGddZy)z#Core apispec classes and functions.) annotationsN)Sequence)deepcopy)Version) APISpecErrorDuplicateComponentNameErrorDuplicateParameterErrorInvalidParameterErrorPluginMethodNotImplementedError)COMPONENT_SUBSECTIONSbuild_reference deepupdate) BasePlugin)getpostputpatchdeleteheadoptionstrace)z2.0z4.0cheZdZdZ ddZddZdd ddZ ddZ ddZ ddd dd Z ddd dd Z ddd dd Z dd d d Z dd d!dZ d"dZd#dZd#dZd$dZd#dZd#dZd#dZd#dZd#dZy )% ComponentszStores OpenAPI components Components are top-level fields in OAS v2. They became sub-fields of "components" top-level field in OAS v3. c||_||_i|_i|_i|_i|_i|_i|_i|_i|_ i|_ i|_ i|_ |j|j|j|j |j |jd|_ |j|j|j|j|jd|_y)N)schemaresponse parameterheaderexamplesecurity_scheme)rrr r!r")_pluginsopenapi_versionschemas responses parametersheadersexamplessecurity_schemes schemas_lazyresponses_lazyparameters_lazy headers_lazy examples_lazy _subsections_subsections_lazy)selfpluginsr%s K/var/www/html/test/engine/venv/lib/python3.12/site-packages/apispec/core.py__init__zComponents.__init__*s   .(* *,+-(* )+ 13-//102-/.0llll}}#44  ''++--'')) " c|jjDcic]+\}}|ik7r!t|jj||-c}}Scc}}wN)r1itemsr r%major)r3kvs r5to_dictzComponents.to_dictMsY))//1 1Bw "$"6"6"<"< =a @! C   s0AFlazycL|dur |jn |j|}|||<y)NF)r1r2)r3obj_type component_id componentr@ subsections r5_register_componentzComponents._register_componentTs1,05=d''d>T>T  $- < r7cn|j|}||vr"|j||j||<yyr9)r2popr1)r3rBrCcomponent_buffers r5_do_register_lazy_componentz&Components._do_register_lazy_componentasF  11(; + +8H8L8L9D  h ' 5 ,r7ct|tr|S|j||t||jj |S)aReturn object or reference If obj is a dict, it is assumed to be a complete description and it is returned as is. Otherwise, it is assumed to be a reference name as string and the corresponding $ref string is returned. :param str subsection: "schema", "parameter", "response" or "security_scheme" :param dict|str obj: object in dict form or as ref_id string ) isinstancedictrJrr%r;)r3rBobj_or_component_ids r5get_refzComponents.get_refmsG )4 0& & ((3FG d**002E  r7Nc :||jvrtd|dt|xsi}|jD]*} |j |j ||fi|xsi,|j||jd||||S#t $rY`wxYw)awAdd a new schema to the spec. :param str component_id: identifier by which schema may be referenced :param dict component: schema definition :param bool lazy: register component only when referenced in the spec :param kwargs: plugin-specific arguments .. note:: If you are using `apispec.ext.marshmallow`, you can pass fields' metadata as additional keyword arguments. For example, to add ``enum`` and ``description`` to your field: :: status = fields.String( required=True, metadata={ "description": "Status (open or closed)", "enum": ["open", "closed"], }, ) https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject zAnother schema with name "" is already registered.rr?) r&r rr$update schema_helperr _resolve_refs_in_schemarFr3rCrDr@kwargsretplugins r5rzComponents.schemas@ 4<< '-,\N:RS y!'Rmm F  /6// cLVLRPRS  $$S)   <4 H 3  s'B BBc 8||jvrtd|dt|xsi}|jD])} |j |j |fi|xsi+|j||jd||||S#t $rY_wxYw)aAdd a response which can be referenced. :param str component_id: ref_id to use as reference :param dict component: response fields :param bool lazy: register component only when referenced in the spec :param kwargs: plugin-specific arguments zAnother response with name "rQrr?) r'r rr$rRresponse_helperr _resolve_refs_in_responserFrUs r5rzComponents.responses 4>> )-.|nv>D"E  11#6   <4 H 3  r\cj||jvrtd|d|jd||||S)a]Add an example which can be referenced :param str component_id: identifier by which example may be referenced :param dict component: example fields :param bool lazy: register component only when referenced in the spec https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#exampleObject zAnother example with name "rQr"r?)r*r rF)r3rCrDr@s r5r"zComponents.examplesH 4== (--l^;ST    L)$ O r7cf||jvrtd|d|jd|||S)zAdd a security scheme which can be referenced. :param str component_id: component_id to use as reference :param dict component: security scheme fields z#Another security scheme with name "rQr#)r+r rF)r3rCrDs r5r#zComponents.security_scheme)sF 400 0-5l^C[\    !2L)L r7cfd|vr-|jd|d|d<|j|dyy)zpReplace schema reference as string with a $ref if needed Also resolve references in the schema rNrOrT)r3objs r5_resolve_schemazComponents._resolve_schema6s: s? LL3x=ACM  ( (X 7 r7c|jdijD]\}}|jd||d|<y)z/Replace example reference as string with a $refr*r"N)rr:rO)r3rlr^r"s r5_resolve_exampleszComponents._resolve_examples?sD WWZ4::< EMD'$(LLG$DC OD ! Er7cd|vr?|dD]7}|jd|d||d|<|j|d|9d|vr,|jd|d|d<|j|ddD]H}||vs||Dcgc]}|jd|c}||<||D]}|j|Jd|vr-|jd|d|d<|j|dyycc}w)N propertiesrr:)allOfoneOfanyOfnotrk)r3rkeysschs r5rTz"Components._resolve_refs_in_schemaDs- 6 !l+ H,0LLf\237-|$S),,VL-A#-FG  H f "ll8VG_EF7O  ( ( 9. 6Cf}BH+NQt||Ha8Ns !#;6C0056 6 F? LL6%=AF5M  ( ( 7 OsC3c|j||j||jdijD]}|j|yNcontent)rmrorvalues)r3parameter_or_header media_types r5rdz/Components._resolve_refs_in_parameter_or_headerWsS 01 23-11)R@GGI -J   , -r7cx|djD]$}|j||j|&yrz)r|rmro)r3 request_bodyr~s r5_resolve_refs_in_request_bodyz(Components._resolve_refs_in_request_body^s;&y188: /J   ,  " ": . /r7c|jjdkr|j|y|jdij D]$}|j||j |&|jdij D]4\}}|jd||d|<|j|d|6y)Nrr{r)r!) r%r;rmrr|ror:rOrd)r3rr~r^r!s r5r[z$Components._resolve_refs_in_responseds    % % )   *&ll9b9@@B 3 $$Z0&&z2 3!) Y ; A A C U f,0LL6,J#D)99(9:Md:ST Ur7c d|vrEg}|dD]6}|jd|}|j||j|8||d<d|vrO|djD]9}t |t s|jD]}|j |;d|vr|j|dd|vrKi}|djD]-\}}|jd|}|j||||</||d<yy)Nr(r callbacks requestBodyr'r) rOrdappendr|rLrMresolve_refs_in_pathrr:r[) r3 operationr(r callbackr`r'coders r5_resolve_refs_in_operationz%Components._resolve_refs_in_operationps1 9 $J&|4 -  LLi@ 99)D!!), -'1Il # ) #%k299; 8h- ( 1811$78 8 I %  . .y/G H ) #I"+K"8">">"@ +h<< H=..x8"* $ +&/Ik " $r7cd|vrEg}|dD]6}|jd|}|j||j|8||d<dD]}||vs|j||y)Nr(r )rrrrrrrr)rOrdrr)r3r`r(r methods r5rzComponents.resolve_refs_in_paths 4 J!,/ -  LLi@ 99)D!!), -",D   >F~//V = >r7)r4Sequence[BasePlugin]r%rreturnNone)rdict[str, dict]) rBstrrCrrDrMr@boolrr)rBrrCrrr)rBrrNz dict | strrrMr9) rCrrD dict | Noner@rrV typing.Anyrr) rCrrerrDrr@rrVrrr) rCrrDrMr@rrVrrr)rCrrDrMr@rrr)rCrrDrMrr)rr)rrMrr)__name__ __module__ __qualname____doc__r6r>rFrJrOrrr r!r"r#rmrorTrdrr[rrr7r5rr#s ! %! !!   ! F  - - - -  -  -       (    2"&-  ---  -  - -d"&       D"& %  %%% %  %% %X      BCH,0;? $ 8E 8&-/ U/.>r7rceZdZdZ d d dZd dZdddZddZ dddddd ddZ dd Z dd Z y)APISpecaOStores metadata that describes a RESTful API using the OpenAPI specification. :param str title: API title :param str version: API version :param list|tuple plugins: Plugin instances. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject :param str openapi_version: OpenAPI Specification version. Should be in the form '2.x' or '3.x.x' to comply with the OpenAPI standard. :param options: Optional top-level keys See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#openapi-object c `||_||_||_||_t ||_t |j cxkr tksntd|g|_ i|_ t|j|j |_ |jD]}|j|y)Nz$Not a valid OpenAPI version number: )titleversionrr4rr%MIN_INCLUSIVE_OPENAPI_VERSIONMAX_EXCLUSIVE_OPENAPI_VERSIONr_tags_pathsr components init_spec)r3rrr%r4rrXs r5r6zAPISpec.__init__s    &7 )## ,+ ,!EoEVWX X"$  %T\\43G3GHll #F   T " #r7c|j|j|jdd}|jr|j|d<|jj dkrBt |j|d<|j|jjn9t |j|d<|jj}|r||d<t||j}|S)N)rr)pathsinfotagsrswaggeropenapir) rrrrr%r;rrRrr>rr)r3rWcomponents_dicts r5r>zAPISpec.to_dicts[["jjT\\B&  ::**CK    % % ) !5!56C N JJt..0 1 !5!56C N"oo557O$3L!dll+ r7Nc<ddlm}||j|S)zRender the spec to YAML. Requires PyYAML to be installed. :param dict yaml_dump_kwargs: Additional keyword arguments to pass to `yaml.dump` r) dict_to_yaml) yaml_utilsrr>)r3yaml_dump_kwargsrs r5to_yamlzAPISpec.to_yamls -DLLN,<==r7c<|jj||S)zsStore information about a tag. :param dict tag: the dictionary storing information about the tag. )rr)r3tags r5rz APISpec.tags # r7) operationssummary descriptionr(c t|xsi}t|xsg}|jD]} |jd|||d|}||} |s t d|jD]} |j d||d||j ||jj||j||||j|d<|||j|d<|r#|j|}||j|d<|jj|j||S#t$rYwxYw#t$rYwxYw)aAdd a new path object to the spec. https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#path-item-object :param str|None path: URL path component :param dict|None operations: describes the http methods and options for `path` :param str summary: short summary relevant to all operations in this path :param str description: long description relevant to all operations in this path :param list|None parameters: list of parameters relevant to all operations in this path :param kwargs: parameters used by any path helpers see :meth:`register_path_helper` )r`rr(zPath template is not specified.)r`rrrr(r) rr4 path_helperr roperation_helper_clean_operationsrrbrR_clean_parametersrr) r3r`rrrr(rVrXrWs r5r`z APISpec.paths.j)/R j)/R ll F (f((*OU  @A All F '''STjSFS  z* tZ077 C  +2DKK i (  "/:DKK m , // ;J.8DKK l + ,,T[[->? 73  3  s#D3)E3 E?E EEc`t}|Dcgc]}t|ts|c}D]u}dDcgc] }||vs| }}|rtd|d|d|df}||vr!t dj |d|d|j ||ddk(sqd|d <w|Scc}wcc}w) aEnsure that all parameters with "in" equal to "path" are also required as required by the OpenAPI specification, as well as normalizing any references to global parameters and checking for duplicates parameters See https ://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject. :param list parameters: List of parameters mapping )r^r_z Missing keys z for parameterr^r_z0Duplicate parameter with name {} and location {}r`Tra)setrLrMr r formatadd)r3r(seenpr attr missing_attrs unique_keys r5rzAPISpec._clean_parameters)su%/G:a3F!G -I.<VdI@UTVMV+#M?.A $F+Yt_=JT!-FMM!&)9T? HHZ &((, *%+ -./HVsB&B& B+B+ct|}tt|jj}||z Dchc]}|j dr|}}|r)t dj dj||xsijD]^}d|vr|j|d|d<d|vs#i}|djD]\}} t|}| |t#|<!||d<`y cc}w#ttf$r=|jjdkr!|dk7rtjdt d YhwxYw) aEnsure that all parameters with "in" equal to "path" are also required as required by the OpenAPI specification, as well as normalizing any references to global parameters. Also checks for invalid HTTP methods. See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject. :param dict operations: Dict mapping status codes to operations zx-z(One or more HTTP methods are invalid: {}z, r(r'rdefaultz+Non-integer code not allowed in OpenAPI < 3r) stacklevelN)r VALID_METHODSr%r; startswithrrjoinr|rr:int TypeError ValueErrorwarningswarn UserWarningr) r3roperation_names valid_methodsrvinvalidrr'rrs r5rzAPISpec._clean_operationsOsfj/M$*>*>*D*DEF *]: #..QUBVC   :AA$))GBTU %*224 3Iy(*.*@*@l++ ,'i' &/ &<&B&B&D 4ND("4y,4Ic$i( 4*3 +&% 3 $&z2//559di>O$MM M ++,sC7C7 C<rrr`rrrr7r5rrs ")+ ### # & #  # #>$> ;48""&(,;;1 ;  ;  ;&;; ;z$$ $L(3#(3 (3r7r)r __future__rtypingrcollections.abcrcopyrpackaging.versionr exceptionsrr r r r utilsr rr TYPE_CHECKINGrXrVALID_METHODS_OPENAPI_V2VALID_METHODS_OPENAPI_V3rrrrrrr7r5rs)" $%FE "X3wi?,1IJ ' 'w>w>t Z3Z3r7