Draft
Conversation
- created "accessURL" property to create a way to link to the Document - added "accessURL" to 'required' array - removed $id field from all properties (subschemas) - added 'individual author' property from documentation to jsonschema; key/name: "creator" - 'corporate author': adjusted key/name to "corporateCreator" - 'publisher(s) as a literal': changed from a string to an array of strings; matches documentation and makes sense - 'document type': adjusted key/name to "type" and title to "document type"; originally "category" - 'conformsTo': adjusted title to "conforms to"; matches documentation - 'mediaType': changed cardinality from 0..n to 0..1 (i.e., no longer an array) in line with James's recommendation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Should resolve: #75
Relevant Documentation: Document
Changes to Document.json
accessURLproperty to create a way to link to theDocumentaccessURLto 'required' arraymediaType- changed cardinality from 0..n to 0..1 (i.e., no longer an array) in line with James's recommendationindividual authorproperty from documentation; key/name:creatorcorporate author- adjusted key/name tocorporateCreatorpublisher(s) as a literal- changed from a string to an array of strings; matches documentation and makes sensedocument type- adjusted key/name totypeand title to "document type"; both originallycategoryconformsTo- adjusted title to "conforms to"; matches documentationDiscussion Topics
mediaType- could a singleDocumenthave multiplemediaTypes? What if a piece of documentation can be accessed as a .docx, .pdf, or .html file?individual authorandcorporate authorbe an array rather than a single entry? If we did this, we could potentially consolidate the duplicative properties into one.identifier- should it be changed from an array of strings to a string (e.g., from 0..n to 0..1)? We changed this forDatasetbut it has theotherIdentifierproperty andDocumentdoes not.Documentation and jsonschema Desynchronization
I don't think these are particularly important to fix, and I also know we've discussed ditching the HTML documentation and generating the documentation from the jsonschema, but I thought I would list what I noticed here anyways:
title- cardinality is 1..n in documentation, jsonschema is 1; does the language map change the cardinality?publisher- title is "publisher", but documentation says "publisher organization"identifier- cardinality is 0..1 in documentation, jsonschema is 0..npublication date(i.e., issued) - cardinality is 0..1 in jsonschema and class description, but is 0..n in property descriptionabstract- cardinality is 0..n in documentation, jsonschema is 0..1; does the language map change the cardinality?description- cardinality is 0..n in documentation, jsonschema is 0..1; does the language map change the cardinality?