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

member value for &ref-queries with no match #268

Open
kbrueckmann opened this issue Oct 11, 2024 · 1 comment
Open

member value for &ref-queries with no match #268

kbrueckmann opened this issue Oct 11, 2024 · 1 comment

Comments

@kbrueckmann
Copy link

Short question regarding the following snippet of the current specs regarding the navigation endpoint (https://distributed-text-services.github.io/specifications/versions/unstable/):

For example, if the ref is at the bottom level of the queried CitationTree, and a down of 2 is provided in the request, the response will provide an empty array as its member value.

In other places the specs mention that all possible matches should be included as members; starting from (and including) the member identified by ?ref. So I would assume that in the cited example the member array would include exactly that single ref-member, right?

@kbrueckmann kbrueckmann changed the title member value for ?ref-queries with no match member value for &ref-queries with no match Oct 11, 2024
@PonteIneptique
Copy link
Member

Hi @kbrueckmann ! Your question fell in a blackhole on my side.

I think you are referring about

Down Ref start / end Behavior
> 0 absent absent A member array of CitableUnits including the citation tree from the root to the depth requested in down.
> 0 present absent A member array of CitableUnits including the citation tree from the CitableUnit identified by ref to the depth requested in down.

but you are right that technically, in "Example 3: Requesting all descendants of one top-level CitableUnit of a Resource", we are showing that the tree includes the root, which would be then contradicted by "For example, if the ref is at the bottom level of the queried CitationTree, and a down of 2 is provided in the request, the response will provide an empty array as its member value.".

We need consistency here, I would probably agree with you that it should include the root element only. What do you think @hcayless @monotasker ?

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

No branches or pull requests

2 participants