From 0df45fb7165aad238e9972772514ad4289e1612c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Mon, 19 Nov 2018 12:14:38 +0100 Subject: [PATCH 01/37] [ADD] graphql_base and graphql_demo --- graphql_base/README.rst | 1 + graphql_base/__init__.py | 5 + graphql_base/__manifest__.py | 15 +++ graphql_base/controllers/__init__.py | 1 + graphql_base/controllers/main.py | 84 +++++++++++++ graphql_base/i18n/graphql_base.pot | 14 +++ graphql_base/readme/DESCRIPTION.rst | 6 + graphql_base/readme/USAGE.rst | 11 ++ graphql_base/static/description/icon.png | Bin 0 -> 9455 bytes graphql_base/types.py | 43 +++++++ graphql_base/views/graphiql.xml | 153 +++++++++++++++++++++++ 11 files changed, 333 insertions(+) create mode 100644 graphql_base/README.rst create mode 100644 graphql_base/__init__.py create mode 100644 graphql_base/__manifest__.py create mode 100644 graphql_base/controllers/__init__.py create mode 100644 graphql_base/controllers/main.py create mode 100644 graphql_base/i18n/graphql_base.pot create mode 100644 graphql_base/readme/DESCRIPTION.rst create mode 100644 graphql_base/readme/USAGE.rst create mode 100644 graphql_base/static/description/icon.png create mode 100644 graphql_base/types.py create mode 100644 graphql_base/views/graphiql.xml diff --git a/graphql_base/README.rst b/graphql_base/README.rst new file mode 100644 index 000000000..6fbbfb500 --- /dev/null +++ b/graphql_base/README.rst @@ -0,0 +1 @@ +this file will be generated after merging diff --git a/graphql_base/__init__.py b/graphql_base/__init__.py new file mode 100644 index 000000000..e08d6dbc3 --- /dev/null +++ b/graphql_base/__init__.py @@ -0,0 +1,5 @@ +# Copyright 2018 ACSONE SA/NV +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +from .controllers import GraphQLControllerMixin +from .types import OdooObjectType diff --git a/graphql_base/__manifest__.py b/graphql_base/__manifest__.py new file mode 100644 index 000000000..5c7a028ca --- /dev/null +++ b/graphql_base/__manifest__.py @@ -0,0 +1,15 @@ +# Copyright 2018 ACSONE SA/NV +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +{ + "name": "Graphql Base", + "summary": """ + Base GraphQL/GraphiQL controller""", + "version": "12.0.1.0.0", + "license": "LGPL-3", + "author": "ACSONE SA/NV,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/rest-framework", + "depends": ["base"], + "data": ["views/graphiql.xml"], + "external_dependencies": {"python": ["graphene", "graphql_server"]}, +} diff --git a/graphql_base/controllers/__init__.py b/graphql_base/controllers/__init__.py new file mode 100644 index 000000000..f38bb6f8e --- /dev/null +++ b/graphql_base/controllers/__init__.py @@ -0,0 +1 @@ +from .main import GraphQLControllerMixin diff --git a/graphql_base/controllers/main.py b/graphql_base/controllers/main.py new file mode 100644 index 000000000..af11b96c5 --- /dev/null +++ b/graphql_base/controllers/main.py @@ -0,0 +1,84 @@ +# Copyright 2018 ACSONE SA/NV +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import re +from functools import partial + +from graphql_server import ( + default_format_error, + encode_execution_results, + json_encode, + load_json_body, + run_http_query, +) + +from odoo import http + + +class GraphQLControllerMixin(object): + @staticmethod + def patch_for_json(path_re): + # this is to avoid Odoo, which assumes json always means json+rpc, + # complaining about "function declared as capable of handling request + # of type 'http' but called with a request of type 'json'" + path_re = re.compile(path_re) + orig_get_request = http.Root.get_request + + def get_request(self, httprequest): + if path_re.match(httprequest.path): + return http.HttpRequest(httprequest) + return orig_get_request(self, httprequest) + + http.Root.get_request = get_request + + def _parse_body(self): + req = http.request.httprequest + # We use mimetype here since we don't need the other + # information provided by content_type + content_type = req.mimetype + if content_type == "application/graphql": + return {"query": req.data.decode("utf8")} + elif content_type == "application/json": + return load_json_body(req.data.decode("utf8")) + elif content_type in ( + "application/x-www-form-urlencoded", + "multipart/form-data", + ): + return http.request.params + return {} + + def _process_request(self, schema, data, catch): + request = http.request.httprequest + execution_results, all_params = run_http_query( + schema, + request.method.lower(), + data, + query_data=request.args, + batch_enabled=False, + catch=catch, + context={"env": http.request.env}, + ) + result, status_code = encode_execution_results( + execution_results, + is_batch=isinstance(data, list), + format_error=default_format_error, + encode=partial(json_encode, pretty=False), + ) + # TODO what to do with status_code? + return http.request.make_response( + result, headers={"Content-Type": "application/json"} + ) + + def _handle_graphql_request(self, schema): + data = self._parse_body() + return self._process_request(schema, data, catch=False) + + def _handle_graphiql_request(self, schema): + req = http.request.httprequest + if req.method == "GET" and req.accept_mimetypes.accept_html: + return http.request.render("graphql_base.graphiql", {}) + # this way of passing a GraphQL query over http is not spec compliant + # (https://graphql.org/learn/serving-over-http/), but we use + # this only for our GraphiQL UI, and it works with Odoo's way + # of passing the csrf token + return self._process_request(schema, http.request.params, catch=True) diff --git a/graphql_base/i18n/graphql_base.pot b/graphql_base/i18n/graphql_base.pot new file mode 100644 index 000000000..f7ae1716a --- /dev/null +++ b/graphql_base/i18n/graphql_base.pot @@ -0,0 +1,14 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 12.0+e\n" +"Report-Msgid-Bugs-To: \n" +"Last-Translator: <>\n" +"Language-Team: \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: \n" +"Plural-Forms: \n" + diff --git a/graphql_base/readme/DESCRIPTION.rst b/graphql_base/readme/DESCRIPTION.rst new file mode 100644 index 000000000..bf84a6825 --- /dev/null +++ b/graphql_base/readme/DESCRIPTION.rst @@ -0,0 +1,6 @@ +This modules enables the creation of `GraphQL `_ endpoints. +In itself, it does nothing and must be used by a developer to +create the GraphQL schema and resolvers using +`graphene `_, +and expose them through a controller. +An example is available in the ``graphql_demo`` module. diff --git a/graphql_base/readme/USAGE.rst b/graphql_base/readme/USAGE.rst new file mode 100644 index 000000000..8d94ca82e --- /dev/null +++ b/graphql_base/readme/USAGE.rst @@ -0,0 +1,11 @@ +To use this module, you need to + +- create your graphene schema +- create your controller to expose your GraphQL endpoint, + and optionally a GraphiQL UI. + +This module does not attempt to expose the whole Odoo object model. +This could be the purpose of another module based on this one. +We believe however that it is preferable to expose a specific well tested +endpoint for each customer, so as to reduce coupling by knowing precisely +what is exposed and needs to be tested when upgrading Odoo. diff --git a/graphql_base/static/description/icon.png b/graphql_base/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/graphql_base/types.py b/graphql_base/types.py new file mode 100644 index 000000000..eb1e504b9 --- /dev/null +++ b/graphql_base/types.py @@ -0,0 +1,43 @@ +# Copyright 2018 ACSONE SA/NV +# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl). + +import graphene + +from odoo import fields + + +def odoo_attr_resolver(attname, default_value, root, info, **args): + """An attr resolver that is specialized for Odoo recordsets. + + It converts False to None, except for Odoo Boolean fields. + This is necessary because Odoo null values are often represented + as False, and graphene would convert a String field with value False + to "false". + + It converts datetimes to the user timezone. + + It also raises an error if the attribute is not present, ignoring + any default value, so as to return if the schema declares a field + that is not present in the underlying Odoo model. + """ + value = getattr(root, attname) + field = root._fields.get(attname) + if value is False: + if not isinstance(field, fields.Boolean): + return None + elif isinstance(field, fields.Datetime): + return fields.Datetime.context_timestamp(root, value) + return value + + +class OdooObjectType(graphene.ObjectType): + """A graphene ObjectType with an Odoo aware default resolver.""" + + @classmethod + def __init_subclass_with_meta__(cls, default_resolver=None, **options): + if default_resolver is None: + default_resolver = odoo_attr_resolver + + return super(OdooObjectType, cls).__init_subclass_with_meta__( + default_resolver=default_resolver, **options + ) diff --git a/graphql_base/views/graphiql.xml b/graphql_base/views/graphiql.xml new file mode 100644 index 000000000..4112b9986 --- /dev/null +++ b/graphql_base/views/graphiql.xml @@ -0,0 +1,153 @@ + + + + + From b99a1b079fcaccf494da6cf84ead684cf0889197 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Mon, 3 Dec 2018 18:11:08 +0100 Subject: [PATCH 02/37] graphql: more documentation --- graphql_base/readme/USAGE.rst | 56 +++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/graphql_base/readme/USAGE.rst b/graphql_base/readme/USAGE.rst index 8d94ca82e..396f4d4a0 100644 --- a/graphql_base/readme/USAGE.rst +++ b/graphql_base/readme/USAGE.rst @@ -9,3 +9,59 @@ This could be the purpose of another module based on this one. We believe however that it is preferable to expose a specific well tested endpoint for each customer, so as to reduce coupling by knowing precisely what is exposed and needs to be tested when upgrading Odoo. + +To start working with this module, we recommend the following approach: + +- Learn `GraphQL basics `_ +- Learn `graphene `_, the python library + used to create GraphQL schemas and resolvers. +- Examine the ``graphql_demo`` module in this repo, copy it, + adapt the controller to suit your needs (routes, authentication methods). +- Start building your own schema and resolver. + +Building your schema +~~~~~~~~~~~~~~~~~~~~ + +The schema can be built using native graphene types. +An ``odoo.addons.graphql_base.types.OdooObjectType` +is provided as a convenience. It is a graphene ``ObjectType`` with a +default attribute resolver which: + +- converts False to None (except for Boolean types), to Odoo's weird False + strings being rendered as json "false"; +- adds the user timezone to Datetime fields; +- raises an error if an attribute is absent to avoid field name typing errors. + +Creating GraphQL controllers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The module provides an ``odoo.addons.graphql_base.GraphQLControllerMixion`` +class to help you build GraphQL controllers providing GraphiQL or GraphQL +http endpoints. + +.. code-block:: python + + from odoo import http + from odoo.addons.graphql_base import GraphQLControllerMixin + + from ..schema import schema + + + class GraphQLController(http.Controller, GraphQLControllerMixin): + + # The GraphiQL route, providing an IDE for developers + @http.route("/graphiql/demo", auth="user") + def graphiql(self, **kwargs): + return self._handle_graphiql_request(schema) + + # Optional monkey patch, needed to accept application/json GraphQL + # requests. If you only need to accept GET/POST requests, + # this is not necessary. + GraphQLControllerMixin.patch_for_json("^/graphql/demo/?$") + + # The graphql route, for applications. + # Note csrf=False: you may want to apply extra security + # (such as origin restrictions) to this route. + @http.route("/graphql/demo", auth="user", csrf=False) + def graphql(self, **kwargs): + return self._handle_graphql_request(schema) From d4d46adfb8b8fa9b3c450b16b14e7462b15c336a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Mon, 3 Dec 2018 18:13:00 +0100 Subject: [PATCH 03/37] graphql: add development_status and maintainers --- graphql_base/__manifest__.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/graphql_base/__manifest__.py b/graphql_base/__manifest__.py index 5c7a028ca..0e6d63e50 100644 --- a/graphql_base/__manifest__.py +++ b/graphql_base/__manifest__.py @@ -12,4 +12,6 @@ "depends": ["base"], "data": ["views/graphiql.xml"], "external_dependencies": {"python": ["graphene", "graphql_server"]}, + "development_status": "Beta", + "maintainers": ["sbidoul"], } From 16fda01092644879a7532c8d99a0e1ff0aeda0df Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Mon, 3 Dec 2018 18:54:04 +0100 Subject: [PATCH 04/37] graphql: improve and test error handling --- graphql_base/controllers/main.py | 56 +++++++++++++++++++------------- 1 file changed, 33 insertions(+), 23 deletions(-) diff --git a/graphql_base/controllers/main.py b/graphql_base/controllers/main.py index af11b96c5..d792e95e1 100644 --- a/graphql_base/controllers/main.py +++ b/graphql_base/controllers/main.py @@ -10,6 +10,7 @@ json_encode, load_json_body, run_http_query, + HttpQueryError, ) from odoo import http @@ -47,31 +48,40 @@ def _parse_body(self): return http.request.params return {} - def _process_request(self, schema, data, catch): - request = http.request.httprequest - execution_results, all_params = run_http_query( - schema, - request.method.lower(), - data, - query_data=request.args, - batch_enabled=False, - catch=catch, - context={"env": http.request.env}, - ) - result, status_code = encode_execution_results( - execution_results, - is_batch=isinstance(data, list), - format_error=default_format_error, - encode=partial(json_encode, pretty=False), - ) - # TODO what to do with status_code? - return http.request.make_response( - result, headers={"Content-Type": "application/json"} - ) + def _process_request(self, schema, data): + try: + request = http.request.httprequest + execution_results, all_params = run_http_query( + schema, + request.method.lower(), + data, + query_data=request.args, + batch_enabled=False, + catch=False, + context={"env": http.request.env}, + ) + result, status_code = encode_execution_results( + execution_results, + is_batch=isinstance(data, list), + format_error=default_format_error, + encode=partial(json_encode, pretty=False), + ) + headers = dict() + headers["Content-Type"] = "application/json" + response = http.request.make_response(result, headers=headers) + response.status_code = status_code + return response + except HttpQueryError as e: + result = json_encode({"errors": [default_format_error(e)]}) + headers = dict(e.headers) + headers["Content-Type"] = "application/json" + response = http.request.make_response(result, headers=headers) + response.status_code = e.status_code + return response def _handle_graphql_request(self, schema): data = self._parse_body() - return self._process_request(schema, data, catch=False) + return self._process_request(schema, data) def _handle_graphiql_request(self, schema): req = http.request.httprequest @@ -81,4 +91,4 @@ def _handle_graphiql_request(self, schema): # (https://graphql.org/learn/serving-over-http/), but we use # this only for our GraphiQL UI, and it works with Odoo's way # of passing the csrf token - return self._process_request(schema, http.request.params, catch=True) + return self._process_request(schema, http.request.params) From 8c3fce260ab49029dc9c193a3dd1906086bc1e35 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Mon, 3 Dec 2018 20:18:53 +0100 Subject: [PATCH 05/37] graphql: fix typos in documentation --- graphql_base/readme/USAGE.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/graphql_base/readme/USAGE.rst b/graphql_base/readme/USAGE.rst index 396f4d4a0..6017b09e0 100644 --- a/graphql_base/readme/USAGE.rst +++ b/graphql_base/readme/USAGE.rst @@ -2,7 +2,7 @@ To use this module, you need to - create your graphene schema - create your controller to expose your GraphQL endpoint, - and optionally a GraphiQL UI. + and optionally a GraphiQL IDE. This module does not attempt to expose the whole Odoo object model. This could be the purpose of another module based on this one. @@ -23,21 +23,21 @@ Building your schema ~~~~~~~~~~~~~~~~~~~~ The schema can be built using native graphene types. -An ``odoo.addons.graphql_base.types.OdooObjectType` +An ``odoo.addons.graphql_base.types.OdooObjectType`` is provided as a convenience. It is a graphene ``ObjectType`` with a default attribute resolver which: -- converts False to None (except for Boolean types), to Odoo's weird False - strings being rendered as json "false"; +- converts False to None (except for Boolean types), to avoid Odoo's weird + ``False`` strings being rendered as json ``"false"``; - adds the user timezone to Datetime fields; - raises an error if an attribute is absent to avoid field name typing errors. Creating GraphQL controllers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The module provides an ``odoo.addons.graphql_base.GraphQLControllerMixion`` -class to help you build GraphQL controllers providing GraphiQL or GraphQL -http endpoints. +The module provides an ``odoo.addons.graphql_base.GraphQLControllerMixin`` +class to help you build GraphQL controllers providing GraphiQL and/or GraphQL +endpoints. .. code-block:: python @@ -55,7 +55,8 @@ http endpoints. return self._handle_graphiql_request(schema) # Optional monkey patch, needed to accept application/json GraphQL - # requests. If you only need to accept GET/POST requests, + # requests. If you only need to accept GET requests or POST + # with application/x-www-form-urlencoded content, # this is not necessary. GraphQLControllerMixin.patch_for_json("^/graphql/demo/?$") From ae882d3fb5feb38b590758daa7f1038c559524c5 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Mon, 14 Jan 2019 10:08:04 +0000 Subject: [PATCH 06/37] [UPD] README.rst --- graphql_base/README.rst | 154 ++++++- graphql_base/static/description/index.html | 493 +++++++++++++++++++++ 2 files changed, 646 insertions(+), 1 deletion(-) create mode 100644 graphql_base/static/description/index.html diff --git a/graphql_base/README.rst b/graphql_base/README.rst index 6fbbfb500..8accc5140 100644 --- a/graphql_base/README.rst +++ b/graphql_base/README.rst @@ -1 +1,153 @@ -this file will be generated after merging +============ +Graphql Base +============ + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png + :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html + :alt: License: LGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Frest--framework-lightgray.png?logo=github + :target: https://github.com/OCA/rest-framework/tree/12.0/graphql_base + :alt: OCA/rest-framework +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/rest-framework-12-0/rest-framework-12-0-graphql_base + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/271/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This modules enables the creation of `GraphQL `_ endpoints. +In itself, it does nothing and must be used by a developer to +create the GraphQL schema and resolvers using +`graphene `_, +and expose them through a controller. +An example is available in the ``graphql_demo`` module. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +To use this module, you need to + +- create your graphene schema +- create your controller to expose your GraphQL endpoint, + and optionally a GraphiQL IDE. + +This module does not attempt to expose the whole Odoo object model. +This could be the purpose of another module based on this one. +We believe however that it is preferable to expose a specific well tested +endpoint for each customer, so as to reduce coupling by knowing precisely +what is exposed and needs to be tested when upgrading Odoo. + +To start working with this module, we recommend the following approach: + +- Learn `GraphQL basics `_ +- Learn `graphene `_, the python library + used to create GraphQL schemas and resolvers. +- Examine the ``graphql_demo`` module in this repo, copy it, + adapt the controller to suit your needs (routes, authentication methods). +- Start building your own schema and resolver. + +Building your schema +~~~~~~~~~~~~~~~~~~~~ + +The schema can be built using native graphene types. +An ``odoo.addons.graphql_base.types.OdooObjectType`` +is provided as a convenience. It is a graphene ``ObjectType`` with a +default attribute resolver which: + +- converts False to None (except for Boolean types), to avoid Odoo's weird + ``False`` strings being rendered as json ``"false"``; +- adds the user timezone to Datetime fields; +- raises an error if an attribute is absent to avoid field name typing errors. + +Creating GraphQL controllers +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The module provides an ``odoo.addons.graphql_base.GraphQLControllerMixin`` +class to help you build GraphQL controllers providing GraphiQL and/or GraphQL +endpoints. + +.. code-block:: python + + from odoo import http + from odoo.addons.graphql_base import GraphQLControllerMixin + + from ..schema import schema + + + class GraphQLController(http.Controller, GraphQLControllerMixin): + + # The GraphiQL route, providing an IDE for developers + @http.route("/graphiql/demo", auth="user") + def graphiql(self, **kwargs): + return self._handle_graphiql_request(schema) + + # Optional monkey patch, needed to accept application/json GraphQL + # requests. If you only need to accept GET requests or POST + # with application/x-www-form-urlencoded content, + # this is not necessary. + GraphQLControllerMixin.patch_for_json("^/graphql/demo/?$") + + # The graphql route, for applications. + # Note csrf=False: you may want to apply extra security + # (such as origin restrictions) to this route. + @http.route("/graphql/demo", auth="user", csrf=False) + def graphql(self, **kwargs): + return self._handle_graphql_request(schema) + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* ACSONE SA/NV + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +.. |maintainer-sbidoul| image:: https://github.com/sbidoul.png?size=40px + :target: https://github.com/sbidoul + :alt: sbidoul + +Current `maintainer `__: + +|maintainer-sbidoul| + +This module is part of the `OCA/rest-framework `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/graphql_base/static/description/index.html b/graphql_base/static/description/index.html new file mode 100644 index 000000000..81fc2ee7a --- /dev/null +++ b/graphql_base/static/description/index.html @@ -0,0 +1,493 @@ + + + + + + +Graphql Base + + + +
+

