feat(scopes): Allow apps to define different API scopes for different…

[nickvergessen]

… target clients

Sibling PRs

• Server PR with OpenAPI attribute: Add OpenAPI attribute to allow multiple scopes server#41175
• Sample PR in notifications: Demo for OpenAPI scopes notifications#1707
• Adjust openapi-viewer to show them: feat(scopes): List and access OpenAPI scopes ocs_api_viewer#11

Possible optimisations

• Only put schemas in the openapi-*.jsons when they are used in the scope
• Handle tags
• Set administration depending on NoAdminRequired
• Ensure a method with multiple scopes is added multiple times
• Update docs feat(developer): Document OpenAPI scopes documentation#11271

Fix #20

[provokateurin]

@nickvergessen would it be possible to get this done before the server release so we can update it in the server? This is quite a significant change so it would be great to have it from the start.

[provokateurin]

The title of the specs should reflect the scope so a short note should be prepended to the current titles.

[provokateurin]

LGTM from the code.
I'll give it some testing with the apps that are supported to check for any problems.

[provokateurin]

Please rebase again 😬

[nickvergessen]

I had rebased before, so was only the rename from $parameter->docParameter to $parameter->docType

All done now

[provokateurin]

Running in server (core):

Warning: app: Could not read used schemas for response to 'get /index.php/avatar/{userId}/{size}/dark' with status code 200
PHP Fatal error:  Uncaught TypeError: OpenAPIExtractor\Helpers::collectUsedRefs(): Argument #1 ($data) must be of type array, stdClass given, called in /home/jld3103/src/github.com/nextcloud/openapi-extractor/generate-spec on line 739 and defined in /home/jld3103/src/github.com/nextcloud/openapi-extractor/src/Helpers.php:251
Stack trace:
#0 /home/jld3103/src/github.com/nextcloud/openapi-extractor/generate-spec(739): OpenAPIExtractor\Helpers::collectUsedRefs()
#1 {main}
  thrown in /home/jld3103/src/github.com/nextcloud/openapi-extractor/src/Helpers.php on line 251

[provokateurin]

And a few more of these errors in other apps:

Warning: app: Could not read used schemas for response to 'post /ocs/v2.php/cloud/shares/{id}/reshare' with status code 400
Warning: app: Could not read used schemas for response to 'post /ocs/v2.php/cloud/shares/{id}/permissions' with status code 400
Warning: app: Could not read used schemas for response to 'post /ocs/v2.php/cloud/shares/{id}/accept' with status code 500
Warning: app: Could not read used schemas for response to 'post /ocs/v2.php/cloud/shares/{id}/revoke' with status code 400
Warning: app: Could not read used schemas for response to 'post /ocs/v2.php/cloud/shares/{id}/move' with status code 400

[nickvergessen]

Rebased after #44

[nickvergessen]

Rebased again to solve the conflicts from #72

[nickvergessen]

Arg

Info: app: Extracting OpenAPI spec for theming 2.4.0
Info: app: Generated 1 routes!

Need to fix the logic more

[provokateurin]

LGTM! Can you update the demo PRs you did so I can review the changes in those and check that everything is good?

[nickvergessen]

Can you update the demo PRs you did so I can review the changes in those and check that everything is good?

• Notifications: was updated already, I rebased it on latest master: Demo for OpenAPI scopes notifications#1707
• Spreed: was updated already, I rebased it on latest main (wording changes in -full only): Openapi update spreed#10856
• Server: at Add OpenAPI scopes server#42888

[provokateurin]

Running this in Talk results in

Info: app: Generated scope default with 66 routes!
Info: app: Generated scope bots with 2 routes!
Info: app: Generated scope administration with 9 routes!
Info: app: Generated scope backend-recording with 2 routes!
Info: app: Generated scope backend-sipbridge with 6 routes!
Info: app: Generated scope backend-signaling with 1 routes!
Info: app: Generated scope full with 85 routes!

But the sum of all routes is 86 and the full spec has only 85 🤔

[provokateurin]

From the server branch:
https://github.com/nextcloud/server/blob/e1af7061e7c1598e5ccdfcb2fc6144070d0bcef9/apps/settings/openapi.json#L22
Empty schemas, probably missing a stdClass fix (might have been a problem on main already).

[nickvergessen]

But the sum of all routes is 86 and the full spec has only 85

Because getSingleRoom is in default scope and backend-sipbridge scope:
https://github.com/nextcloud/spreed/pull/10856/files#diff-d583983624ef8769460d4aa59e64b75ee54b6955e01e620e3eacedb7ba208786R314-R315

Empty schemas, probably missing a stdClass fix (might have been a problem on main already).

Fixed locally.

Checking atm why comments e.g. generates a -full variant while it only has the default.

[nickvergessen]

Both fixed and pushed now

[provokateurin]

Noice 🎉