OCS OpenAPI tutorial: Mention that the parent class of the API has to end with OCSController
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 78/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Quiet
- Tech stack
- openapi
- Domain
- documentation
Research direction
Open the linked OCS OpenAPI documentation page and find the section describing the ApiController or its parent class. Add the requirement that the parent class name must end with OCSController, with wording that explains why extending OCSController indirectly can otherwise produce an unclear error. Done means the tutorial makes this naming constraint explicit.
Written by the indexing model from the issue text.
Description
Before You Submit
- I have checked for existing issues and pull requests related to my suggestion.
- I have posted on the Nextcloud Community Help Forum if my suggestion is a troubleshooting scenario or I'm unsure about the solution.
Type of Suggestion
Mention that the name of the parent class of the ApiController has to end with OCSController.
Relevant Documentation Links
https://docs.nextcloud.com/server/latest/developer_manual/client_apis/OCS/ocs-openapi.html
Additional Notes
I got mad about this, because I had a baseApiV2Controller class (now renamed baseApiV2Controller) until I stumbled over the comment inside the OpenAPIExtractor. I did not understand the error message, because I was extending OCSController, but inside the parent class.
- Dominant language
- JavaScript
- Stars
- 632
- Forks
- 2.5k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 96
Getting set up
Starts the project's dev container in your browser, under your own GitHub account.
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from nextcloud/documentation
-
0. needs triage enhancement manual: developer security
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
nextcloud/documentation#15693 ·
Maintainers usually reply within 1 day
-
0. needs triage bug developer experience manual: developer
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
nextcloud/documentation#15690 ·
Maintainers usually reply within 1 day
-
0. needs triage developer experience enhancement good first issue manual: developer
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
nextcloud/documentation#15687 ·
Maintainers usually reply within 1 day
-
0. needs triage enhancement good first issue manual: developer security
Difficulty 1/5 Under an hour Newbie friendliness 90/100
nextcloud/documentation#15686 ·
Maintainers usually reply within 1 day
-
0. needs triage enhancement good first issue manual: developer
Difficulty 1/5 1-3 hours Newbie friendliness 88/100
nextcloud/documentation#15685 ·
Maintainers usually reply within 1 day
All issues in nextcloud/documentation
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Edit: RTE News LogoOpencheck:failed logos:edit
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
iptv-org/database#36354 · 1 comment ·
Maintainers usually reply within 4 days