Graphql Base

+ + +

Beta License: LGPL-3 OCA/rest-framework Translate me on Weblate Try me on Runbot

+

This modules enables the creation of GraphQL endpoints. +In itself, it does nothing and must be used by a developer to +create the GraphQL schema and resolvers using +graphene, +and expose them through a controller. +An example is available in the graphql_demo module.

+

Table of contents

+ +
+

Usage

+

To use this module, you need to

+
    +
  • create your graphene schema
    • +
  • create your controller to expose your GraphQL endpoint, +and optionally a GraphiQL IDE.
    • +
+

This module does not attempt to expose the whole Odoo object model. +This could be the purpose of another module based on this one. +We believe however that it is preferable to expose a specific well tested +endpoint for each customer, so as to reduce coupling by knowing precisely +what is exposed and needs to be tested when upgrading Odoo.

+

To start working with this module, we recommend the following approach:

+
    +
  • Learn GraphQL basics
    • +
  • Learn graphene, the python library +used to create GraphQL schemas and resolvers.
    • +
  • Examine the graphql_demo module in this repo, copy it, +adapt the controller to suit your needs (routes, authentication methods).
    • +
  • Start building your own schema and resolver.
    • +
+
+

Building your schema

+

The schema can be built using native graphene types. +An odoo.addons.graphql_base.types.OdooObjectType +is provided as a convenience. It is a graphene ObjectType with a +default attribute resolver which:

