Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How-to guide on subscriptions and OGM #101

Merged
merged 2 commits into from
Feb 28, 2024
Merged

How-to guide on subscriptions and OGM #101

merged 2 commits into from
Feb 28, 2024

Conversation

darrellwarde
Copy link
Contributor

Moved over from neo4j/graphql#3365

Copy link
Contributor

@lidiazuin lidiazuin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I only left a few comments and suggestions.

modules/ROOT/pages/ogm/subscriptions.adoc Show resolved Hide resolved
modules/ROOT/pages/ogm/subscriptions.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/ogm/subscriptions.adoc Outdated Show resolved Hide resolved

=== Adding the OGM

In order to utilize the `@private` marked field on the `User` type, you need to create the `User` model.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this line shouldn't be a step in the guide with an example of how to do that?

modules/ROOT/pages/ogm/subscriptions.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/ogm/subscriptions.adoc Outdated Show resolved Hide resolved
@darrellwarde darrellwarde merged commit 3d1ccb1 into dev Feb 28, 2024
lidiazuin added a commit that referenced this pull request Mar 6, 2024
* Publish preview for all work

* publish 5.x docs (#113)

* Collection of simple fixes (#107)

* Add `@jwtClaim` to the directives index

* Tweaks to the Getting Started guide

* Remove dead links from the OGM reference

* How-to guide on subscriptions and OGM (#101)

* Add changes from neo4j/graphql#3365

* Apply suggestions from code review

Co-authored-by: Lidia Zuin <[email protected]>

---------

Co-authored-by: Lidia Zuin <[email protected]>

* Bump the prod-dependencies group with 3 updates (#94)

Bumps the prod-dependencies group with 3 updates: [@antora/cli](https://gitlab.com/antora/antora), [@antora/site-generator-default](https://gitlab.com/antora/antora) and @neo4j-antora/aliases-redirects.


Updates `@antora/cli` from 3.1.6 to 3.1.7
- [Changelog](https://gitlab.com/antora/antora/blob/main/CHANGELOG.adoc)
- [Commits](https://gitlab.com/antora/antora/compare/v3.1.6...v3.1.7)

Updates `@antora/site-generator-default` from 3.1.6 to 3.1.7
- [Changelog](https://gitlab.com/antora/antora/blob/main/CHANGELOG.adoc)
- [Commits](https://gitlab.com/antora/antora/compare/v3.1.6...v3.1.7)

Updates `@neo4j-antora/aliases-redirects` from 0.2.2 to 0.2.3

---
updated-dependencies:
- dependency-name: "@antora/cli"
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-dependencies
- dependency-name: "@antora/site-generator-default"
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-dependencies
- dependency-name: "@neo4j-antora/aliases-redirects"
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: prod-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump the dev-dependencies group with 1 update (#114)

Bumps the dev-dependencies group with 1 update: [nodemon](https://github.com/remy/nodemon).


Updates `nodemon` from 3.0.2 to 3.1.0
- [Release notes](https://github.com/remy/nodemon/releases)
- [Commits](remy/nodemon@v3.0.2...v3.1.0)

---
updated-dependencies:
- dependency-name: nodemon
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: dev-dependencies
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update dependabot.yml

* Create CODEOWNERS

* Move migration to 4.0 folder

* WIP: draft on migration guide for 5.0

* Migration guide to 5.0.0

* Update examples in docs to comply with 5.0

* Apply suggestions from code review

Co-authored-by: Lidia Zuin <[email protected]>

* Rever page aliases changes in troubleshooting

* 5.x updates (#106)

* fix: change Number to Int

* fix: change interface to type for relationshipProperties

* fix: change reference of _on to typename_

* feat: add declareRelationship to directives reference

* feat: add @declareRelationship to interface example code

* feat: add example usage of declareRelationship to relationships page

* fix: typename_IN

* 5.x publish (#112)

* Standardise auth variables #93 (#95)

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the latest additions  (#34)

* Update publish.yml

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Add page-aliases for version 4 (#31)

* revert

* Apply suggestions from code review

Co-authored-by: Michael Webb <[email protected]>

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>

* Fix scalar description placeholders #38 (#39)

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Fix scalar description placeholders (#38)

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Editorial review of the most recent changes

* reverting changes to partials

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Standardise auth variables (#93)

* docs: use "username" in where username would be used in code examples

* docs: fix typos

* docs: remove part about creating a .env file

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Removing images that are not being used anywhere in the docs #98 (#99)

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the latest additions  (#34)

* Update publish.yml

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Add page-aliases for version 4 (#31)

* revert

* Apply suggestions from code review

Co-authored-by: Michael Webb <[email protected]>

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>

* Fix scalar description placeholders #38 (#39)

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Fix scalar description placeholders (#38)

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Editorial review of the most recent changes

* reverting changes to partials

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Removing images that are not being used anywhere in the docs (#98)

* Cherry-pick

* reverting changes

* reverting changes

* reverting changes

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Removing page alias that was causing a loop #102 (#103)

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the latest additions  (#34)

* Update publish.yml

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Add page-aliases for version 4 (#31)

* revert

* Apply suggestions from code review

Co-authored-by: Michael Webb <[email protected]>

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>

* Fix scalar description placeholders #38 (#39)

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Fix scalar description placeholders (#38)

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Editorial review of the most recent changes

* reverting changes to partials

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Editorial review of the most recent changes

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Removing page alias that was causing a loop (#102)

* fix

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the latest additions  (#34)

* Update publish.yml

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Add page-aliases for version 4 (#31)

* revert

* Apply suggestions from code review

Co-authored-by: Michael Webb <[email protected]>

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>

* Fix scalar description placeholders #38 (#39)

* Editorial review of the most recent changes

* reverting changes to partials

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* fixing note formatting

* Editorial review of the most recent changes

* fixing note formatting

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Fix scalar description placeholders (#38)

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Editorial review of the most recent changes

* reverting changes to partials

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Editorial review of the most recent changes

* Add page-aliases for version 4 (#31) (#32)

Co-authored-by: Neil Dewhurst <[email protected]>

* Editorial review of the most recent changes

* Publish 5.x docs

* fixing content

* fixing content

* reverting changes to match 5.x actual content

---------

Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>

* Remove example on custom resolvers in interfaces

* Update relationships.adoc

* Remove Migration to version 4 in documentation for 5.x

* update

* update

* update

* removing link to unavailable page

---------

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: Darrell Warde <[email protected]>
Co-authored-by: angrykoala <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Neil Dewhurst <[email protected]>
Co-authored-by: Michael Webb <[email protected]>
@lidiazuin lidiazuin deleted the ogm-subscriptions branch March 6, 2024 10:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants