Commit Graph

194 Commits

Author SHA1 Message Date
jld3103
6ecd1e2a5d
Add OpenAPI tutorial
Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-08-07 13:10:21 +02:00
Marcel Klehr
756a73e1aa Small fixes
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2023-07-17 11:22:50 +02:00
Marcel Klehr
20d8d0630a Update: Refactor LLM API to TextProcessing API
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2023-07-17 11:09:07 +02:00
Marcel Klehr
ab64828840 Update LanguageModel APIs
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2023-07-07 11:34:22 +02:00
Marcel Klehr
33de83620e Document LanguageModel OCP and OCS APIs
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2023-07-05 12:53:19 +02:00
ralphtheninja
0ae567e04b
Update index.rst
Fix typo

Signed-off-by: ralphtheninja <ralphtheninja@riseup.net>
2023-06-09 12:26:04 +02:00
Julius Härtl
39e4925a19
Merge pull request #10006 from nextcloud/feat/openapi 2023-06-08 21:13:25 +02:00
jld3103
3435dacebb
Add new OCS API documentation
Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-06-05 08:50:22 +02:00
Grigorii K. Shartsev
6afb99e448 fix(developer_manual): add a note about encoding in login flow
Signed-off-by: Grigorii K. Shartsev <me@shgk.me>
2023-05-25 21:29:37 +00:00
John Molakvoæ
846d339ad6
feat: add files api
Signed-off-by: John Molakvoæ <skjnldsv@protonmail.com>
2023-05-23 14:05:24 +02:00
Louis Chemineau
46f1c9a83c Fix table format
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
ae60e1c553 Harmonize usage of "
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
77cbe46b74 Fix JSON syntax in example
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
7c5931d787 Use bytes over octets
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
6ed4ef8a4a Fix typo
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
778d780471 Add more examples
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
7bc8b31e41 Improve creation_time example
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
140f3775dc Add groupfolders and files_lock properties
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
b1420f2caf Improve examples
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
44d4859b55 Improve sharees doc
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
9c9b92ff02 Add creation_time property
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
726306d988 Add more native DAV properties
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
36cd32c66f Remove extra `
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
adeae621d2 Add quota and share-attributes props
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
62f63a2668 Improve OC-Checksum description
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
385357ff8f Add more props and improve descriptions and examples
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
bb5f5a2951 Add information about namespaces
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
b4e7d2c96f Add more share types
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
4b483ec1cd Use table formatting for dav properties and headers
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Louis Chemineau
43ca2eb7bc Improve webdav documentation
Signed-off-by: Louis Chemineau <louis@chmn.me>
2023-05-07 13:52:28 +02:00
Joas Schilling
f8d55abf72
fix(developer): Document optional returned from in translation response
Signed-off-by: Joas Schilling <coding@schilljs.com>
2023-05-05 10:00:54 +02:00
Daniel
7c0ce432d9
Merge pull request #10029 from felixschndr/patch-2
Fix syntax highlighting of http method
2023-04-24 20:54:26 +02:00
Marcel Klehr
7d34bba2d6 feat(translation): Add dev docs on OCP\Translation
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
2023-04-21 10:56:15 +02:00
Joas Schilling
ae73989cb0
Merge pull request #10042 from nextcloud/feat/noid/user-status-restore
feat(status): Document user status restore
2023-04-19 11:03:03 +02:00
Joas Schilling
cd12c3ca92
feat(developer): Document translation API
Signed-off-by: Joas Schilling <coding@schilljs.com>
2023-04-17 13:13:23 +02:00
Joas Schilling
b2a2faa9ab
feat(status): Document user status restore
Signed-off-by: Joas Schilling <coding@schilljs.com>
2023-04-14 14:12:38 +02:00
Felix Schneider
426d0da0f8
Fix syntax highlighting of http method
Add syntax highlighting to the DELETE http-method

Signed-off-by: Felix Schneider <fs@felix-schneider.org>

Signed-off-by: Felix Schneider <fs@felix-schneider.org>
2023-04-09 12:46:04 +02:00
jld3103
9f4f34a306
Fix displayname property
Signed-off-by: jld3103 <jld3103yt@gmail.com>
2023-03-21 07:55:49 +01:00
Vincent Petry
a07c9471db
Add share attributes documentation in OCS Share API
Signed-off-by: Vincent Petry <vincent@nextcloud.com>
2023-01-04 10:09:27 +01:00
Joas Schilling
8576c831af
Document the AutoCompleteEvent event
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-11-09 14:24:41 +01:00
Andrew Dawes
e1bc8c6667 Fixed several typos and grammar errors
Signed-off-by: Andrew Dawes <andrewsdawes@gmail.com>
2022-10-25 07:32:25 +02:00
Wael
79e68f86af
Minor typo fix (SingleSignOn)
Signed-off-by: Wael <wael.tellat@gmail.com>
2022-10-11 23:06:32 +02:00
Christian Paul
de4954b3fc
ocs-api-overview: Talk about user using singular they
Signed-off-by: Christian Paul <info@jaller.de>
2022-10-01 16:33:20 +02:00
Christoph Wurst
250286e335 Document maintenance mode header
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2022-09-30 16:22:18 +02:00
Knoxell
acba8015f1
adding token lifetime for loginflow v2
The token lifetime never made it into the developer manual even though relevant.

- As described in the push request for login flow V2 [nextcloud/server#14161](https://github.com/nextcloud/server/pull/14161), the token lifetime is 20 mins.
- In the source code: https://github.com/nextcloud/server/blob/master/core/Db/LoginFlowV2Mapper.php#L34

Signed-off-by: Knoxell <85034894+knoxell@users.noreply.github.com>
2022-09-14 14:25:48 +02:00
John Molakvoæ
c5a7d095df
Merge branch 'master' into ocs-recommendations-api
Signed-off-by: John Molakvoæ <skjnldsv@users.noreply.github.com>
2022-08-13 13:04:11 +02:00
Joas Schilling
f5126e1570
Merge pull request #8070 from sbernhard/patch-2
Adapt webdav search examples
2022-08-12 09:37:03 +02:00
Aaron Segura
b828df48a2
Update ocs-status-api.rst
Fix tables so that each row is displayed separately

Signed-off-by: Aaron Segura <aaron@aaronsegura.com>
2022-06-17 16:23:23 -05:00
tflidd
10a10c0836
Merge pull request #8531 from weswaldix/master
fixed typo in developer_manual
2022-06-11 13:33:17 +02:00
Joas Schilling
54f3afe1b6
Document user preferences API
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-06-09 12:55:39 +02:00
Andreas Weswaldi
0405c6cae1
fixed typo in developer_manual
fixed typo "dekstop" to "desktop" in client_apis/LoginFlow/index.rst

Signed-off-by: Andreas Weswaldi <andreas@weswaldi.at>
2022-06-09 08:08:56 +02:00
blizzz
13a9efc423
Merge pull request #7036 from nextcloud/enh/dev-client-flow-login-name-mismatch
Document client login flow login name mismatch
2022-03-22 10:01:43 +01:00
Julien Veyssier
dc634430cb
add contained-folder-count and contained-file-count optional webdav properties
Signed-off-by: Julien Veyssier <eneiluj@posteo.net>
2022-03-20 14:24:41 +01:00
Joas Schilling
52398ebf5d
Merge pull request #7534 from cogk/patch-2
Added example for WebDAV search by last updated time
2022-02-25 09:45:39 +01:00
Corentin Flr
6afb1ca5b5
Update developer_manual/client_apis/WebDAV/search.rst
Co-authored-by: Joas Schilling <213943+nickvergessen@users.noreply.github.com>
2022-02-25 09:24:05 +01:00
Bernhard Suttner
63f76c271d
Update search.rst
- Fix order option (see https://www.greenbytes.de/tech/webdav/draft-reschke-webdav-search-latest.html#rfc.section.5.6.1)
- Add option of how to limit results
2022-02-20 23:02:48 +01:00
Jasper vom Felde
13b8c903f0 Remove duplicate flag for authentication
Remove duplicate flag for using basic authentication to access WebDav

Signed-off-by: Jasper vom Felde <74309593+jaspervf@users.noreply.github.com>
2022-02-11 12:18:43 +01:00
Matthieu Gallien
b42c91975a example using curl to show how files can be uploaded with bulk upload
Signed-off-by: Matthieu Gallien <matthieu.gallien@nextcloud.com>
2022-02-07 22:52:05 +01:00
Matthieu Gallien
2eedb519dc add documentation about the bulk upload protocol
Signed-off-by: Matthieu Gallien <matthieu.gallien@nextcloud.com>
2022-02-04 12:09:33 +01:00
sualko
c6d6732938 add description of new OCS endpoint
for recommendations of files and folders

see nextcloud/recommendations#458

Signed-off-by: sualko <klaus@jsxc.org>
2022-01-07 12:46:08 +01:00
Christian Wolf
80234e56a5 Removed issues in developer manual
Signed-off-by: Christian Wolf <github@christianwolf.email>
2021-12-16 18:30:43 +01:00
Julius Härtl
88f545742a
Add note to share creation
Signed-off-by: Julius Härtl <jus@bitgrid.net>
2021-12-06 09:01:51 +01:00
Christian Wolf
39db36fdb2 Fixed some more links in the dev manual
Signed-off-by: Christian Wolf <github@christianwolf.email>
2021-11-24 14:50:02 +01:00
rakekniven
1a64cc624b
Merge pull request #7053 from bjoernmartin/patch-2
Add app password auth option
2021-11-10 11:34:33 +01:00
Björn Martin
881de39b7d Add app password auth option
Add app password authentication option which seems to be mandatory if an external auth provider is used.
2021-11-09 19:04:07 +01:00
Corentin Flr
c4a6c2ad38 Added example for WebDAV search by last updated time
Signed-off-by: Corentin Flr <10946971+cogk@users.noreply.github.com>
2021-11-07 18:26:50 +01:00
Julius Härtl
6b23efb4af
Use --data-binary opton when shoing chunked upload with curl
Signed-off-by: Julius Härtl <jus@bitgrid.net>
2021-10-29 09:47:45 +02:00
Juan Carlos Tello
0753d4595d
Fix nextcloud.org urls (#7164)
* Fixed help.nextcloud.org that would result in a page with a certificate issue

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Fixed broken URL

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Fixed broken link to bugtracker documentation

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Fixed broken link to how to get your app signed

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Updated stable installation URL

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Updated URL to Contacts & Calendar troubleshooting

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Fixed many URLs that pointed to nextcloud.org instead of nextcloud.com

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Update admin_manual/issues/general_troubleshooting.rst

Co-authored-by: Daniel <mail@danielkesselberg.de>
Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Apply suggestions from code review

Co-authored-by: Daniel <mail@danielkesselberg.de>
Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

* Reverted changes on .pot files

Signed-off-by: Juan Carlos Tello <juancarlos.tello@wazuh.com>

Co-authored-by: Daniel <mail@danielkesselberg.de>
2021-10-25 14:32:19 +02:00
Christoph Wurst
ba0295305f
Document client login flow login name mismatch
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-08-13 10:39:55 +02:00
Christoph Wurst
15dedf67c1
Fix inclusion of share and sharee OCS API pages
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-07-05 12:06:53 +02:00
Christoph Wurst
a7dd22d40e
Give the Activity API page a title so it shows in the TOC
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-07-05 12:06:37 +02:00
Christoph Wurst
2b941a6bd1
Limit WebDAV TOC depth like on other pages
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-07-05 12:05:55 +02:00
Christoph Wurst
750d34742a
Give the comments page a title, so it get included in TOCs
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-07-05 12:04:45 +02:00
Christoph Wurst
e9980cac2d
Add missing OCS status API page
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-07-05 12:04:16 +02:00
Tobias Kaminsky
b189846039
Create ocs-status-api.rst
Add doc for status api

Signed-off-by: tobiasKaminsky <tobias@kaminsky.me>
2020-12-07 08:04:09 +01:00
Iscle
894ae4ef34
Direct Download: Fix link expiration time
The link is only valid for 8 hours, not 24 as stated before.
2020-09-25 00:03:14 +02:00
Morris Jobke
e9eec9f428
Merge pull request #3762 from dassio/add_rich_workspace
add workspace property
2020-09-14 17:06:06 +02:00
Morris Jobke
4b076dddf0
Update developer_manual/client_apis/OCS/ocs-api-overview.rst 2020-09-14 16:30:19 +02:00
Alexandru Ungureanu
09f570b55e Corrected unintended text emphasis
Signed-off-by: Alexandru Ungureanu <aungureanu@keyfort.co.uk>
2020-09-13 15:08:34 +03:00
dassio
9bcddacb5a add workspace property
Signed-off-by: dassio <dassio@icloud.com>
2020-08-29 16:17:35 +01:00
Jivan Pal
96438ae6e5 Update WebDAV/basic.rst; corrected "created" to "deleted" for DELETE method 2020-08-21 16:42:08 +01:00
Jos Poortvliet
7efae5518e
Update index of Android lib
We want to remove this link from nextcloud.com/developer as it is a bit too specific. This seems a good place to link to it instead.
2020-07-29 18:50:33 +02:00
Joas Schilling
6b36e226c7
Extend docs on theming with primary color
Signed-off-by: Joas Schilling <coding@schilljs.com>
2020-07-06 10:16:22 +02:00
Christoph Wurst
2647cd93c7
Restructure the dev manual
This moves lots of pages around. The high-level changes are

* Better main sections, so it's more *general*, *into*, *basics* and *details*
* Move more general topics to a *Basic* section, which are not
  app-specific
* Remove app docs to the stuff that is likely used, anything else goes
  into "Digging deeper"
* Move general guides into a prologue
* Try to *compress*/combine some pages with similar content
* Try to have better consistencs on level ob abstraction across pages
* Split app development and maintenance pages into two sections
* Integrate bugtracker info into prologue
* Integrate Android pages into client APIs section

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2020-06-22 18:35:59 +02:00
Sascha Wiswedel
bd9ef16c19
purge strings about explicit Nextcloud versions
Versions deprecate fast and aren't needed in upstream documentation branches.

Signed-off-by: Sascha Wiswedel <sascha.wiswedel@nextcloud.com>
2020-06-04 12:48:13 +02:00
Sascha Wiswedel
972a22c346
more link fixes
Signed-off-by: Sascha Wiswedel <sascha.wiswedel@nextcloud.com>
2020-06-03 13:01:37 +02:00
Morris Jobke
d305a63c75
Merge pull request #1744 from nextcloud/jospoortvliet-patch-1
add autocomplete API
2020-04-21 10:00:05 +02:00
Jos Poortvliet
7e8e70fa1d
Update index.rst 2020-04-20 09:40:11 +02:00
Jos Poortvliet
d70eeac661
Create comments.rst 2020-04-20 09:40:04 +02:00
Jos Poortvliet
e9bbd5898b
Update index.rst 2020-04-20 09:39:56 +02:00
Jos Poortvliet
3152c243e3
Update index.rst 2020-04-20 09:39:48 +02:00
Jos Poortvliet
56714d1e8b
Rename activity.rst to activity-api.rst 2020-04-20 08:30:13 +02:00
Jos Poortvliet
1703965808
Create activity.rst 2020-04-20 08:28:43 +02:00
Johannes Endres
db88a15fdb
expireDate also valid parameter in new share 2020-03-28 10:32:54 +01:00
bpcurse
d181feb81f
Update ocs-api-overview.rst
Finally all spaces replaced by tabs. At least I hope... :)
2020-01-06 13:17:20 +01:00
bpcurse
39ad6b8f53
Update ocs-api-overview.rst
Tabbed all indentations
2020-01-06 12:50:35 +01:00
bpcurse
e5a3fb3aa6
Update ocs-api-overview.rst
- Updated the displayed data to resemble the actual query results as of v17.0.2
- Added `GET /ocs/v1.php/cloud/users` paragraph
- Fixed some typos
2020-01-06 06:11:39 +01:00
Sven Strickroth
985b003fa9 Optimize wording
Signed-off-by: Sven Strickroth <email@cs-ware.de>
2019-12-15 16:42:37 +01:00
Sven Strickroth
d36d86b776 Fix typo
Signed-off-by: Sven Strickroth <email@cs-ware.de>
2019-12-15 16:42:29 +01:00
Jos Poortvliet
9df211b9d5
add autocomplete API
replacing #1566
2019-12-07 16:06:48 +01:00