+
    +
  • converts False to None (except for Boolean types), to avoid Odoo’s weird +False strings being rendered as json "false";
    • +
  • adds the user timezone to Datetime fields;
    • +
  • raises an error if an attribute is absent to avoid field name typing errors.
    • +
+
+
+

Creating GraphQL controllers

+

The module provides an odoo.addons.graphql_base.GraphQLControllerMixin +class to help you build GraphQL controllers providing GraphiQL and/or GraphQL +endpoints.

+
+from odoo import http
+from odoo.addons.graphql_base import GraphQLControllerMixin
+
+from ..schema import schema
+
+
+class GraphQLController(http.Controller, GraphQLControllerMixin):
+
+    # The GraphiQL route, providing an IDE for developers
+    @http.route("/graphiql/demo", auth="user")
+    def graphiql(self, **kwargs):
+        return self._handle_graphiql_request(schema)
+
+    # Optional monkey patch, needed to accept application/json GraphQL
+    # requests. If you only need to accept GET requests or POST
+    # with application/x-www-form-urlencoded content,
+    # this is not necessary.
+    GraphQLControllerMixin.patch_for_json("^/graphql/demo/?$")
+
+    # The graphql route, for applications.
+    # Note csrf=False: you may want to apply extra security
+    # (such as origin restrictions) to this route.
+    @http.route("/graphql/demo", auth="user", csrf=False)
+    def graphql(self, **kwargs):
+        return self._handle_graphql_request(schema)
+
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE SA/NV
    • +
