Add missing docs, deprecate @discriminationAlias

Signed-off-by: Dmitriy Lazarev <[email protected]>
thefrontside · Sep 13, 2024 · daa5392 · daa5392
1 parent 9b1fc21
commit daa5392
Show file tree

Hide file tree

Showing 16 changed files with 946 additions and 462 deletions.
diff --git a/www/README.md b/www/README.md
@@ -1,4 +1,4 @@
-## Effection Website
+## HydraphQL Website
 
 ### Development
 

diff --git a/www/deno.lock b/www/deno.lock
diff --git a/www/docs/codegen.mdx b/www/docs/codegen.mdx
diff --git a/www/docs/collections.mdx b/www/docs/collections.mdx
diff --git a/www/docs/discriminates.mdx b/www/docs/discriminates.mdx
@@ -88,28 +88,27 @@ option. With that option HydraphQL will generate opaque types for all interfaces
 const application = await createApplication({ generateOpaqueTypes: true });
 ```
 
-### `@discriminationAlias`
+### Discrimination aliases
 
 By default value from `with` argument is used to find a type as-is or converted
 to PascalCase. And it's fairly enough for most cases. But sometimes you need to
-match the value with a type that has a different name. In this case, you can use
-`@discriminationAlias` directive.
+match the value with a type that has a different name. In this case, you can define
+`aliases` argument.
 
 ```graphql
 interface API
   @implements(interface: "Node")
-  @discriminates(with: "spec.type")
-  @discriminationAlias(from: "openapi", to: "OpenAPI") {
+  @discriminates(with: "spec.type", aliases: [{ from: "grpc", to: "GrpcAPI" }]) {
     # ...
   }
 
-type OpenAPI @implements(interface: "API") {
+type GrpcAPI @implements(interface: "API") {
   # ...
 }
 ```
 
-This means, when `spec.type` equals to `openapi`, the `API` interface will be
-resolved to `OpenAPI` type.
+This means, when `spec.type` equals to `gprc`, the `API` interface will be
+resolved to `GrpcAPI` type.
 
 ### Using `@discriminates` with multiple data sources
 
@@ -128,9 +127,13 @@ const loader = createLoader({
 
 ```graphql
 extend interface Node
-  @discriminates(with: "__source")
-  @discriminationAlias(value: "MyApi", type: "MyApiNode")
-  @discriminationAlias(value: "AnotherApi", type: "AnotherApiNode") {}
+  @discriminates(
+    with: "__source",
+    aliases: [
+      { value: "MyApi", type: "MyApiNode" },
+      { value: "AnotherApi", type: "AnotherApiNode" }
+    ]
+  ) {}
 
 type MyApiNode @implements(interface: "Node") {
   # ...

diff --git a/www/docs/extending.mdx b/www/docs/extending.mdx
@@ -39,13 +39,12 @@ The GraphQL API provides 2 syntaxes for defining edges:
 
 Use one-to-one syntax when a node is related to only one node. For example,
 a component can have only one owner is expressed in the following way. For more
-information checkout [`@resolve`][resolve], There is also [`@relation`][relation] directive
-implemented in the [Backstage Catalog GraphQL plugin][catalog-module] that resolves nodes
-with slightly different way.
+information checkout [`@relation`][relation], There is also [`@resolve`][resolve] directive
+that could be used for resolving nodes from 3rd party data sources.
 
 ```graphql
 type Component {
-  owner: User @resolve(at: "ownerId")
+  owner: User @relation(name: "ownedBy")
 }
 ```
 
@@ -59,11 +58,11 @@ section for more information.
 
 ```graphql
 type Component {
-  modules: [Module!] @resolve(at: "modules")
+  modules: [Module!] @relation(name: "modulesOf")
 }
 
 type Group {
-  members: Connection @resolve(at: "members", from: "UserAPI")
+  members: Connection @relation(name: "hasMember", nodeType: "User")
 }
 ```
 
@@ -249,9 +248,13 @@ server.listen(4000, () => {
 
 ```graphql
 extend interface Node
-  @discriminates(with: "__source")
-  @discriminationAlias(value: "MyApi", type: "MyApiNode")
-  @discriminationAlias(value: "Catalog", type: "Entity")
+  @discriminates(
+    with: "__source",
+    aliases: [
+      { value: "MyApi", type: "MyApiNode" },
+      { value: "Catalog", type: "Entity" }
+    ]
+  )
 
 type Entity @implements(interface: "Node") {
   title: String @field(at: "metadata.title")

diff --git a/www/docs/hydraphql.mdx b/www/docs/hydraphql.mdx
@@ -269,10 +269,14 @@ In the last step we need to update our schema
 
 ```graphql
 extend interface Node
-  @discriminates(with: "__source")
-  @discriminationAlias(value: "Assets", type: "Asset")
-  @discriminationAlias(value: "Markets", type: "Market")
-  @discriminationAlias(value: "Exchanges", type: "Exchange") {}
+  @discriminates(
+    with: "__source",
+    aliases: [
+      { value: "Assets", type: "Asset" },
+      { value: "Markets", type: "Market" },
+      { value: "Exchanges", type: "Exchange" }
+    ]
+  ) {}
 
 type Asset @implements(interface: "Node") {
   symbol: String! @field