From 92038b69160a4684c4ad76c4502b5f66f187f164 Mon Sep 17 00:00:00 2001 From: Simone Orsi Date: Sat, 10 Oct 2026 09:49:51 +0200 Subject: [PATCH 1/2] [ADD] endpoint_openapi OpenAPI docs for configurable endpoints (any model using `endpoint.mixin`). * opt-in per endpoint, w/ description, tags and input/output JSON schemas (via `openapi.doc.mixin`) * one docs source per model (category) and route group (app), browsable from `/openapi/docs` (`openapi_doc_viewer`) --- endpoint_openapi/README.rst | 1 + endpoint_openapi/__init__.py | 1 + endpoint_openapi/__manifest__.py | 16 ++ endpoint_openapi/models/__init__.py | 2 + endpoint_openapi/models/endpoint_mixin.py | 24 +++ endpoint_openapi/models/ir_http.py | 67 +++++++++ endpoint_openapi/pyproject.toml | 3 + endpoint_openapi/readme/CONTRIBUTORS.md | 1 + endpoint_openapi/readme/DESCRIPTION.md | 8 + endpoint_openapi/readme/ROADMAP.md | 3 + endpoint_openapi/readme/USAGE.md | 18 +++ endpoint_openapi/static/description/icon.png | Bin 0 -> 9455 bytes endpoint_openapi/tests/__init__.py | 1 + endpoint_openapi/tests/test_docs.py | 146 +++++++++++++++++++ endpoint_openapi/views/endpoint_view.xml | 33 +++++ 15 files changed, 324 insertions(+) create mode 100644 endpoint_openapi/README.rst create mode 100644 endpoint_openapi/__init__.py create mode 100644 endpoint_openapi/__manifest__.py create mode 100644 endpoint_openapi/models/__init__.py create mode 100644 endpoint_openapi/models/endpoint_mixin.py create mode 100644 endpoint_openapi/models/ir_http.py create mode 100644 endpoint_openapi/pyproject.toml create mode 100644 endpoint_openapi/readme/CONTRIBUTORS.md create mode 100644 endpoint_openapi/readme/DESCRIPTION.md create mode 100644 endpoint_openapi/readme/ROADMAP.md create mode 100644 endpoint_openapi/readme/USAGE.md create mode 100644 endpoint_openapi/static/description/icon.png create mode 100644 endpoint_openapi/tests/__init__.py create mode 100644 endpoint_openapi/tests/test_docs.py create mode 100644 endpoint_openapi/views/endpoint_view.xml diff --git a/endpoint_openapi/README.rst b/endpoint_openapi/README.rst new file mode 100644 index 00000000..b6790cf4 --- /dev/null +++ b/endpoint_openapi/README.rst @@ -0,0 +1 @@ +waiting the bot :) diff --git a/endpoint_openapi/__init__.py b/endpoint_openapi/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/endpoint_openapi/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/endpoint_openapi/__manifest__.py b/endpoint_openapi/__manifest__.py new file mode 100644 index 00000000..40c4d66b --- /dev/null +++ b/endpoint_openapi/__manifest__.py @@ -0,0 +1,16 @@ +# Copyright 2026 Camptocamp SA +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +{ + "name": "Endpoint OpenAPI", + "summary": "OpenAPI docs for configurable endpoints.", + "version": "18.0.1.0.0", + "license": "LGPL-3", + "development_status": "Alpha", + "author": "Camptocamp,Odoo Community Association (OCA)", + "maintainers": ["simahawk"], + "website": "https://github.com/OCA/web-api", + "depends": ["endpoint", "openapi_doc_viewer"], + "data": ["views/endpoint_view.xml"], + "auto_install": True, +} diff --git a/endpoint_openapi/models/__init__.py b/endpoint_openapi/models/__init__.py new file mode 100644 index 00000000..6bb67b88 --- /dev/null +++ b/endpoint_openapi/models/__init__.py @@ -0,0 +1,2 @@ +from . import endpoint_mixin +from . import ir_http diff --git a/endpoint_openapi/models/endpoint_mixin.py b/endpoint_openapi/models/endpoint_mixin.py new file mode 100644 index 00000000..3cec299f --- /dev/null +++ b/endpoint_openapi/models/endpoint_mixin.py @@ -0,0 +1,24 @@ +# Copyright 2026 Camptocamp SA +# @author: Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from odoo import models + + +class EndpointMixin(models.AbstractModel): + """Describe endpoints for OpenAPI docs via `openapi.doc.mixin`.""" + + _name = "endpoint.mixin" + _inherit = ["endpoint.mixin", "openapi.doc.mixin"] + + def _openapi_route_info(self): + """Use the routing of the endpoint (route, method, auth).""" + route, routing, __ = self._get_routing_info() + return route, routing + + def _openapi_api_doc(self): + """Use the request content type of the endpoint for the request body.""" + api_doc = super()._openapi_api_doc() + if self.request_content_type: + api_doc["content_type"] = self.request_content_type + return api_doc diff --git a/endpoint_openapi/models/ir_http.py b/endpoint_openapi/models/ir_http.py new file mode 100644 index 00000000..015ea1d0 --- /dev/null +++ b/endpoint_openapi/models/ir_http.py @@ -0,0 +1,67 @@ +# Copyright 2026 Camptocamp SA +# @author: Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import functools + +from odoo import models + +from odoo.addons.openapi_doc_base.sources import DocSource + +NO_GROUP = "default" + + +class IrHttp(models.AbstractModel): + """One docs source per endpoint model and route group.""" + + _inherit = "ir.http" + + def _openapi_endpoint_models(self): + """Concrete models using `endpoint.mixin` (eg: `edi.endpoint`).""" + names = self.env.registry.descendants(["endpoint.mixin"], "_inherit") + return [n for n in sorted(names) if not self.env[n]._abstract] + + def _openapi_doc_sources(self): + """Add a source per model (category) and route group (app).""" + sources = super()._openapi_doc_sources() + for model_name in self._openapi_endpoint_models(): + model = self.env[model_name].sudo() + groups = model.search(model._openapi_documented_domain()).mapped( + lambda r: r.route_group or NO_GROUP + ) + for group in sorted(set(groups)): + sources.append( + DocSource( + key=f"{model_name}.{group}", + title=f"{model._description}: {group}", + build=functools.partial( + self._openapi_build_endpoint_doc, model_name, group + ), + category=model_name, + app=group, + ) + ) + return sources + + def _openapi_build_endpoint_doc(self, model_name, group, env): + """Build the document of the endpoints of a model and route group.""" + model = env[model_name].sudo() + domain = model._openapi_documented_domain() + if group == NO_GROUP: + domain.append(("route_group", "in", (False, ""))) + else: + domain.append(("route_group", "=", group)) + records = model.search(domain, order="route") + return records._openapi_build_doc(title=f"{model._description}: {group}") + + def _openapi_doc_category_label(self, category): + """Show the description of endpoint models (eg: `Endpoint`).""" + if category in self._openapi_endpoint_models(): + return self.env[category]._description + return super()._openapi_doc_category_label(category) + + def _openapi_security_scheme(self, auth): + """Endpoints use `user_endpoint` for session based auth.""" + if auth == "user_endpoint": + auth = "user" + return super()._openapi_security_scheme(auth) diff --git a/endpoint_openapi/pyproject.toml b/endpoint_openapi/pyproject.toml new file mode 100644 index 00000000..4231d0cc --- /dev/null +++ b/endpoint_openapi/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/endpoint_openapi/readme/CONTRIBUTORS.md b/endpoint_openapi/readme/CONTRIBUTORS.md new file mode 100644 index 00000000..2b66303a --- /dev/null +++ b/endpoint_openapi/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Simone Orsi \<\> diff --git a/endpoint_openapi/readme/DESCRIPTION.md b/endpoint_openapi/readme/DESCRIPTION.md new file mode 100644 index 00000000..1942f8e7 --- /dev/null +++ b/endpoint_openapi/readme/DESCRIPTION.md @@ -0,0 +1,8 @@ +Document configurable endpoints (`endpoint.endpoint` and any model using +`endpoint.mixin`, eg: `edi.endpoint`) with OpenAPI and browse them with Swagger UI. + +Endpoints are documented only when enabled on the record: +they might be meant for internal use only. + +Technically, it plugs `endpoint.mixin` into `openapi.doc.mixin` (from `openapi_doc_base`) +and registers one docs source per model and route group. diff --git a/endpoint_openapi/readme/ROADMAP.md b/endpoint_openapi/readme/ROADMAP.md new file mode 100644 index 00000000..667c526f --- /dev/null +++ b/endpoint_openapi/readme/ROADMAP.md @@ -0,0 +1,3 @@ +- Show the API docs fields on the specific views of other models + using `endpoint.mixin` (eg: `edi.endpoint`), if they don't inherit the mixin view. +- Generate schemas from the code of the endpoint, when possible. diff --git a/endpoint_openapi/readme/USAGE.md b/endpoint_openapi/readme/USAGE.md new file mode 100644 index 00000000..52b0ab07 --- /dev/null +++ b/endpoint_openapi/readme/USAGE.md @@ -0,0 +1,18 @@ +On the endpoint form, open the *API docs* tab: + +- enable *Show in API docs* +- optionally add a description, tags, and the JSON schemas of the input + (params or body) and of the output (response) + +Then open *Settings > Technical > API docs* (`/openapi/docs`, from `openapi_doc_viewer`): + +- one document per model (category) and route group (app) +- use the links at the top to filter by model and route group +- docs are visible to the *API docs: viewer* group. To restrict endpoint docs further, + extend `ir.http._openapi_doc_category_groups` for the model (category) + +Each document is also available as JSON at +`/openapi/docs/..json`. + +The request content type of the endpoint is used for the request body, +the auth type for the security scheme. diff --git a/endpoint_openapi/static/description/icon.png b/endpoint_openapi/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..3a0328b516c4980e8e44cdb63fd945757ddd132d GIT binary patch literal 9455 zcmW++2RxMjAAjx~&dlBk9S+%}OXg)AGE&Cb*&}d0jUxM@u(PQx^-s)697TX`ehR4?GS^qbkof1cslKgkU)h65qZ9Oc=ml_0temigYLJfnz{IDzUf>bGs4N!v3=Z3jMq&A#7%rM5eQ#dc?k~! zVpnB`o+K7|Al`Q_U;eD$B zfJtP*jH`siUq~{KE)`jP2|#TUEFGRryE2`i0**z#*^6~AI|YzIWy$Cu#CSLW3q=GA z6`?GZymC;dCPk~rBS%eCb`5OLr;RUZ;D`}um=H)BfVIq%7VhiMr)_#G0N#zrNH|__ zc+blN2UAB0=617@>_u;MPHN;P;N#YoE=)R#i$k_`UAA>WWCcEVMh~L_ zj--gtp&|K1#58Yz*AHCTMziU1Jzt_jG0I@qAOHsk$2}yTmVkBp_eHuY$A9)>P6o~I z%aQ?!(GqeQ-Y+b0I(m9pwgi(IIZZzsbMv+9w{PFtd_<_(LA~0H(xz{=FhLB@(1&qHA5EJw1>>=%q2f&^X>IQ{!GJ4e9U z&KlB)z(84HmNgm2hg2C0>WM{E(DdPr+EeU_N@57;PC2&DmGFW_9kP&%?X4}+xWi)( z;)z%wI5>D4a*5XwD)P--sPkoY(a~WBw;E~AW`Yue4kFa^LM3X`8x|}ZUeMnqr}>kH zG%WWW>3ml$Yez?i%)2pbKPI7?5o?hydokgQyZsNEr{a|mLdt;X2TX(#B1j35xPnPW z*bMSSOauW>o;*=kO8ojw91VX!qoOQb)zHJ!odWB}d+*K?#sY_jqPdg{Sm2HdYzdEx zOGVPhVRTGPtv0o}RfVP;Nd(|CB)I;*t&QO8h zFfekr30S!-LHmV_Su-W+rEwYXJ^;6&3|L$mMC8*bQptyOo9;>Qb9Q9`ySe3%V$A*9 zeKEe+b0{#KWGp$F+tga)0RtI)nhMa-K@JS}2krK~n8vJ=Ngm?R!9G<~RyuU0d?nz# z-5EK$o(!F?hmX*2Yt6+coY`6jGbb7tF#6nHA zuKk=GGJ;ZwON1iAfG$E#Y7MnZVmrY|j0eVI(DN_MNFJmyZ|;w4tf@=CCDZ#5N_0K= z$;R~bbk?}TpfDjfB&aiQ$VA}s?P}xPERJG{kxk5~R`iRS(SK5d+Xs9swCozZISbnS zk!)I0>t=A<-^z(cmSFz3=jZ23u13X><0b)P)^1T_))Kr`e!-pb#q&J*Q`p+B6la%C zuVl&0duN<;uOsB3%T9Fp8t{ED108<+W(nOZd?gDnfNBC3>M8WE61$So|P zVvqH0SNtDTcsUdzaMDpT=Ty0pDHHNL@Z0w$Y`XO z2M-_r1S+GaH%pz#Uy0*w$Vdl=X=rQXEzO}d6J^R6zjM1u&c9vYLvLp?W7w(?np9x1 zE_0JSAJCPB%i7p*Wvg)pn5T`8k3-uR?*NT|J`eS#_#54p>!p(mLDvmc-3o0mX*mp_ zN*AeS<>#^-{S%W<*mz^!X$w_2dHWpcJ6^j64qFBft-o}o_Vx80o0>}Du;>kLts;$8 zC`7q$QI(dKYG`Wa8#wl@V4jVWBRGQ@1dr-hstpQL)Tl+aqVpGpbSfN>5i&QMXfiZ> zaA?T1VGe?rpQ@;+pkrVdd{klI&jVS@I5_iz!=UMpTsa~mBga?1r}aRBm1WS;TT*s0f0lY=JBl66Upy)-k4J}lh=P^8(SXk~0xW=T9v*B|gzIhN z>qsO7dFd~mgxAy4V?&)=5ieYq?zi?ZEoj)&2o)RLy=@hbCRcfT5jigwtQGE{L*8<@Yd{zg;CsL5mvzfDY}P-wos_6PfprFVaeqNE%h zKZhLtcQld;ZD+>=nqN~>GvROfueSzJD&BE*}XfU|H&(FssBqY=hPCt`d zH?@s2>I(|;fcW&YM6#V#!kUIP8$Nkdh0A(bEVj``-AAyYgwY~jB zT|I7Bf@%;7aL7Wf4dZ%VqF$eiaC38OV6oy3Z#TER2G+fOCd9Iaoy6aLYbPTN{XRPz z;U!V|vBf%H!}52L2gH_+j;`bTcQRXB+y9onc^wLm5wi3-Be}U>k_u>2Eg$=k!(l@I zcCg+flakT2Nej3i0yn+g+}%NYb?ta;R?(g5SnwsQ49U8Wng8d|{B+lyRcEDvR3+`O{zfmrmvFrL6acVP%yG98X zo&+VBg@px@i)%o?dG(`T;n*$S5*rnyiR#=wW}}GsAcfyQpE|>a{=$Hjg=-*_K;UtD z#z-)AXwSRY?OPefw^iI+ z)AXz#PfEjlwTes|_{sB?4(O@fg0AJ^g8gP}ex9Ucf*@_^J(s_5jJV}c)s$`Myn|Kd z$6>}#q^n{4vN@+Os$m7KV+`}c%4)4pv@06af4-x5#wj!KKb%caK{A&Y#Rfs z-po?Dcb1({W=6FKIUirH&(yg=*6aLCekcKwyfK^JN5{wcA3nhO(o}SK#!CINhI`-I z1)6&n7O&ZmyFMuNwvEic#IiOAwNkR=u5it{B9n2sAJV5pNhar=j5`*N!Na;c7g!l$ z3aYBqUkqqTJ=Re-;)s!EOeij=7SQZ3Hq}ZRds%IM*PtM$wV z@;rlc*NRK7i3y5BETSKuumEN`Xu_8GP1Ri=OKQ$@I^ko8>H6)4rjiG5{VBM>B|%`&&s^)jS|-_95&yc=GqjNo{zFkw%%HHhS~e=s zD#sfS+-?*t|J!+ozP6KvtOl!R)@@-z24}`9{QaVLD^9VCSR2b`b!KC#o;Ki<+wXB6 zx3&O0LOWcg4&rv4QG0)4yb}7BFSEg~=IR5#ZRj8kg}dS7_V&^%#Do==#`u zpy6{ox?jWuR(;pg+f@mT>#HGWHAJRRDDDv~@(IDw&R>9643kK#HN`!1vBJHnC+RM&yIh8{gG2q zA%e*U3|N0XSRa~oX-3EAneep)@{h2vvd3Xvy$7og(sayr@95+e6~Xvi1tUqnIxoIH zVWo*OwYElb#uyW{Imam6f2rGbjR!Y3`#gPqkv57dB6K^wRGxc9B(t|aYDGS=m$&S!NmCtrMMaUg(c zc2qC=2Z`EEFMW-me5B)24AqF*bV5Dr-M5ig(l-WPS%CgaPzs6p_gnCIvTJ=Y<6!gT zVt@AfYCzjjsMEGi=rDQHo0yc;HqoRNnNFeWZgcm?f;cp(6CNylj36DoL(?TS7eU#+ z7&mfr#y))+CJOXQKUMZ7QIdS9@#-}7y2K1{8)cCt0~-X0O!O?Qx#E4Og+;A2SjalQ zs7r?qn0H044=sDN$SRG$arw~n=+T_DNdSrarmu)V6@|?1-ZB#hRn`uilTGPJ@fqEy zGt(f0B+^JDP&f=r{#Y_wi#AVDf-y!RIXU^0jXsFpf>=Ji*TeqSY!H~AMbJdCGLhC) zn7Rx+sXw6uYj;WRYrLd^5IZq@6JI1C^YkgnedZEYy<&4(z%Q$5yv#Boo{AH8n$a zhb4Y3PWdr269&?V%uI$xMcUrMzl=;w<_nm*qr=c3Rl@i5wWB;e-`t7D&c-mcQl7x! zZWB`UGcw=Y2=}~wzrfLx=uet<;m3~=8I~ZRuzvMQUQdr+yTV|ATf1Uuomr__nDf=X zZ3WYJtHp_ri(}SQAPjv+Y+0=fH4krOP@S&=zZ-t1jW1o@}z;xk8 z(Nz1co&El^HK^NrhVHa-_;&88vTU>_J33=%{if;BEY*J#1n59=07jrGQ#IP>@u#3A z;!q+E1Rj3ZJ+!4bq9F8PXJ@yMgZL;>&gYA0%_Kbi8?S=XGM~dnQZQ!yBSgcZhY96H zrWnU;k)qy`rX&&xlDyA%(a1Hhi5CWkmg(`Gb%m(HKi-7Z!LKGRP_B8@`7&hdDy5n= z`OIxqxiVfX@OX1p(mQu>0Ai*v_cTMiw4qRt3~NBvr9oBy0)r>w3p~V0SCm=An6@3n)>@z!|o-$HvDK z|3D2ZMJkLE5loMKl6R^ez@Zz%S$&mbeoqH5`Bb){Ei21q&VP)hWS2tjShfFtGE+$z zzCR$P#uktu+#!w)cX!lWN1XU%K-r=s{|j?)Akf@q#3b#{6cZCuJ~gCxuMXRmI$nGtnH+-h z+GEi!*X=AP<|fG`1>MBdTb?28JYc=fGvAi2I<$B(rs$;eoJCyR6_bc~p!XR@O-+sD z=eH`-ye})I5ic1eL~TDmtfJ|8`0VJ*Yr=hNCd)G1p2MMz4C3^Mj?7;!w|Ly%JqmuW zlIEW^Ft%z?*|fpXda>Jr^1noFZEwFgVV%|*XhH@acv8rdGxeEX{M$(vG{Zw+x(ei@ zmfXb22}8-?Fi`vo-YVrTH*C?a8%M=Hv9MqVH7H^J$KsD?>!SFZ;ZsvnHr_gn=7acz z#W?0eCdVhVMWN12VV^$>WlQ?f;P^{(&pYTops|btm6aj>_Uz+hqpGwB)vWp0Cf5y< zft8-je~nn?W11plq}N)4A{l8I7$!ks_x$PXW-2XaRFswX_BnF{R#6YIwMhAgd5F9X zGmwdadS6(a^fjHtXg8=l?Rc0Sm%hk6E9!5cLVloEy4eh(=FwgP`)~I^5~pBEWo+F6 zSf2ncyMurJN91#cJTy_u8Y}@%!bq1RkGC~-bV@SXRd4F{R-*V`bS+6;W5vZ(&+I<9$;-V|eNfLa5n-6% z2(}&uGRF;p92eS*sE*oR$@pexaqr*meB)VhmIg@h{uzkk$9~qh#cHhw#>O%)b@+(| z^IQgqzuj~Sk(J;swEM-3TrJAPCq9k^^^`q{IItKBRXYe}e0Tdr=Huf7da3$l4PdpwWDop%^}n;dD#K4s#DYA8SHZ z&1!riV4W4R7R#C))JH1~axJ)RYnM$$lIR%6fIVA@zV{XVyx}C+a-Dt8Y9M)^KU0+H zR4IUb2CJ{Hg>CuaXtD50jB(_Tcx=Z$^WYu2u5kubqmwp%drJ6 z?Fo40g!Qd<-l=TQxqHEOuPX0;^z7iX?Ke^a%XT<13TA^5`4Xcw6D@Ur&VT&CUe0d} z1GjOVF1^L@>O)l@?bD~$wzgf(nxX1OGD8fEV?TdJcZc2KoUe|oP1#=$$7ee|xbY)A zDZq+cuTpc(fFdj^=!;{k03C69lMQ(|>uhRfRu%+!k&YOi-3|1QKB z z?n?eq1XP>p-IM$Z^C;2L3itnbJZAip*Zo0aw2bs8@(s^~*8T9go!%dHcAz2lM;`yp zD=7&xjFV$S&5uDaiScyD?B-i1ze`+CoRtz`Wn+Zl&#s4&}MO{@N!ufrzjG$B79)Y2d3tBk&)TxUTw@QS0TEL_?njX|@vq?Uz(nBFK5Pq7*xj#u*R&i|?7+6# z+|r_n#SW&LXhtheZdah{ZVoqwyT{D>MC3nkFF#N)xLi{p7J1jXlmVeb;cP5?e(=f# zuT7fvjSbjS781v?7{)-X3*?>tq?)Yd)~|1{BDS(pqC zC}~H#WXlkUW*H5CDOo<)#x7%RY)A;ShGhI5s*#cRDA8YgqG(HeKDx+#(ZQ?386dv! zlXCO)w91~Vw4AmOcATuV653fa9R$fyK8ul%rG z-wfS zihugoZyr38Im?Zuh6@RcF~t1anQu7>#lPpb#}4cOA!EM11`%f*07RqOVkmX{p~KJ9 z^zP;K#|)$`^Rb{rnHGH{~>1(fawV0*Z#)}M`m8-?ZJV<+e}s9wE# z)l&az?w^5{)`S(%MRzxdNqrs1n*-=jS^_jqE*5XDrA0+VE`5^*p3CuM<&dZEeCjoz zR;uu_H9ZPZV|fQq`Cyw4nscrVwi!fE6ciMmX$!_hN7uF;jjKG)d2@aC4ropY)8etW=xJvni)8eHi`H$%#zn^WJ5NLc-rqk|u&&4Z6fD_m&JfSI1Bvb?b<*n&sfl0^t z=HnmRl`XrFvMKB%9}>PaA`m-fK6a0(8=qPkWS5bb4=v?XcWi&hRY?O5HdulRi4?fN zlsJ*N-0Qw+Yic@s0(2uy%F@ib;GjXt01Fmx5XbRo6+n|pP(&nodMoap^z{~q ziEeaUT@Mxe3vJSfI6?uLND(CNr=#^W<1b}jzW58bIfyWTDle$mmS(|x-0|2UlX+9k zQ^EX7Nw}?EzVoBfT(-LT|=9N@^hcn-_p&sqG z&*oVs2JSU+N4ZD`FhCAWaS;>|wH2G*Id|?pa#@>tyxX`+4HyIArWDvVrX)2WAOQff z0qyHu&-S@i^MS-+j--!pr4fPBj~_8({~e1bfcl0wI1kaoN>mJL6KUPQm5N7lB(ui1 zE-o%kq)&djzWJ}ob<-GfDlkB;F31j-VHKvQUGQ3sp`CwyGJk_i!y^sD0fqC@$9|jO zOqN!r!8-p==F@ZVP=U$qSpY(gQ0)59P1&t@y?5rvg<}E+GB}26NYPp4f2YFQrQtot5mn3wu_qprZ=>Ig-$ zbW26Ws~IgY>}^5w`vTB(G`PTZaDiGBo5o(tp)qli|NeV( z@H_=R8V39rt5J5YB2Ky?4eJJ#b`_iBe2ot~6%7mLt5t8Vwi^Jy7|jWXqa3amOIoRb zOr}WVFP--DsS`1WpN%~)t3R!arKF^Q$e12KEqU36AWwnCBICpH4XCsfnyrHr>$I$4 z!DpKX$OKLWarN7nv@!uIA+~RNO)l$$w}p(;b>mx8pwYvu;dD_unryX_NhT8*Tj>BTrTTL&!?O+%Rv;b?B??gSzdp?6Uug9{ zd@V08Z$BdI?fpoCS$)t4mg4rT8Q_I}h`0d-vYZ^|dOB*Q^S|xqTV*vIg?@fVFSmMpaw0qtTRbx} z({Pg?#{2`sc9)M5N$*N|4;^t$+QP?#mov zGVC@I*lBVrOU-%2y!7%)fAKjpEFsgQc4{amtiHb95KQEwvf<(3T<9-Zm$xIew#P22 zc2Ix|App^>v6(3L_MCU0d3W##AB0M~3D00EWoKZqsJYT(#@w$Y_H7G22M~ApVFTRHMI_3be)Lkn#0F*V8Pq zc}`Cjy$bE;FJ6H7p=0y#R>`}-m4(0F>%@P|?7fx{=R^uFdISRnZ2W_xQhD{YuR3t< z{6yxu=4~JkeA;|(J6_nv#>Nvs&FuLA&PW^he@t(UwFFE8)|a!R{`E`K`i^ZnyE4$k z;(749Ix|oi$c3QbEJ3b~D_kQsPz~fIUKym($a_7dJ?o+40*OLl^{=&oq$<#Q(yyrp z{J-FAniyAw9tPbe&IhQ|a`DqFTVQGQ&Gq3!C2==4x{6EJwiPZ8zub-iXoUtkJiG{} zPaR&}_fn8_z~(=;5lD-aPWD3z8PZS@AaUiomF!G8I}Mf>e~0g#BelA-5#`cj;O5>N Xviia!U7SGha1wx#SCgwmn*{w2TRX*I literal 0 HcmV?d00001 diff --git a/endpoint_openapi/tests/__init__.py b/endpoint_openapi/tests/__init__.py new file mode 100644 index 00000000..603389eb --- /dev/null +++ b/endpoint_openapi/tests/__init__.py @@ -0,0 +1 @@ +from . import test_docs diff --git a/endpoint_openapi/tests/test_docs.py b/endpoint_openapi/tests/test_docs.py new file mode 100644 index 00000000..f0d8f2ea --- /dev/null +++ b/endpoint_openapi/tests/test_docs.py @@ -0,0 +1,146 @@ +# Copyright 2026 Camptocamp SA +# @author: Simone Orsi +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import json + +from odoo import exceptions +from odoo.tests.common import HttpCase, new_test_user, tagged + +SCHEMA = { + "type": "object", + "required": ["ref"], + "properties": {"ref": {"type": "string"}}, +} + + +class CommonDocs: + @classmethod + def _create_endpoints(cls): + model = cls.env["endpoint.endpoint"] + common = {"exec_mode": "code", "code_snippet": "result = {}"} + cls.ep_import = model.create( + dict( + common, + name="Import orders", + route="/test_doc/orders", + request_method="POST", + request_content_type="application/xml", + route_group="orders", + api_doc_enabled=True, + api_doc_description="Import orders from XML.", + api_doc_tags="orders, import", + api_doc_input_schema=json.dumps(SCHEMA), + ) + ) + cls.ep_status = model.create( + dict( + common, + name="Order status", + route="/test_doc/status", + request_method="GET", + route_group="orders", + api_doc_enabled=True, + api_doc_output_schema=json.dumps(SCHEMA), + ) + ) + cls.ep_hidden = model.create( + dict( + common, + name="Internal", + route="/test_doc/internal", + request_method="GET", + route_group="orders", + ) + ) + cls.ep_other = model.create( + dict( + common, + name="Ping", + route="/test_doc/ping", + request_method="GET", + auth_type="public", + exec_as_user_id=cls.env.ref("base.user_admin").id, + api_doc_enabled=True, + ) + ) + + +@tagged("-at_install", "post_install") +class TestDocs(HttpCase, CommonDocs): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls._create_endpoints() + cls.ir_http = cls.env["ir.http"] + new_test_user( + cls.env, + login="doc_user", + password="doc_user", + groups="base.group_user,openapi_doc_base.group_openapi_doc_viewer", + ) + + def test_sources(self): + """There is one source per model and route group (`default` if none).""" + sources = self.ir_http._openapi_doc_sources_for(category="endpoint.endpoint") + self.assertEqual( + [(s.key, s.app) for s in sources], + [ + ("endpoint.endpoint.default", "default"), + ("endpoint.endpoint.orders", "orders"), + ], + ) + + def test_document(self): + """A group's document lists the enabled endpoints w/ schemas, auth and tags.""" + doc = self.ir_http._openapi_doc("endpoint.endpoint.orders") + self.assertEqual(sorted(doc["paths"]), ["/test_doc/orders", "/test_doc/status"]) + post = doc["paths"]["/test_doc/orders"]["post"] + self.assertEqual(post["summary"], "Import orders") + self.assertEqual(post["description"], "Import orders from XML.") + self.assertEqual(post["tags"], ["orders", "import"]) + self.assertEqual( + post["requestBody"]["content"]["application/xml"]["schema"], SCHEMA + ) + self.assertEqual(post["security"], [{"odooSession": []}]) + get = doc["paths"]["/test_doc/status"]["get"] + self.assertEqual( + get["responses"]["200"]["content"]["application/json"]["schema"], SCHEMA + ) + doc = self.ir_http._openapi_doc("endpoint.endpoint.default") + op = doc["paths"]["/test_doc/ping"]["get"] + self.assertNotIn("security", op) + + def test_doc_refreshed(self): + """Disabling the docs of an endpoint removes it from its document.""" + self.assertIn( + "/test_doc/status", + self.ir_http._openapi_doc("endpoint.endpoint.orders")["paths"], + ) + self.ep_status.api_doc_enabled = False + self.assertNotIn( + "/test_doc/status", + self.ir_http._openapi_doc("endpoint.endpoint.orders")["paths"], + ) + + def test_schema_validation(self): + """Invalid schemas (not JSON objects) are refused.""" + with self.assertRaises(exceptions.ValidationError): + self.ep_status.api_doc_output_schema = "[1, 2]" + with self.assertRaises(exceptions.ValidationError): + self.ep_status.api_doc_output_schema = "{nope" + + def test_http(self): + """Viewers get the endpoint docs; internal users w/o the group get a 404.""" + self.authenticate("doc_user", "doc_user") + response = self.url_open("/openapi/docs?category=endpoint.endpoint") + self.assertEqual(response.status_code, 200) + self.assertIn("/openapi/docs/endpoint.endpoint.orders.json", response.text) + self.assertIn("app=orders", response.text) + response = self.url_open("/openapi/docs/endpoint.endpoint.orders.json") + self.assertIn("/test_doc/orders", response.json()["paths"]) + # Internal users w/o the viewer group can't see the docs + new_test_user(self.env, login="internal", password="internal") + self.authenticate("internal", "internal") + response = self.url_open("/openapi/docs/endpoint.endpoint.orders.json") + self.assertEqual(response.status_code, 404) diff --git a/endpoint_openapi/views/endpoint_view.xml b/endpoint_openapi/views/endpoint_view.xml new file mode 100644 index 00000000..2fe323b2 --- /dev/null +++ b/endpoint_openapi/views/endpoint_view.xml @@ -0,0 +1,33 @@ + + + + + endpoint.mixin.form.openapi + endpoint.mixin + + + + + + + + + + + + + + Open API docs + + + + + From 5e442fa17175138380618b7a260a183ffc728f86 Mon Sep 17 00:00:00 2001 From: Simone Orsi Date: Fri, 16 Oct 2026 16:36:02 +0200 Subject: [PATCH 2/2] [DO NOT MERGE] test-requirements.txt: OCA/web-api#183, OCA/web-api#181 Pending OCA/web-api#183 (openapi_doc_viewer) and OCA/web-api#181 (openapi_doc_base). To be removed once merged. --- test-requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 test-requirements.txt diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 00000000..37f81614 --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,2 @@ +odoo-addon-openapi_doc_viewer @ git+https://github.com/OCA/web-api.git@refs/pull/183/head#subdirectory=openapi_doc_viewer +odoo-addon-openapi_doc_base @ git+https://github.com/OCA/web-api.git@refs/pull/181/head#subdirectory=openapi_doc_base