Reviving this thread again since there is a little bit of ambiguity where these fields are part of the schema but their behavior is not technically described in the upstream specification. i.e. "documentDescribes" isn't in the ISO spec definition.
Would the resolution be to push for the JSON schema to be incorporated into the spec via its serialization specification or to remove these fields or make them optional in the JSON schema? Please help correct my understanding if i've missed something! Thanks Brandon On Wed, Jan 4, 2023 at 11:16 PM Brandon Lum via lists.spdx.org <lumb= google....@lists.spdx.org> wrote: > Awesome! Thanks for the context and clarification Gary! > > On Thu, Jan 5, 2023 at 8:09 AM Gary O'Neall <g...@sourceauditor.com> > wrote: > >> Hi Brandon, >> >> >> >> I believe it is safe to ignore the v2.2.0 JSON schema. >> >> >> >> The “describesPackages” was deprecated on release 2.0 of the spec and is >> only used for compatibility with pre 2.0 spec version using the RDF >> format. There is an open issue to remove this property >> <https://github.com/spdx/spdx-spec/issues/534>. It was probably in the >> 2.2.0 JSON schema due to it being generated from the RDF schema which still >> has the deprecated property. It looks like PR #528 >> <https://github.com/spdx/spdx-spec/pull/528/files> is where the property >> was replaced with the more appropriate “documentDescribes”. >> >> >> >> In the past, we’ve used the JSON examples as the primary documentation >> for the JSON format. With the fixes from PR 528, we should be able to use >> both the JSON Schema and the examples. The documentation for the JSON >> format should be dramatically improved in the 3.0 spec. >> >> >> >> Cheers, >> Gary >> >> >> >> >> >> *From:* Spdx-tech@lists.spdx.org <Spdx-tech@lists.spdx.org> *On Behalf >> Of *Brandon Lum via lists.spdx.org >> *Sent:* Wednesday, January 4, 2023 1:13 AM >> *To:* SPDX Technical Mailing List <Spdx-tech@lists.spdx.org> >> *Subject:* [spdx-tech] clarification around "documentDescribes" field >> >> >> >> Hi! >> >> >> >> An issue <https://github.com/spdx/tools-golang/issues/166> was opened in >> tools-golang around the missing "documentDescribes" field, which is part of >> the JSON schema. >> >> >> >> For v2.2.1 and above, the field is present, however, in v2.2.0 of the >> spec >> <https://github.com/spdx/spdx-spec/blob/v2.2/schemas/spdx-schema.json>, >> it looks like the field is called "describesPackages", however, in the same >> tag, the v2.2.0 example >> <https://github.com/spdx/spdx-spec/blob/v2.2/examples/SPDXJSONExample-v2.2.spdx.json#L58> >> uses "documentDescribes". >> >> >> >> Based on some of the wording from Gary's Java library around 2020, and >> looking through the v2.2.0 docs, i'm guessing that the JSON spec was still >> not fully approved then... So it should be safe to ignore the v2.2.0 JSON >> schema spec? >> >> >> >> Cheers >> >> Brandon >> >> > > -=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#4968): https://lists.spdx.org/g/Spdx-tech/message/4968 Mute This Topic: https://lists.spdx.org/mt/96047024/21656 Group Owner: spdx-tech+ow...@lists.spdx.org Unsubscribe: https://lists.spdx.org/g/Spdx-tech/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
