Skip to content

Add OpenAPI tutorial - #10703

Merged
provokateurin merged 2 commits into
masterfrom
feature/openapi-tutorial
Aug 7, 2023
Merged

Add OpenAPI tutorial#10703
provokateurin merged 2 commits into
masterfrom
feature/openapi-tutorial

Conversation

@provokateurin

@provokateurinprovokateurin commented Jun 30, 2023

Copy link
Copy Markdown
Member

Create a tutorial on how to add OpenAPI to your app.
Will stay WIP for a while until I have gathered some feedback by testing this out with some people.

@provokateurinprovokateurin added this to the Nextcloud 28 milestone Jun 30, 2023
@provokateurinprovokateurin self-assigned this Jun 30, 2023
@provokateurin
provokateurinforce-pushed the feature/openapi-tutorial branch from c80d6b0 to 4fe8bc5CompareJune 30, 2023 12:44
DaphneMuller
DaphneMuller reviewed Jun 30, 2023
View reviewed changes
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst Outdated
@DaphneMuller

DaphneMuller commented Jun 30, 2023

Copy link
Copy Markdown
Contributor

The writing and structure is crystal clear, thank you for your work Kate to share your knowledge. I'm looking forward to app developers trying out your tutorial to see what are the missing gaps if they want to apply this knowledge to their own apps. I like that you outlined the theory and best practises and gave a simple example to follow along. We now just need to know what is missing for people to apply it to their apps.

Leptopoda
Leptopoda reviewed Jul 1, 2023
View reviewed changes
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst Outdated
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst Outdated
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst Outdated
@provokateurin
provokateurinforce-pushed the feature/openapi-tutorial branch from 4fe8bc5 to 14663b6CompareJuly 5, 2023 08:40
@provokateurin
provokateurinforce-pushed the feature/openapi-tutorial branch from 14663b6 to 867a0a0CompareJuly 5, 2023 08:41
Leptopoda
Leptopoda reviewed Jul 5, 2023
View reviewed changes

@LeptopodaLeptopoda left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks very clear now.
Maybe you can also remove the duplications that now happened in some places the main information is duplicated.
this can be seen in the PREFER to expose your APIs using OCS case.

@provokateurinprovokateurin mentioned this pull request Jul 6, 2023
Merged
8 tasks
@nickvergessennickvergessen mentioned this pull request Jul 10, 2023
Merged
4 tasks
Leptopoda
Leptopoda approved these changes Jul 11, 2023
View reviewed changes

@LeptopodaLeptopoda left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@provokateurin
provokateurinforce-pushed the feature/openapi-tutorial branch from fd0e3bd to b52c51dCompareJuly 13, 2023 09:51
@provokateurin
provokateurin marked this pull request as ready for review July 13, 2023 09:52
@provokateurin
provokateurin marked this pull request as draft July 13, 2023 09:53
provokateurin
provokateurin commented Jul 13, 2023
View reviewed changes
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst Outdated
provokateurin
provokateurin commented Jul 13, 2023
View reviewed changes
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst Outdated
nickvergessen
nickvergessen reviewed Jul 31, 2023
View reviewed changes
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst Outdated
nickvergessen
nickvergessen reviewed Jul 31, 2023
View reviewed changes
Comment threaddeveloper_manual/client_apis/OCS/ocs-openapi.rst
@provokateurin
provokateurin marked this pull request as ready for review August 7, 2023 06:09
@marcelklehr

marcelklehr commented Aug 7, 2023

Copy link
Copy Markdown
Member

@provokateurin could you squash all those fixup commits?

@provokateurin
Add sphinx collapse extension
33da2ad
Signed-off-by: jld3103 <jld3103yt@gmail.com>
@provokateurin
provokateurinforce-pushed the feature/openapi-tutorial branch from 34bc180 to d4556c5CompareAugust 7, 2023 11:07
@provokateurin
Add OpenAPI tutorial
6ecd1e2
Signed-off-by: jld3103 <jld3103yt@gmail.com>
@provokateurin
provokateurinforce-pushed the feature/openapi-tutorial branch from d4556c5 to 6ecd1e2CompareAugust 7, 2023 11:10
@provokateurin
provokateurin merged commit e1e0a62 into masterAug 7, 2023
@provokateurin
provokateurin deleted the feature/openapi-tutorial branch August 7, 2023 11:14
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nickvergessennickvergessennickvergessen left review comments
@marcelklehrmarcelklehrmarcelklehr approved these changes
@bigcat88bigcat88bigcat88 approved these changes
@LeptopodaLeptopodaLeptopoda approved these changes
@juliusknorrjuliusknorrAwaiting requested review from juliusknorr
@christianlupuschristianlupusAwaiting requested review from christianlupus
@datenangebotdatenangebotAwaiting requested review from datenangebot
@DaphneMullerDaphneMullerAwaiting requested review from DaphneMuller

Assignees

@provokateurinprovokateurin

Labels

2. developing

Projects

None yet

Milestone

Nextcloud 28

Development

Successfully merging this pull request may close these issues.

6 participants

@provokateurin@DaphneMuller@marcelklehr@nickvergessen@bigcat88@Leptopoda