You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: developer_manual/client_apis/OCS/ocs-openapi.rst
+13Lines changed: 13 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,6 +37,19 @@ Setup the following issue handlers in the psalm config (see `<https://psalm.dev/
37
37
38
38
Install openapi-extractor in your app as explained in `<https://github.com/nextcloud/openapi-extractor>`_. TODO add instructions there
39
39
40
+
Tips and tricks
41
+
---------------
42
+
43
+
The openapi-extractor tool forces you to set descriptions everywhere.
44
+
To ease the porting process you can set the `--allow-missing-docs` flag to ignore those problems.
45
+
46
+
The tool also only shows errors one by one by default, but you can also let it show you all problems at once using the `--continue-on-error`.
47
+
48
+
It is advised to use neither of the mentioned flags to generate the final specification.
49
+
They hide problems that your code has.
50
+
Especially the later one is dangerous because it will never fail when any problem exists in your code.
51
+
They should only be used to speed-up the initial porting process.
0 commit comments