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

Statements About Sorting Appear to Conflict But on Closer Reading Do Not - Needs Clarification #39

Closed
jordan2175 opened this issue Jan 29, 2018 · 2 comments

Comments

@jordan2175
Copy link

In section 3.3, sorting, we have a conflicting statement.

For the Collection and Manifest Endpoints, objects MUST be sorted in ascending order by the date the object first appeared in the TAXII Collection (i.e., the added date).

Then further down we have

For the Collections Endpoint, Collections MUST be sorted and MAY be sorted in any order.

@jordan2175
Copy link
Author

jordan2175 commented Feb 1, 2018

Section 3.3, which discusses sorting, is worded such that many first-time readers incorrectly conclude that the specification makes incompatible statements about sorting rules.

The proposed change is that the wording be clarified so that first-time readers do not make this conclusion. Normative changes are not proposed.

We talked about this at the F2F and have proposed text in the document to address this.

@jordan2175 jordan2175 changed the title Conflicting statement in sorting section of specification Statements about Sorting Appear to Conflict, Don't Feb 5, 2018
@jordan2175 jordan2175 changed the title Statements about Sorting Appear to Conflict, Don't Statements About Sorting Appear to Conflict But on Closer Reading Do Not - Needs Clarification Feb 5, 2018
@jordan2175
Copy link
Author

In section 3.3 the text now reads, and I believe is more clear for first time readers:

For Object and Manifest Endpoints, objects returned MUST be sorted in ascending order by the date the object first appeared in the TAXII Collection (i.e., the added date). The most recently added object is last in the list.

The Collections Endpoint MUST return Collection Resources in a consistent sort order across multiple requests.

@jordan2175 jordan2175 added this to the TAXII-2.1-CSD01 milestone Feb 22, 2018
@jordan2175 jordan2175 added this to Done in TAXII-2.1 Feb 22, 2018
@jordan2175 jordan2175 removed this from Done in TAXII-2.1 Feb 22, 2018
@jordan2175 jordan2175 added this to Done in TAXII-2.1 Feb 22, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
TAXII-2.1
  
Done
Development

No branches or pull requests

1 participant