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

Manifest Resource Cannot Accurately Specify All Media Types and Version Combinations #36

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

Comments

@jordan2175
Copy link

jordan2175 commented Jan 24, 2018

For each object, the manifest resource specifies a list of versions and a list of media types. However, not all version and media type combinations are necessarily valid. For instance, a Collection may contain an object where v1 is available as STIX 2.0, and v2 is available as both STIX 2.0 and STIX 2.1. The manifest resource cannot accurately specify this condition.

The proposed change is to:
Reduce the scope of each manifest resource from "one manifest for all versions of an object" to "one manifest per object version and media type"
Modify the Manifest resource to permit only a single value for object version and media type.

This change breaks backward compatibility, and the impact is estimated to be moderate. While a large portion of the specification will change in a backward incompatible way (Section 5.6), the STIX2/TAXII2 Preferred program does not consider this area of the specification, and few implementations have implemented this area of the spec.
We discussed this at the F2F and the consensus in the room was that we should make the proposed change to the manifest resource.

This will solve the various pagination problems that exist. This means the object id, date_added, and version would just be a simple string and each "version" of an object will have its own entry in the manifest objects list. Fixing this will also resolve issue #30

@jordan2175
Copy link
Author

We talked about this at the F2F and the consensus of the room was to make this change. That is change version and media_type to be single strings and due atomic elements for manifest resources.

@jordan2175 jordan2175 changed the title Changes to manifest resource Manifest Resource Cannot Accurately Specify All Media Types and Version Combinations Feb 5, 2018
@jordan2175
Copy link
Author

jordan2175 commented Feb 21, 2018

After discussion at the F2F and over slack, this issue was sent to the email list twice, asking for objections. Since no objections were given, this has been implemented. The changes were made in section 5.6.1. Just to be clear, the version and media_type properties were changed from being a list of strings to a single string. This also means that the plurality of the property names as also changes to be singular.

The manifest type description now says:

The manifest-entry type captures metadata about a single version of an object, indicated by the id property. The metadata includes information such as when that version of the object was added to the Collection, the version of the object itself, and the media type that this specific version of the object is available in.

The version property description is now greatly simplified to be just:

The version of this object. For objects in STIX format, the STIX modified field is the version.

@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