+
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

Current maintainer:

+

sbidoul

+

This module is part of the OCA/rest-framework project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + From 38ef68475b7f1ad1dd7afb6130b3b07ac64af96a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Wed, 6 Feb 2019 20:41:14 +0100 Subject: [PATCH 07/37] [FIX] graphql: controller must rollback in case of error --- graphql_base/controllers/main.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/graphql_base/controllers/main.py b/graphql_base/controllers/main.py index d792e95e1..a6e2ecefd 100644 --- a/graphql_base/controllers/main.py +++ b/graphql_base/controllers/main.py @@ -70,6 +70,10 @@ def _process_request(self, schema, data): headers["Content-Type"] = "application/json" response = http.request.make_response(result, headers=headers) response.status_code = status_code + if any(er.errors for er in execution_results): + env = http.request.env + env.cr.rollback() + env.clear() return response except HttpQueryError as e: result = json_encode({"errors": [default_format_error(e)]}) @@ -77,6 +81,9 @@ def _process_request(self, schema, data): headers["Content-Type"] = "application/json" response = http.request.make_response(result, headers=headers) response.status_code = e.status_code + env = http.request.env + env.cr.rollback() + env.clear() return response def _handle_graphql_request(self, schema): From 5c61249ac369a31f1565da0a88a3199c3664a66f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?St=C3=A9phane=20Bidoul=20=28ACSONE=29?= Date: Wed, 6 Feb 2019 21:19:35 +0100 Subject: [PATCH 08/37] [FIX] graphql: readme lint --- graphql_base/README.rst | 6 +++--- graphql_base/readme/DESCRIPTION.rst | 4 ++-- graphql_base/readme/USAGE.rst | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/graphql_base/README.rst b/graphql_base/README.rst index 8accc5140..423bacfca 100644 --- a/graphql_base/README.rst +++ b/graphql_base/README.rst @@ -25,10 +25,10 @@ Graphql Base |badge1| |badge2| |badge3| |badge4| |badge5| -This modules enables the creation of `GraphQL `_ endpoints. +This modules enables the creation of `GraphQL `__ endpoints. In itself, it does nothing and must be used by a developer to create the GraphQL schema and resolvers using -`graphene `_, +`graphene `__, and expose them through a controller. An example is available in the ``graphql_demo`` module. @@ -55,7 +55,7 @@ what is exposed and needs to be tested when upgrading Odoo. To start working with this module, we recommend the following approach: - Learn `GraphQL basics `_ -- Learn `graphene `_, the python library +- Learn `graphene `__, the python library used to create GraphQL schemas and resolvers. - Examine the ``graphql_demo`` module in this repo, copy it, adapt the controller to suit your needs (routes, authentication methods). diff --git a/graphql_base/readme/DESCRIPTION.rst b/graphql_base/readme/DESCRIPTION.rst index bf84a6825..bc975b21c 100644 --- a/graphql_base/readme/DESCRIPTION.rst +++ b/graphql_base/readme/DESCRIPTION.rst @@ -1,6 +1,6 @@ -This modules enables the creation of `GraphQL `_ endpoints. +This modules enables the creation of `GraphQL `__ endpoints. In itself, it does nothing and must be used by a developer to create the GraphQL schema and resolvers using -`graphene `_, +`graphene `__, and expose them through a controller. An example is available in the ``graphql_demo`` module. diff --git a/graphql_base/readme/USAGE.rst b/graphql_base/readme/USAGE.rst index 6017b09e0..6a09c4f34 100644 --- a/graphql_base/readme/USAGE.rst +++ b/graphql_base/readme/USAGE.rst @@ -12,8 +12,8 @@ what is exposed and needs to be tested when upgrading Odoo. To start working with this module, we recommend the following approach: -- Learn `GraphQL basics `_ -- Learn `graphene `_, the python library +- Learn `GraphQL basics `__ +- Learn `graphene `__, the python library used to create GraphQL schemas and resolvers. - Examine the ``graphql_demo`` module in this repo, copy it, adapt the controller to suit your needs (routes, authentication methods). From 2085e7b1d647e9a15c9e52bf63e1f08e20f17abf Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Fri, 22 Mar 2019 09:01:25 +0000 Subject: [PATCH 09/37] [UPD] README.rst --- graphql_base/README.rst | 2 +- graphql_base/static/description/index.html | 28 +++++++++++----------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/graphql_base/README.rst b/graphql_base/README.rst index 423bacfca..b5f05fc42 100644 --- a/graphql_base/README.rst +++ b/graphql_base/README.rst @@ -54,7 +54,7 @@ what is exposed and needs to be tested when upgrading Odoo. To start working with this module, we recommend the following approach: -- Learn `GraphQL basics `_ +- Learn `GraphQL basics `__ - Learn `graphene `__, the python library used to create GraphQL schemas and resolvers. - Examine the ``graphql_demo`` module in this repo, copy it, diff --git a/graphql_base/static/description/index.html b/graphql_base/static/description/index.html index 81fc2ee7a..34217a291 100644 --- a/graphql_base/static/description/index.html +++ b/graphql_base/static/description/index.html @@ -377,21 +377,21 @@

