Skip to content

Commit 362bd8d

Browse files
authored
Update documentation for include and exclude
1 parent 1b82a8d commit 362bd8d

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ return [
8080
];
8181
```
8282

83-
This means documentation will be generated for routes in all domains ('*' is a wildcard meaning 'any character') which match any of the patterns 'api/*' or 'v2-api/*', excluding the 'users.create' route, and including the 'users.index' route. (The `versions` key is ignored unless you are using Dingo router).
83+
This means documentation will be generated for routes in all domains ('*' is a wildcard meaning 'any character') which match any of the patterns 'api/*' or 'v2-api/*', excluding the 'users.create' route and any routes whose names begin with `admin.`, and including the 'users.index' route and any routes whose names begin with `healthcheck.`. (The `versions` key is ignored unless you are using Dingo router).
8484
Also, in the generated documentation, these routes will have the header 'Authorization: Bearer: {token}' added to the example requests.
8585

8686
You can also separate routes into groups to apply different rules to them:
@@ -124,6 +124,7 @@ return [
124124

125125
With the configuration above, routes on the `v1.*` domain will have the `Token` and `Version` headers applied, while routes on the `v2.*` domain will have the `Authorization` and `Api-Version` headers applied.
126126

127+
> Note: the `include` and `exclude` items are arrays of route names. THe * wildcard is supported.
127128
> Note: If you're using DIngo router, the `versions` parameter is required in each route group. This parameter does not support wildcards. Each version must be listed explicitly,
128129
129130
To generate your API documentation, use the `apidoc:generate` artisan command.

0 commit comments

Comments
 (0)