Skip to content

cloud_federation_api: Introduce OpenAPI spec - #36356

Closed
provokateurin wants to merge 1 commit into
masterfrom
feature/cloud_federation_api-openapi
Closed

cloud_federation_api: Introduce OpenAPI spec#36356
provokateurin wants to merge 1 commit into
masterfrom
feature/cloud_federation_api-openapi

Conversation

@provokateurin

@provokateurinprovokateurin commented Jan 25, 2023•
edited
Loading

Copy link
Copy Markdown
Member

Summary

Adapts the code to make it friendly for https://github.com/nextcloud-gmbh/openapi-extractor and add the automatically generated spec.

TODO

Checklist

@szaimenszaimen added this to the Nextcloud 26 milestone Jan 25, 2023
@szaimenszaimen added the 3. to review Waiting for reviews label Jan 25, 2023
nickvergessen
nickvergessen reviewed Jan 25, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php
nickvergessen
nickvergessen reviewed Jan 25, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.response.php Outdated
come-nc
come-nc reviewed Jan 26, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.response.php Outdated
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch from 65e8e58 to 8ec7eecCompareJanuary 26, 2023 15:01
github-advanced-security[bot]
github-advanced-securityAI found potential problems Jan 26, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php Fixed
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php Fixed
nickvergessen
nickvergessen reviewed Jan 26, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.php Outdated
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.php Outdated
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.php Outdated
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.php Outdated
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.php Outdated
Comment threadapps/cloud_federation_api/lib/Model/CloudFederationAddShare.php Outdated
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch from 8ec7eec to 23f5f78CompareJanuary 27, 2023 06:39
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch from 23f5f78 to 14c9c4fCompareJanuary 27, 2023 07:05
come-nc
come-nc reviewed Jan 30, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Model/Response/CloudFederationValidationError.php Outdated
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch from 14c9c4f to f836c7cCompareFebruary 1, 2023 07:41
github-advanced-security[bot]
github-advanced-securityAI found potential problems Feb 1, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php Fixed
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php Fixed
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch from f836c7c to 0a29f3bCompareFebruary 1, 2023 08:03
github-advanced-security[bot]
github-advanced-securityAI found potential problems Feb 1, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php Fixed
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php Fixed
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch 3 times, most recently from 40c8398 to cc06bb5CompareFebruary 1, 2023 11:31
@blizzzblizzz mentioned this pull request Feb 1, 2023
Merged
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch from cc06bb5 to 6d44de2CompareFebruary 3, 2023 07:52
github-advanced-security[bot]
github-advanced-securityAI found potential problems Feb 3, 2023
View reviewed changes
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php
* Example: curl -H "Content-Type: application/json" -X POST -d '{"shareWith":"admin1@serve1","name":"welcome server2.txt","description":"desc","providerId":"2","owner":"admin2@http://localhost/server2","ownerDisplayName":"admin2 display","shareType":"user","resourceType":"file","protocol":{"name":"webdav","options":{"sharedSecret":"secret","permissions":"webdav-property"}}}' http://localhost/server/index.php/ocm/shares
*/
public function addShare($shareWith, $name, $description, $providerId, $owner, $ownerDisplayName, $sharedBy, $sharedByDisplayName, $protocol, $shareType, $resourceType) {
public function addShare(string $shareWith, string $name, ?string $description, string $providerId, string $owner, ?string $ownerDisplayName, ?string $sharedBy, ?string $sharedByDisplayName, array $protocol, string $shareType, string $resourceType): JSONResponse {

Check failure

Code scanning / Psalm

InvalidDocblock

Found duplicated @return or prefixed @return tag in docblock for OCA\CloudFederationAPI\Controller\RequestHandlerController::addShare
Comment threadapps/cloud_federation_api/lib/Controller/RequestHandlerController.php
$providerId === null ||
!is_array($notification)
) {
if ($providerId === null || !is_array($notification)) {

Check failure

Code scanning / Psalm

InvalidDocblock

Found duplicated @return or prefixed @return tag in docblock for OCA\CloudFederationAPI\Controller\RequestHandlerController::receiveNotification
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch 2 times, most recently from 1a874a9 to 1219a04CompareFebruary 3, 2023 09:08
@provokateurin
cloud_federation_api: Introduce OpenAPI spec
c5650b7
Signed-off-by: jld3103 <jld3103yt@gmail.com>
@provokateurin
provokateurinforce-pushed the feature/cloud_federation_api-openapi branch from 1219a04 to c5650b7CompareFebruary 3, 2023 10:50
@provokateurin
provokateurin marked this pull request as draft February 3, 2023 10:52
@provokateurinprovokateurin mentioned this pull request Feb 10, 2023
Closed
8 tasks
@ChristophWurst
ChristophWurst deleted the feature/cloud_federation_api-openapi branch February 14, 2023 08:39
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@PVince81PVince81Awaiting requested review from PVince81
@ChristophWurstChristophWurstAwaiting requested review from ChristophWurst
@juliusknorrjuliusknorrAwaiting requested review from juliusknorr
@tobiasKaminskytobiasKaminskyAwaiting requested review from tobiasKaminsky
@nickvergessennickvergessenAwaiting requested review from nickvergessen
@come-nccome-ncAwaiting requested review from come-nc

Assignees

No one assigned

Labels

3. to reviewWaiting for reviews

Projects

None yet

Milestone

Nextcloud 26

Development

Successfully merging this pull request may close these issues.

5 participants

@provokateurin@nickvergessen@github-advanced-security@come-nc@szaimen