Skip to content

Commit 6cb49d4

Browse files
committed
Fixed links and updated some terms inside README
1 parent 30521ea commit 6cb49d4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# nem2-openapi-generator-dart
2-
This is an OpenAPI generator for Dart (v2 and above) which allows generation of NEM2 API client libraries for NEM2 SDK Dart ([nem2-sdk-dart][nem2-sdk-dart-repo]) automatically given a NEM2 OpenAPI Spec ([nem2-openapi][nem2-openapi-spec-repo]).
2+
This is an OpenAPI generator for Dart (v2 and above) which allows generation of Symbol API client libraries for NEM2 SDK Dart ([nem2-sdk-dart][nem2-sdk-dart-repo]) automatically given a Symbol OpenAPI Spec ([symbol-openapi][symbol-openapi-spec-repo]).
33

44
## Requirements
5-
An [OpenAPI Generator CLI][openapi-generator-cli-docs] for your Operating System is required to generate the client libraries.
5+
An [OpenAPI Generator CLI][openapi-generator-cli-docs] version 4.2.3 (or above) for your Operating System is required to generate the client libraries.
66
The code generation script uses Homebrew by default and it will install the openapi-generator-cli when it has not been installed.
77

88
If you want to install and use the OpenAPI generator without using Homebrew, then you can disable the line inside the code generation script that checks and installs it.
@@ -18,11 +18,11 @@ Please note that the generator also generates ```.gitignore```, a README, Dart m
1818
The OpenAPI generator accepts custom configuration available for Dart from the file `openapi-config.yaml`. Please refer to the following page for a complete list of config options: [dart][openapi-generator-dart2-configs] or [dart-dio][openapi-generator-dart2-dio-configs] (depends on your preference).
1919

2020
## Version
21-
This project is updated for NEM2 OpenAPI specification version [0.8.4][nem2-openapi-spec-file].
21+
This project is updated for Symbol OpenAPI specification version [0.8.5][symbol-openapi-spec-file].
2222

2323
## Notes
24-
* This project's version should be consistent with that of the NEM2 OpenAPI specification (as specified inside `openapi3.yaml`).
25-
* Whenever there is a new version available for the NEM2 OpenAPI specification, this project should be upgraded, regenerated and published to [Dart packages repository][dart-packages-repo].
24+
* This project's version should be consistent with that of the Symbol OpenAPI specification (as specified inside `openapi3.yaml`).
25+
* Whenever there is a new version available for the Symbol OpenAPI specification, this project should be upgraded, regenerated and published to [Dart packages repository][dart-packages-repo].
2626
* The generator currently uses a patched version of the specification (`openapi3-any-of-patch.yaml`) due to an ongoing bug of the `anyOf` which also affects the Dart generator. We will use the standard specification once the `anyOf` issue has been fixed.
2727
* Due to an open issue to the OpenAPI generator for Dart version 2 ([dart2 template issue][openapi-generator-dart2-template-issue]), you may want to use a custom template provided inside the `dart2-template` directory instead of the [default][openapi-generator-dart2-default-template] one. You can change the generator script to use this custom template when generating the code.
2828

@@ -40,8 +40,8 @@ Licensed under the [Apache License 2.0](LICENSE)
4040
THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS, COPYRIGHT HOLDERS, REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL CLAIM, DAMAGES OR OTHER LIABILITY (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN ACTION OF CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4141

4242
[nem2-sdk-dart-repo]: https://github.com/fajarvm/nem2-sdk-dart
43-
[nem2-openapi-spec-repo]: https://github.com/nemtech/nem2-openapi/tree/master/spec
44-
[nem2-openapi-spec-file]: https://github.com/nemtech/nem2-openapi/blob/master/spec/openapi3.yaml
43+
[symbol-openapi-spec-repo]: https://github.com/nemtech/symbol-openapi/
44+
[symbol-openapi-spec-file]: https://github.com/nemtech/symbol-openapi/releases/tag/v0.8.5
4545
[openapi-generator-cli-docs]: https://openapi-generator.tech/docs/installation
4646
[openapi-generator-anyof-issue634]: https://github.com/OpenAPITools/openapi-generator/issues/634
4747
[openapi-generator-dart2-template-issue]: https://github.com/OpenAPITools/openapi-generator/pull/3656

0 commit comments

Comments
 (0)