Skip to content

Commit fd0e3bd

Browse files
committed
fixup! WIP: Add OpenAPI tutorial
1 parent 26372db commit fd0e3bd

1 file changed

Lines changed: 13 additions & 0 deletions

File tree

developer_manual/client_apis/OCS/ocs-openapi.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,19 @@ Setup the following issue handlers in the psalm config (see `<https://psalm.dev/
3737
3838
Install openapi-extractor in your app as explained in `<https://github.com/nextcloud/openapi-extractor>`_. TODO add instructions there
3939

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.
52+
4053
Best practices
4154
--------------
4255

0 commit comments

Comments
 (0)