Skip to content

Commit 7c37c4d

Browse files
committed
wip
1 parent be5e3b4 commit 7c37c4d

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

docs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
packageName: Laravel API Documentation Generator
3-
githubUrl: https://github.com/mpociot/laravel-api-doc-generator
3+
githubUrl: https://github.com/mpociot/laravel-apidoc-generator
44
---

docs/getting-started/configuration.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ You can specify a custom logo to be used on the generated documentation. Set the
6464
If you want to use this, please note that the image size must be 230 x 52.
6565

6666
## default_group
67-
When [documenting your api](/docs/laravel-api-doc-generator/getting-started/documenting-your-api), you use `@group` annotations to group API endpoints. Endpoints which do not have a group annotation will be grouped under the `default_group`. Defaults to **"general"**.
67+
When [documenting your api](/docs/laravel-apidoc-generator/getting-started/documenting-your-api), you use `@group` annotations to group API endpoints. Endpoints which do not have a group annotation will be grouped under the `default_group`. Defaults to **"general"**.
6868

6969
## example_languages
70-
For each endpoint, an example request is shown in each of the languages specified in this array. Currently only `bash`, `javascript`, `php` and `python` are supported. You can add your own language, but you must also define the corresponding view (see [Specifying languages for examples](/docs/laravel-api-doc-generator/getting-started/generating-documentation)). Default: `["bash", "javascript"]`
70+
For each endpoint, an example request is shown in each of the languages specified in this array. Currently only `bash`, `javascript`, `php` and `python` are supported. You can add your own language, but you must also define the corresponding view (see [Specifying languages for examples](/docs/laravel-apidoc-generator/getting-started/generating-documentation)). Default: `["bash", "javascript"]`
7171

7272
## faker_seed
73-
When generating example requests, this package uses fzanninoto/faker to generate random values. If you would like the package to generate the same example values for parameters on each run, set this to any number (eg. 1234). (Note: alternatively, you can set example values for parameters when [documenting them.](/docs/laravel-api-doc-generator/getting-started/documenting-your-api))
73+
When generating example requests, this package uses fzanninoto/faker to generate random values. If you would like the package to generate the same example values for parameters on each run, set this to any number (eg. 1234). (Note: alternatively, you can set example values for parameters when [documenting them.](/docs/laravel-apidoc-generator/getting-started/documenting-your-api))
7474

7575
## routeMatcher
7676
The route matcher class provides the algorithm that determines what routes should be documented. The default matcher used is the included `\Mpociot\ApiDoc\Matching\RouteMatcher::class`, and you can provide your own custom implementation if you wish to programmatically change the algorithm. The provided matcher must be an instance of the `RouteMatcherInterface`.
@@ -246,7 +246,7 @@ These values support wildcards and paths, so you can have `'exclude' => ['users/
246246
After defining the routes in `match` (and `include` or `exclude`), `apply` is where you specify the settings to be applied to those routes when generating documentation. There are a bunch of settings you can tweak here:
247247

248248
### headers
249-
Like we've demonstrated above, any headers you specify here will be added to the headers shown in the example requests in your documentation. They will also be included in ["response calls"](/docs/laravel-api-doc-generator/getting-started/documenting-your-api). Headers are specified as key => value strings.
249+
Like we've demonstrated above, any headers you specify here will be added to the headers shown in the example requests in your documentation. They will also be included in ["response calls"](/docs/laravel-apidoc-generator/getting-started/documenting-your-api). Headers are specified as key => value strings.
250250

251251
### response_calls
252-
These are the settings that will be applied when making ["response calls"](/docs/laravel-api-doc-generator/getting-started/documenting-your-api). See the linked section for details.
252+
These are the settings that will be applied when making ["response calls"](/docs/laravel-apidoc-generator/getting-started/documenting-your-api). See the linked section for details.

docs/getting-started/migrating.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Note: This isn't meant to be an exhaustive guide to the changes in v4. Please se
1515

1616
- Remove the `output` key. Source files now go to `resources/docs/source` and generated docs go to either `public/docs/` or `resources/views/apidoc`.
1717

18-
- Make sure the `type` value is set appropriately. See [the docs](/docs/laravel-api-doc-generator/getting-started/configuration).
18+
- Make sure the `type` value is set appropriately. See [the docs](/docs/laravel-apidoc-generator/getting-started/configuration).
1919

20-
- Remove the `bindings` section. It has been superseded by the `@urlParam` annotation, which works similarly to the existing `@queryParam` annotation. See [the docs](/docs/laravel-api-doc-generator/getting-started/documenting-your-api)
20+
- Remove the `bindings` section. It has been superseded by the `@urlParam` annotation, which works similarly to the existing `@queryParam` annotation. See [the docs](/docs/laravel-apidoc-generator/getting-started/documenting-your-api)
2121

2222
- Remove the `response_calls.bindings` section. Use the `Example: ` feature of `@urlParam` to specify the value you want to be used in response calls.
2323

@@ -32,9 +32,9 @@ The major change here is the introduction of the `urlParameters` section and the
3232
- The location of the source files for the generated docs has changed. Move any prepend/append files you've created from `public/docs/source` to the new location (`resources/docs/source`)
3333

3434
## API
35-
- Verify that any custom strategies you've written match the new signatures. See [the docs](/docs/laravel-api-doc-generator/extending/plugins). Also note the order of execution and the new stages present.
35+
- Verify that any custom strategies you've written match the new signatures. See [the docs](/docs/laravel-apidoc-generator/extending/plugins). Also note the order of execution and the new stages present.
3636

3737
## Other new features (highlights)
38-
- [Non-static docs/docs with authentication](/docs/laravel-api-doc-generator/getting-started/configuration)
39-
- [`@apiResource` for Eloquent API resources](/docs/laravel-api-doc-generator/getting-started/documenting-your-api)
38+
- [Non-static docs/docs with authentication](/docs/laravel-apidoc-generator/getting-started/configuration)
39+
- [`@apiResource` for Eloquent API resources](/docs/laravel-apidoc-generator/getting-started/documenting-your-api)
4040
- You can now mix and match response strategies and status codes as you like.

0 commit comments

Comments
 (0)