Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Scribe Annotations #130

Merged
merged 5 commits into from
Nov 24, 2024
Merged

Scribe Annotations #130

merged 5 commits into from
Nov 24, 2024

Conversation

jbrooksuk
Copy link
Member

This PR annotates the API controllers in a way that we can use Scribe to generate the API documentation.

  1. I'm currently using Scribe within the cachethq/cachet application itself to generate the documentation. For this to work, I've had to override each model's newFactory method to return the correct class.
  2. I've updated all endpoint docblocks to use Scribe's PHP annotations (we can't use the attribute syntax, since Scribe isn't in the core itself).

At some point, I'm going to automate all of this in the main repo itself.

@jbrooksuk jbrooksuk added this to the v3.0 milestone Nov 24, 2024
@jbrooksuk jbrooksuk merged commit 6aa5924 into main Nov 24, 2024
8 checks passed
@jbrooksuk jbrooksuk deleted the scribe-annotations branch November 24, 2024 17:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant