Skip to content

Lack of clarity in dockumentation #160

@StefanRichterHuber

Description

@StefanRichterHuber

Describe the bug

I am trying to build an java ExApp using your API and need a little more type safety 😄 than the provided python apps. This way I stumbled over several inconsistencies in the documentation.

Installation FLow

https://cloud-py-api.github.io/app_api/tech_details/InstallationFlow.html

Enabled

Then enabled request does not seem to have a payload but a query parameter enabled which is an integer value (1 enabled, 0 disabled).

e.g. the request is an PUT on http://expapp:2432/enabled?enabled=1

AppAPI Nextcloud APIs

Logging

https://cloud-py-api.github.io/app_api/tech_details/api/logging.html

Please indicate that log level is an int ( if correct, please link Nextcloud doc )

{
        "level": "loglevel",
        "message": "message",
}

AppConfig

https://cloud-py-api.github.io/app_api/tech_details/api/appconfig.html

Request data seems to be of the wrong format.
Had more success with (like in preferences):

{
        "configKey": "key",
        "configValue": "value"
}

Still unsure of the value sensitive? JSON boolean, int 1/0 or String with true/false?

For both the the block Get app config values the documented response data seems to be insufficient.

Actual response is more like

{"ocs":
    {"meta": {"status":"ok","statuscode":100,"message":"OK","totalitems":"","itemsperpage":""},
    "data":[
        { "configkey": "key1", "configvalue": "value1" },
        { "configkey": "key2", "configvalue": "value2" },
        { "configkey": "key3", "configvalue": "value3" },
]}}

Same might be true for the preferences but not yet tested.

Also please indicate if there is any UI (planned) to configure AppConfig or Preferences.

Get list of NC users

https://cloud-py-api.github.io/app_api/tech_details/api/utils.html
The the documented response data seems to be insufficient.

Actual response is more like

{"ocs":
    {"meta": {"status":"ok","statuscode":100,"message":"OK","totalitems":"","itemsperpage":""},
    "data":["user1", "user2", "user3"]}
}


### Steps/Code to Reproduce

Read documentation and try to build an app

### Expected Results

Documentation matches the actual api

### Actual Results

See text

### Setup configuration

exapp_api = 1.4.3 nextcloud=27.1.5

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions