refactor(dev/ocs): re-organize for readability, fix/modernize code snippets, minor clarifications#14071
Open
joshtrichards wants to merge 5 commits intomasterfrom
Open
refactor(dev/ocs): re-organize for readability, fix/modernize code snippets, minor clarifications#14071joshtrichards wants to merge 5 commits intomasterfrom
joshtrichards wants to merge 5 commits intomasterfrom
Conversation
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Josh <josh.t.richards@gmail.com>
Member
Author
|
/backport to stable33 |
joshtrichards
changed the title
provokateurin
requested changes
Feb 16, 2026
|
|
||
| * Prefer OCS endpoints (``OCSController`` + ``DataResponse``) for public APIs | ||
| * Add explicit types everywhere (parameters, helper methods, and return types) | ||
| * Use ``null`` (or ``\stdClass``) to represent an empty JSON object |
Member
There was a problem hiding this comment.
Suggested change
| * Use ``null`` (or ``\stdClass``) to represent an empty JSON object | |
| * Use ``\stdClass`` to represent an empty JSON object |
I think I get what you mean, but null really isn't an empty JSON object.
| A controller and methods can have multiple scopes, however when a method has the attribute set, | ||
| all scopes from the controller are ignored. | ||
|
|
||
| Methods that require admin permissions due to missing ``#[NoAdminRequired]`` or ``#[PublicPage]`` attribute or the |
Member
There was a problem hiding this comment.
Suggested change
| Methods that require admin permissions due to missing ``#[NoAdminRequired]`` or ``#[PublicPage]`` attribute or the | |
| Methods that require admin permissions due to missing ``#[NoAdminRequired]`` or a present ``#[PublicPage]`` attribute or the |
Sounds like the missing applies to both attributes.
| class ResponseDefinitions {} | ||
|
|
||
| The name of every type definition has to start with the app ID. | ||
| The name of every type definition must start with the *readable app ID* as expected by theopenapi-extractor. |
Member
There was a problem hiding this comment.
Suggested change
| The name of every type definition must start with the *readable app ID* as expected by theopenapi-extractor. | |
| The name of every type definition must start with the *readable app ID* as expected by the openapi-extractor. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
☑️ Resolves
Reviewers: If you see a bunch of lines dropped in some spot, they were just moved elsewhere.
🖼️ Screenshots