Skip to content

Improve API documentation: fix for demo server path, added 403 error responses, improved schema for paginated responses #303

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve API documentation: fix for demo server path, added 403 error responses, improved schema for paginated responses #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/CachetCoreServiceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ private function configureScramble(): void
->withDocumentTransformers(function (OpenApi $openApi) {
$openApi->info->description = 'API documentation for Cachet, the open-source, self-hosted status page system.';

$openApi->addServer(Server::make('https://v3.cachethq.io')->setDescription('The Cachet v3 demo server.'));
$openApi->addServer(Server::make('https://v3.cachethq.io/api')->setDescription('The Cachet v3 demo server.'));
$openApi->secure(SecurityScheme::http('bearer'));
})
->withOperationTransformers(function (Operation $operation, RouteInfo $routeInfo) {
Expand Down
1 change: 1 addition & 0 deletions src/Concerns/GuardsApiAbilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@

trait GuardsApiAbilities
{
/** @throws MissingAbilityException */
public function guard(string $ability): void
{
/** @var User $user */
Expand Down