From 3dd1051af1c4e13edfdf235615ec23feffcf9700 Mon Sep 17 00:00:00 2001 From: jld3103 Date: Thu, 16 Nov 2023 19:01:46 +0100 Subject: [PATCH] chore(nextcloud): Remove outdated information from README.md Signed-off-by: jld3103 --- packages/nextcloud/README.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/packages/nextcloud/README.md b/packages/nextcloud/README.md index b844ce55..0e40adaf 100644 --- a/packages/nextcloud/README.md +++ b/packages/nextcloud/README.md @@ -1,11 +1,8 @@ # nextcloud -A Nextcloud client written in Dart. +A Nextcloud API client written in Dart. -This client will become the replacement for https://github.com/provokateurin/dart-nextcloud at some point ([See](https://github.com/nextcloud/neon/issues/1)). - - -## Installing +## Installation In the future this code will be available at https://pub.dev/packages/nextcloud, but for now you have to include it via git in your pubspec.yaml: ```yaml @@ -27,13 +24,5 @@ You can either remove the `ref` or use a commit hash. It's not recommended to re ## Development -Except for WebDAV all client code is generated using OpenAPI specs which can be found in the `../../specs/` folder. -Templates for these OpenAPI specs are generated from the Nextcloud codebase to make development easier. - -To generate such a template take a look at `../../tool/generate-nextcloud.sh`. -After you have generated a template, you need to fill it out. Some endpoints can or have to be discarded. - -Then you start writing tests for the endpoints you added. -To easily inspect the responses for an endpoint, just set the `type` to `string` inside the `schema` blocks of the spec and let the output be printed in the tests. - -Sometimes you will have to look at the source code of Nextcloud, because the API is not always intuitive. Make sure to check if there is any API documentation that can help you. +Except for WebDAV all client code is generated using OpenAPI specifications which can be found in the `lib/src/api/` folder. +These OpenAPI specifications are [generated](https://github.com/nextcloud/openapi-extractor) from the PHP source code.