You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Reformatted line wrapping of documentation to 80 characters. Also updated changelog to move features to the top and bug fixes to the bottom and used code fences and appropriate indenting where applicable.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+80-42Lines changed: 80 additions & 42 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,50 +16,88 @@ permissions and limitations under the License.
16
16
17
17
## Release v1.2.0 (Release Date: TBD)
18
18
19
-
This release contains new support for Apollo Server integration.
20
-
21
-
### Bug Fixes
22
-
23
-
* Don't cast integers to floats in Neptune schema ([#62](https://github.com/aws/amazon-neptune-for-graphql/pull/62))
24
-
* Fix query from AppSync with an empty filter object ([#61](https://github.com/aws/amazon-neptune-for-graphql/pull/61))
25
-
* Retain numeric parameter value type when creating open cypher query ([#63](https://github.com/aws/amazon-neptune-for-graphql/pull/63))
26
-
* Fixed bug with ID argument type conversion and added Apollo arguments to help menu ([#74](https://github.com/aws/amazon-neptune-for-graphql/pull/74))
27
-
* Upgraded axios and babel versions to fix security warnings ([#90](https://github.com/aws/amazon-neptune-for-graphql/pull/90))
28
-
* Fixed failing integration test by excluding `node_modules` from Apollo zip ([#94](https://github.com/aws/amazon-neptune-for-graphql/pull/94))
29
-
* Fixed enum types in schema to be included in input types ([#95](https://github.com/aws/amazon-neptune-for-graphql/pull/95))
30
-
* Fixed bug where id fields without @id directives are not accounted for ([#96](https://github.com/aws/amazon-neptune-for-graphql/pull/96))
31
-
* Fixed custom scalar types in schema to be included in input types ([#97](https://github.com/aws/amazon-neptune-for-graphql/pull/97))
32
-
* Fixed queries generated from an input schema which retrieve an array to have an option parameter with limit ([#97](https://github.com/aws/amazon-neptune-for-graphql/pull/97))
33
-
* Fixed nested edge subqueries to return an empty array if no results were found (([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
34
-
* Fixed usage of variables with nested edge subqueries (([#100](https://github.com/aws/amazon-neptune-for-graphql/pull/100))
35
-
* Fixed cdk output file to contain previously missing files that were necessary to execute the lambda resolver (([#106](https://github.com/aws/amazon-neptune-for-graphql/pull/106))
36
-
* Fixed resolution of nested variables in selection set arguments (([#108](https://github.com/aws/amazon-neptune-for-graphql/pull/108))
37
-
* Changed resolver to use `graphql``parse` instead of `graphql-tag``gql` to avoid stale values due to caching (([#109](https://github.com/aws/amazon-neptune-for-graphql/pull/109))
38
-
39
-
40
19
### Features
41
20
42
-
* Support output of zip package of Apollo Server artifacts (([#70](https://github.com/aws/amazon-neptune-for-graphql/pull/70)), ([#72](https://github.com/aws/amazon-neptune-for-graphql/pull/72)), ([#73](https://github.com/aws/amazon-neptune-for-graphql/pull/73)), ([#75](https://github.com/aws/amazon-neptune-for-graphql/pull/75)), ([#76](https://github.com/aws/amazon-neptune-for-graphql/pull/76)))
* Added pagination support through the addition of an `offset` argument in query options which can be used in combination with the existing `limit` (([#102](https://github.com/aws/amazon-neptune-for-graphql/pull/102))
45
-
* Added support for queries with sorting ([#105](https://github.com/aws/amazon-neptune-for-graphql/pull/105))
* Increased graphdb.js test coverage using sample data ([#53](https://github.com/aws/amazon-neptune-for-graphql/pull/53))
51
-
* Saved the neptune schema to file early so that it can be used for troubleshooting ([#56](https://github.com/aws/amazon-neptune-for-graphql/pull/56))
52
-
* Alias edges with same label as a node ([#57](https://github.com/aws/amazon-neptune-for-graphql/pull/57))
53
-
* Cap concurrent requests to get Neptune schema ([#58](https://github.com/aws/amazon-neptune-for-graphql/pull/58))
54
-
* Honour @id directive on type fields ([#60](https://github.com/aws/amazon-neptune-for-graphql/pull/60))
55
-
* Changed lambda template to use ECMAScripts modules ([#68](https://github.com/aws/amazon-neptune-for-graphql/pull/68))
56
-
* Add template file missing from packaging ([#71](https://github.com/aws/amazon-neptune-for-graphql/pull/71))
57
-
* Separated graphQL schema from resolver template ([#79](https://github.com/aws/amazon-neptune-for-graphql/pull/79))
58
-
* Added unit tests for resolver and moved resolver integration tests to be unit tests ([#83](https://github.com/aws/amazon-neptune-for-graphql/pull/83))
59
-
* Set limit on the expensive query which is retrieving distinct to and from labels for edges ([#89](https://github.com/aws/amazon-neptune-for-graphql/pull/89))
60
-
* Added distinct input types for create and update mutations ([#93](https://github.com/aws/amazon-neptune-for-graphql/pull/93))
61
-
* Enabled mutations for the Apollo Server ([#98](https://github.com/aws/amazon-neptune-for-graphql/pull/98))
62
-
* Refactored integration tests to be less vulnerable to resolver logic changes ([#99](https://github.com/aws/amazon-neptune-for-graphql/pull/99))
63
-
* Enabled usage of query fragments with Apollo Server ([#103](https://github.com/aws/amazon-neptune-for-graphql/pull/103))
64
-
* Compressed resolver schema file and moved schema initialization outside of event handlers to improve performance ([#111](https://github.com/aws/amazon-neptune-for-graphql/pull/111))
65
-
* Updated and proofread outdated documentation ([#107](https://github.com/aws/amazon-neptune-for-graphql/pull/107))
34
+
* Increased graphdb.js test coverage using sample
35
+
data ([#53](https://github.com/aws/amazon-neptune-for-graphql/pull/53))
36
+
* Saved the neptune schema to file early so that it can be used for
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4
-
documentation, we greatly value feedback and contributions from our community.
5
-
6
-
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7
-
information to effectively respond to your bug report or contribution.
3
+
Thank you for your interest in contributing to our project. Whether it's a bug
4
+
report, new feature, correction, or additional documentation, we greatly value
5
+
feedback and contributions from our community.
8
6
7
+
Please read through this document before submitting any issues or pull requests
8
+
to ensure we have all the necessary information to effectively respond to your
9
+
bug report or contribution.
9
10
10
11
## Reporting Bugs/Feature Requests
11
12
12
-
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
+
We welcome you to use the GitHub issue tracker to report bugs or suggest
14
+
features.
13
15
14
-
When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15
-
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
+
When filing an issue, please check existing open, or recently closed, issues to
17
+
make sure somebody else hasn't already reported the issue. Please try to include
18
+
as much information as you can. Details like these are incredibly useful:
16
19
17
20
* A reproducible test case or series of steps
18
21
* The version of our code being used
19
22
* Any modifications you've made relevant to the bug
20
23
* Anything unusual about your environment or deployment
21
24
22
-
23
25
## Contributing via Pull Requests
24
-
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
26
+
27
+
Contributions via pull requests are much appreciated. Before sending us a pull
28
+
request, please ensure that:
25
29
26
30
1. You are working against the latest source on the *main* branch.
27
-
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28
-
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
31
+
2. You check existing open, and recently merged, pull requests to make sure
32
+
someone else hasn't addressed the problem already.
33
+
3. You open an issue to discuss any significant work - we would hate for your
34
+
time to be wasted.
29
35
30
36
To send us a pull request, please:
31
37
32
38
1. Fork the repository.
33
-
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
39
+
2. Modify the source; please focus on the specific change you are contributing.
40
+
If you also reformat all the code, it will be hard for us to focus on your
41
+
change.
34
42
3. Ensure local tests pass.
35
43
4. Commit to your fork using clear commit messages.
36
-
5. Send us a pull request, answering any default questions in the pull request interface.
37
-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
44
+
5. Send us a pull request, answering any default questions in the pull request
45
+
interface.
46
+
6. Pay attention to any automated CI failures reported in the pull request, and
47
+
stay involved in the conversation.
38
48
39
-
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
49
+
GitHub provides additional document
50
+
on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
51
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41
52
42
-
43
53
## Finding contributions to work on
44
-
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
45
54
55
+
Looking at the existing issues is a great way to find something to contribute
56
+
on. As our projects, by default, use the default GitHub issue labels (
57
+
enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at
58
+
any 'help wanted' issues is a great place to start.
46
59
47
60
## Code of Conduct
48
-
This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49
-
For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50
-
opensource-codeofconduct@amazon.com with any additional questions or comments.
51
61
62
+
This project has adopted
63
+
the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
64
+
For more information see
65
+
the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
66
+
opensource-codeofconduct@amazon.com with any additional questions or comments.
52
67
53
68
## Security issue notifications
54
-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
55
69
70
+
If you discover a potential security issue in this project we ask that you
0 commit comments