spmallette commented on code in PR #3433: URL: https://github.com/apache/tinkerpop/pull/3433#discussion_r3305816343
########## docs/src/dev/provider/pdt.asciidoc: ########## @@ -0,0 +1,295 @@ +//// +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +//// + +[[provider-defined-types]] +== Provider Defined Types (PDT) + +Provider Defined Types allow graph providers to expose custom types that drivers can serialize and deserialize without +manual configuration on the client side. A provider annotates a class (or registers an adapter for a class it doesn't +own), and the type flows through the wire protocol automatically. Clients receive PDT values as structured objects they +can use directly or hydrate into language-native types. + +[[pdt-for-graph-providers]] +=== For Graph Providers + +==== Basic Usage Review Comment: I think examples from the Gremlin perspective would be useful here - basically using your example types in a query to help complete the full model. Any reason there's no Reference Docs? It's probably up to providers to provide specifics about their custom types, but isn't there a use case with TinkerGraph? Maybe use `Color` as an example as we've done in the past. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
