-
Notifications
You must be signed in to change notification settings - Fork 1
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
Adds features implemented to docs usage #104
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I have some comments.
I do have a question about why we are adding this information here. It seems to talk about a higher level of abstraction, which is GraphQL API for all connectors which implement ndc-spec, and is not specific for this connector.
Perhaps this should go in a central place and be linked from this repository (and other connectors' repository) instead?
@@ -0,0 +1,112 @@ | |||
# Use Multiple Arguments in a Query |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find it unfortunate that the term arguments is overloaded and may also refer to collection arguments.
I would actually suggest that this section is unnecessary, because we've already showed in simple-queries.md
that we can use multiple arguments (limit and offset).
Another suggestion is to fold this into simple queries.
wydt?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Can we use the term "query arguments"?
- I don't mind it that much. I think it's handy to be explicit (especially for the AI bot which is becoming the de-facto method of using docs) The simple queries page is fairly long already. If you have very strong feelings about this Gil we can change it. CC: @robertjdominguez
If multiple queries are part of the same request, they are executed **sequentially**, the individual responses are | ||
collated and returned together. You can fetch objects of different unrelated types in the same query. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If multiple queries are part of the same request, they are executed **sequentially**, the individual responses are | |
collated and returned together. You can fetch objects of different unrelated types in the same query. | |
You can fetch objects of different unrelated types in the same query. |
Should we include implementation details here if they are not semantically meaningful? There's no reason why we can't run the queries in parallel, or run them all in a single query, and keep the same semantics.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this something that would need to change with the connector to implement?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes it is entirely the connector's decision how to implement this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Accepted suggestion
} | ||
``` | ||
|
||
## List based search operators (_in, _nin) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
_nin
does not currently exist in ndc-spec, only _in
. I think using _not
over _in
does the same thing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Have updated. Can you check that it's correct in the second example.
@@ -0,0 +1,137 @@ | |||
# PostgreSQL: Filter based on computed fields |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Computed fields are currently not supported.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
deleted and removed from indices
Hey Gil :)
The decision was made (after much back and forth, analysis and conversation), that all connector specific docs, including GraphQL API docs, would live in their respective repos... because:
Once this PR is approved and this repo is public, we will remove the PostgreSQL GraphQL API docs from the DDN Docs site. |
4c4ae7a
to
ddb4d2e
Compare
Includes features which this NDC implements and links to docs for each.
Inline with the ndc-connector-template