nextcloud / nextcloud/documentation
OCS OpenAPI tutorial: Mention that the parent class of the API has to end with OCSController
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 628
- Forks
- 2.5k
- Avg merge
- 2d 11h
- Merged PRs (30d)
- 135
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.
Contributor 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.
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.
Assessment
- Tech stack
- openapi
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 78/100