Graphql Base

Table of contents

-

Usage

+

Usage

To use this module, you need to

  • create your graphene schema
    • @@ -413,7 +413,7 @@

    Usage

  • Start building your own schema and resolver.
-

Building your schema

+

Building your schema

The schema can be built using native graphene types. An odoo.addons.graphql_base.types.OdooObjectType is provided as a convenience. It is a graphene ObjectType with a @@ -426,7 +426,7 @@

Building your schema

-

Creating GraphQL controllers

+

Creating GraphQL controllers

The module provides an odoo.addons.graphql_base.GraphQLControllerMixin class to help you build GraphQL controllers providing GraphiQL and/or GraphQL endpoints.

@@ -460,7 +460,7 @@

Creating GraphQL controllers

-

Bug Tracker

+

Bug Tracker

Bugs are tracked on GitHub Issues. In case of trouble, please check there if your issue has already been reported. If you spotted it first, help us smashing it by providing a detailed and welcomed @@ -468,15 +468,15 @@

Bug Tracker

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

  • ACSONE SA/NV
-

Maintainers

+

Maintainers

This module is maintained by the OCA.

Odoo Community Association

OCA, or the Odoo Community Association, is a nonprofit organization whose From d338f268ffd1b615ab3f428c3a8fc41fa3771dd1 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Mon, 29 Jul 2019 03:33:18 +0000 Subject: [PATCH 10/37] [UPD] README.rst --- graphql_base/static/description/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/graphql_base/static/description/index.html b/graphql_base/static/description/index.html index 34217a291..553490ab9 100644 --- a/graphql_base/static/description/index.html +++ b/graphql_base/static/description/index.html @@ -3,7 +3,7 @@ - + Graphql Base