njeudy
/
vertical-cooperative
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
755 Commits
24 Branches
24 Tags
3.5 MiB
Tree: 10bffeb8c9
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '10bffeb8c9'
${ noResults }
vertical-cooperative/easy_my_coop_api/static/description/index.html

425 lines
11 KiB
Raw Normal View History

[ADD] easy_my_coop_api
5 years ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
  1. <?xml version="1.0" encoding="utf-8" ?>
  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
  7. <title>Easy My Coop API</title>
  8. <style type="text/css">
  10. /*
  11. :Author: David Goodger (goodger@python.org)
  12. :Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
  13. :Copyright: This stylesheet has been placed in the public domain.
  15. Default cascading style sheet for the HTML output of Docutils.
  17. See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
  18. customize this style sheet.
  19. */
  21. /* used to remove borders from tables and images */
  22. .borderless, table.borderless td, table.borderless th {
  23. border: 0 }
  25. table.borderless td, table.borderless th {
  26. /* Override padding for "table.docutils td" with "! important".
  27. The right padding separates the table cells. */
  28. padding: 0 0.5em 0 0 ! important }
  30. .first {
  31. /* Override more specific margin styles with "! important". */
  32. margin-top: 0 ! important }
  34. .last, .with-subtitle {
  35. margin-bottom: 0 ! important }
  37. .hidden {
  38. display: none }
  40. .subscript {
  41. vertical-align: sub;
  42. font-size: smaller }
  44. .superscript {
  45. vertical-align: super;
  46. font-size: smaller }
  48. a.toc-backref {
  49. text-decoration: none ;
  50. color: black }
  52. blockquote.epigraph {
  53. margin: 2em 5em ; }
  55. dl.docutils dd {
  56. margin-bottom: 0.5em }
  58. object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
  59. overflow: hidden;
  60. }
  62. /* Uncomment (and remove this text!) to get bold-faced definition list terms
  63. dl.docutils dt {
  64. font-weight: bold }
  65. */
  67. div.abstract {
  68. margin: 2em 5em }
  70. div.abstract p.topic-title {
  71. font-weight: bold ;
  72. text-align: center }
  74. div.admonition, div.attention, div.caution, div.danger, div.error,
  75. div.hint, div.important, div.note, div.tip, div.warning {
  76. margin: 2em ;
  77. border: medium outset ;
  78. padding: 1em }
  80. div.admonition p.admonition-title, div.hint p.admonition-title,
  81. div.important p.admonition-title, div.note p.admonition-title,
  82. div.tip p.admonition-title {
  83. font-weight: bold ;
  84. font-family: sans-serif }
  86. div.attention p.admonition-title, div.caution p.admonition-title,
  87. div.danger p.admonition-title, div.error p.admonition-title,
  88. div.warning p.admonition-title, .code .error {
  89. color: red ;
  90. font-weight: bold ;
  91. font-family: sans-serif }
  93. /* Uncomment (and remove this text!) to get reduced vertical space in
  94. compound paragraphs.
  95. div.compound .compound-first, div.compound .compound-middle {
  96. margin-bottom: 0.5em }
  98. div.compound .compound-last, div.compound .compound-middle {
  99. margin-top: 0.5em }
  100. */
  102. div.dedication {
  103. margin: 2em 5em ;
  104. text-align: center ;
  105. font-style: italic }
  107. div.dedication p.topic-title {
  108. font-weight: bold ;
  109. font-style: normal }
  111. div.figure {
  112. margin-left: 2em ;
  113. margin-right: 2em }
  115. div.footer, div.header {
  116. clear: both;
  117. font-size: smaller }
  119. div.line-block {
  120. display: block ;
  121. margin-top: 1em ;
  122. margin-bottom: 1em }
  124. div.line-block div.line-block {
  125. margin-top: 0 ;
  126. margin-bottom: 0 ;
  127. margin-left: 1.5em }
  129. div.sidebar {
  130. margin: 0 0 0.5em 1em ;
  131. border: medium outset ;
  132. padding: 1em ;
  133. background-color: #ffffee ;
  134. width: 40% ;
  135. float: right ;
  136. clear: right }
  138. div.sidebar p.rubric {
  139. font-family: sans-serif ;
  140. font-size: medium }
  142. div.system-messages {
  143. margin: 5em }
  145. div.system-messages h1 {
  146. color: red }
  148. div.system-message {
  149. border: medium outset ;
  150. padding: 1em }
  152. div.system-message p.system-message-title {
  153. color: red ;
  154. font-weight: bold }
  156. div.topic {
  157. margin: 2em }
  159. h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
  160. h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
  161. margin-top: 0.4em }
  163. h1.title {
  164. text-align: center }
  166. h2.subtitle {
  167. text-align: center }
  169. hr.docutils {
  170. width: 75% }
  172. img.align-left, .figure.align-left, object.align-left, table.align-left {
  173. clear: left ;
  174. float: left ;
  175. margin-right: 1em }
  177. img.align-right, .figure.align-right, object.align-right, table.align-right {
  178. clear: right ;
  179. float: right ;
  180. margin-left: 1em }
  182. img.align-center, .figure.align-center, object.align-center {
  183. display: block;
  184. margin-left: auto;
  185. margin-right: auto;
  186. }
  188. table.align-center {
  189. margin-left: auto;
  190. margin-right: auto;
  191. }
  193. .align-left {
  194. text-align: left }
  196. .align-center {
  197. clear: both ;
  198. text-align: center }
  200. .align-right {
  201. text-align: right }
  203. /* reset inner alignment in figures */
  204. div.align-right {
  205. text-align: inherit }
  207. /* div.align-center * { */
  208. /* text-align: left } */
  210. .align-top {
  211. vertical-align: top }
  213. .align-middle {
  214. vertical-align: middle }
  216. .align-bottom {
  217. vertical-align: bottom }
  219. ol.simple, ul.simple {
  220. margin-bottom: 1em }
  222. ol.arabic {
  223. list-style: decimal }
  225. ol.loweralpha {
  226. list-style: lower-alpha }
  228. ol.upperalpha {
  229. list-style: upper-alpha }
  231. ol.lowerroman {
  232. list-style: lower-roman }
  234. ol.upperroman {
  235. list-style: upper-roman }
  237. p.attribution {
  238. text-align: right ;
  239. margin-left: 50% }
  241. p.caption {
  242. font-style: italic }
  244. p.credits {
  245. font-style: italic ;
  246. font-size: smaller }
  248. p.label {
  249. white-space: nowrap }
  251. p.rubric {
  252. font-weight: bold ;
  253. font-size: larger ;
  254. color: maroon ;
  255. text-align: center }
  257. p.sidebar-title {
  258. font-family: sans-serif ;
  259. font-weight: bold ;
  260. font-size: larger }
  262. p.sidebar-subtitle {
  263. font-family: sans-serif ;
  264. font-weight: bold }
  266. p.topic-title {
  267. font-weight: bold }
  269. pre.address {
  270. margin-bottom: 0 ;
  271. margin-top: 0 ;
  272. font: inherit }
  274. pre.literal-block, pre.doctest-block, pre.math, pre.code {
  275. margin-left: 2em ;
  276. margin-right: 2em }
  278. pre.code .ln { color: grey; } /* line numbers */
  279. pre.code, code { background-color: #eeeeee }
  280. pre.code .comment, code .comment { color: #5C6576 }
  281. pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
  282. pre.code .literal.string, code .literal.string { color: #0C5404 }
  283. pre.code .name.builtin, code .name.builtin { color: #352B84 }
  284. pre.code .deleted, code .deleted { background-color: #DEB0A1}
  285. pre.code .inserted, code .inserted { background-color: #A3D289}
  287. span.classifier {
  288. font-family: sans-serif ;
  289. font-style: oblique }
  291. span.classifier-delimiter {
  292. font-family: sans-serif ;
  293. font-weight: bold }
  295. span.interpreted {
  296. font-family: sans-serif }
  298. span.option {
  299. white-space: nowrap }
  301. span.pre {
  302. white-space: pre }
  304. span.problematic {
  305. color: red }
  307. span.section-subtitle {
  308. /* font-size relative to parent (h1..h6 element) */
  309. font-size: 80% }
  311. table.citation {
  312. border-left: solid 1px gray;
  313. margin-left: 1px }
  315. table.docinfo {
  316. margin: 2em 4em }
  318. table.docutils {
  319. margin-top: 0.5em ;
  320. margin-bottom: 0.5em }
  322. table.footnote {
  323. border-left: solid 1px black;
  324. margin-left: 1px }
  326. table.docutils td, table.docutils th,
  327. table.docinfo td, table.docinfo th {
  328. padding-left: 0.5em ;
  329. padding-right: 0.5em ;
  330. vertical-align: top }
  332. table.docutils th.field-name, table.docinfo th.docinfo-name {
  333. font-weight: bold ;
  334. text-align: left ;
  335. white-space: nowrap ;
  336. padding-left: 0 }
  338. /* "booktabs" style (no vertical lines) */
  339. table.docutils.booktabs {
  340. border: 0px;
  341. border-top: 2px solid;
  342. border-bottom: 2px solid;
  343. border-collapse: collapse;
  344. }
  345. table.docutils.booktabs * {
  346. border: 0px;
  347. }
  348. table.docutils.booktabs th {
  349. border-bottom: thin solid;
  350. text-align: left;
  351. }
  353. h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
  354. h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
  355. font-size: 100% }
  357. ul.auto-toc {
  358. list-style-type: none }
  360. </style>
  361. </head>
  362. <body>
  363. <div class="document" id="easy-my-coop-api">
  364. <h1 class="title">Easy My Coop API</h1>
  366. <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  367. !! This file is generated by oca-gen-addon-readme !!
  368. !! changes will be overwritten. !!
  369. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
  370. <p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_api"><img alt="coopiteasy/vertical-cooperative" src="https://img.shields.io/badge/github-coopiteasy%2Fvertical--cooperative-lightgray.png?logo=github" /></a></p>
  371. <p>Open Easy My Coop to the world: RESTful API.</p>
  372. <p><strong>Table of contents</strong></p>
  373. <div class="contents local topic" id="contents">
  374. <ul class="simple">
  375. <li><a class="reference internal" href="#known-issues-roadmap" id="id1">Known issues / Roadmap</a></li>
  376. <li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
  377. <li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
  378. <li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
  379. <li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
  380. <li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
  381. </ul>
  382. </li>
  383. </ul>
  384. </div>
  385. <div class="section" id="known-issues-roadmap">
  386. <h1><a class="toc-backref" href="#id1">Known issues / Roadmap</a></h1>
  387. <p>The API should generate and use an external id for records instead
  388. of odoo’s generated id. It would make importing and export data as
  389. well as migrating across versions easier.</p>
  390. <p>One way would be to use uuid but the default BaseRESTController
  391. routes would need to be rewritten: they only take integer as ids.
  392. Another way is to define a sequence per model.</p>
  393. </div>
  394. <div class="section" id="bug-tracker">
  395. <h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
  396. <p>Bugs are tracked on <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/issues">GitHub Issues</a>.
  397. In case of trouble, please check there if your issue has already been reported.
  398. If you spotted it first, help us smashing it by providing a detailed and welcomed
  399. <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/issues/new?body=module:%20easy_my_coop_api%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
  400. <p>Do not contact contributors directly about support or help with technical issues.</p>
  401. </div>
  402. <div class="section" id="credits">
  403. <h1><a class="toc-backref" href="#id3">Credits</a></h1>
  404. <div class="section" id="authors">
  405. <h2><a class="toc-backref" href="#id4">Authors</a></h2>
  406. <ul class="simple">
  407. <li>Coop IT Easy SCRLfs</li>
  408. </ul>
  409. </div>
  410. <div class="section" id="contributors">
  411. <h2><a class="toc-backref" href="#id5">Contributors</a></h2>
  412. <ul class="simple">
  413. <li>Coop IT Easy SCRLfs</li>
  414. <li>Robin Keunen &lt;<a class="reference external" href="mailto:robin&#64;coopiteasy.be">robin&#64;coopiteasy.be</a>&gt;</li>
  415. </ul>
  416. </div>
  417. <div class="section" id="maintainers">
  418. <h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
  419. <p>This module is part of the <a class="reference external" href="https://github.com/coopiteasy/vertical-cooperative/tree/12.0/easy_my_coop_api">coopiteasy/vertical-cooperative</a> project on GitHub.</p>
  420. <p>You are welcome to contribute.</p>
  421. </div>
  422. </div>
  423. </div>
  424. </body>
  425. </html>