Skip to content

Commit 5b385d1

Browse files
committed
chore: update changelog and adjust docs
1 parent e2ce955 commit 5b385d1

File tree

6 files changed

+27
-6
lines changed

6 files changed

+27
-6
lines changed

.github_changelog_generator

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
user=feathersjs-ecosystem
22
project=feathers-swagger
3-
future-release=v3.0.0
3+
future-release=v4.0.0
44
release-branch=master
55
issues-of-open-milestones=false
66
unreleased=false

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@ You can also add custom methods to feathers services that will be available as r
99

1010
Checkout the [Documentation](https://feathersjs-ecosystem.github.io/feathers-swagger) for further information.
1111

12+
[Changelog](./docs/CHANGELOG.md)
13+
1214
## License
1315

14-
Copyright (c) 2016 - 2022
16+
Copyright (c) 2016 - 2023
1517

1618
Licensed under the [MIT license](LICENSE).

docs/CHANGELOG.md

+20
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Changelog
22

3+
## [v3.0.0](https://github.com/feathersjs-ecosystem/feathers-swagger/tree/v3.0.0) (2023-03-18)
4+
5+
[Full Changelog](https://github.com/feathersjs-ecosystem/feathers-swagger/compare/v2.0.0...v3.0.0)
6+
7+
**Breaking changes:**
8+
9+
- Feature: Create documentation for services with schemas of Feathersjs dove \(v5\) [\#244](https://github.com/feathersjs-ecosystem/feathers-swagger/issues/244)
10+
11+
**Implemented enhancements:**
12+
13+
- Feature: Documentation is only generated for methods provided via service options [\#249](https://github.com/feathersjs-ecosystem/feathers-swagger/issues/249)
14+
- Documentation: Use docify for documenation [\#245](https://github.com/feathersjs-ecosystem/feathers-swagger/issues/245)
15+
- Feature: Support dove custom methods [\#243](https://github.com/feathersjs-ecosystem/feathers-swagger/issues/243)
16+
- Feature: Support koa [\#242](https://github.com/feathersjs-ecosystem/feathers-swagger/issues/242)
17+
- Feature: Respect x-forwarded-prefix header [\#239](https://github.com/feathersjs-ecosystem/feathers-swagger/issues/239)
18+
19+
**Fixed bugs:**
20+
21+
- Bug: Custom method definitions are effecting other methods [\#248](https://github.com/feathersjs-ecosystem/feathers-swagger/issues/248)
22+
323
## [v2.0.0](https://github.com/feathersjs-ecosystem/feathers-swagger/tree/v2.0.0) (2022-08-27)
424

525
[Full Changelog](https://github.com/feathersjs-ecosystem/feathers-swagger/compare/v1.2.2...v2.0.0)

docs/examples/index.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
## Examples <!-- {docsify-ignore} -->
22

33
In addition to the examples you can access from the navigation, you can check out the [example application](https://github.com/feathersjs-ecosystem/feathers-swagger/tree/{GITHUB_BRANCH}/example) of the git repository.
4+
It contains many configurations and can be start with `npm start` when feathers-swagger have been checked out.
45

56
There is also a [repository with examples of integrations of feathers-swagger](https://github.com/Mairu/feathersjs-swagger-tests). It contains multiple branches for different versions and configurations.
67

7-
It contains many configurations and can be start with `npm start` when feathers-swagger have been checked out.
8-
98
### List of examples <!-- {docsify-ignore} -->
109
* [Basic Example](/examples/basic.md)
1110
* [Adding docs to a generated service (v4)](/examples/generated_app_v4.md)

docs/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,6 @@ To resolve, either manually define your model schemas or consider automated alte
217217

218218
## License
219219

220-
Copyright (c) 2016 - 2022
220+
Copyright (c) 2016 - 2023
221221

222222
Licensed under the [MIT license](LICENSE).

docs/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
replacements: [
5757
{
5858
search: '{GITHUB_BRANCH}',
59-
replace: 'next'
59+
replace: 'master'
6060
}
6161
],
6262
}

0 commit comments

Comments
 (0)