| Wiki Markup |
|---|
h4. This page is for json schema properties of type "string" who may (or may not) need a regular expression to help define allowed instances. |
...
Page will be organized into json schemas, and will list all "string" type properties, logical rules for defining those properties, if they need a pattern, and a suggested regular expression for the properties that do need a pattern. |
...
h2. Entity.json |
...
name
Logical Rules
- must be a sting
- can be more than one word
- can have letters
- can have symbols
Needs Pattern = no
description
Logical Rules
- must be a string
Needs Pattern = no
id
Logical Rules
- represented as a long
- can only be digits
- must be a size that will fit into a java long
- will never be a negative
Needs Pattern = yes
Suggested Regular Expression =
uri
Logical Rules
...
h5. name Logical Rules * must be a sting * can be more than one word * can have letters * can have symbols Needs Pattern = no h5. description Logical Rules * must be a string Needs Pattern = no h5. id Logical Rules * represented as a long * can only be digits * must be a size that will fit into a java long * will never be a negative Needs Pattern = yes Suggested Regular Expression = "\\d{1,}" h5. uri Logical Rules * will be "synapse.sagebase.org/#" |
...
* after the pound will be the type of entity, etc |
...
Needs Pattern = yes |
...
Suggested Regular Expression = |
...
version
Logical Rules
...
h5. version Logical Rules * will be in format 1.0.0 |
...
* so numbers, period, numbers, period, numbers |
...
Needs Pattern = yes |
...
Suggested Regular Expression = |
...
etag
Logical Rules
- made up of a db long
- default is 0
- can only be digits
- must fit in a java long
- will never be a negative
Needs Pattern = yes
Suggested Regular Expression =
createdOn
Logical Rules
- in the form of java.util.Date
- string must conform to that structure
Needs Pattern = yes
Suggested Regular Expression =
modifiedOn
Logical Rules
- java.util.Date
- string must conform to that structure
Needs Pattern = yes
Suggested Regular Expression =
createdBy
Logical Rules
- in the form of an email address
- can also be a single word
- letters and supported email characters only
- no whitespace
- example is admin@sagebase.org
Needs Pattern = yes
Suggested Regular Expression =
modifiedBy
Logical Rules
- in the form of an email address
- can also be a single word
- letters and supported email characters only
- no whitespace
- example is admin@sagebase.org
Needs Pattern = yes
Suggested Regular Expression =
annotations
Logical Rules
- are strings
- can be different number of words
- can contain symbols
Needs Pattern = no
accessControlList
Logical Rules
...
h5. etag Logical Rules * made up of a db long * default is 0 * can only be digits * must fit in a java long * will never be a negative Needs Pattern = yes Suggested Regular Expression = "\\d{1,}" h5. createdOn Logical Rules * in the form of java.util.Date * string must conform to that structure Needs Pattern = yes Suggested Regular Expression = h5. modifiedOn Logical Rules * java.util.Date * string must conform to that structure Needs Pattern = yes Suggested Regular Expression = h5. createdBy Logical Rules * in the form of an email address * can also be a single word * letters and supported email characters only * no whitespace * example is admin@sagebase.org Needs Pattern = yes Suggested Regular Expression = h5. modifiedBy Logical Rules * in the form of an email address * can also be a single word * letters and supported email characters only * no whitespace * example is admin@sagebase.org Needs Pattern = yes Suggested Regular Expression = h5. annotations Logical Rules * are strings * can be different number of words * can contain symbols Needs Pattern = no h5. accessControlList Logical Rules * example "/project/17496/acl" |
...
* example"/dataset/17497/acl" |
...
* must be a front-slash, supported type, front-slash, id, "acl" |
...
Needs Pattern = yes |
...
Suggested Regular Expression = |
...
parentId
Logical Rules
- represented by a long
- will never be negative
- must be digits only
- must fit into java long
Needs Pattern = yes
...
h5. parentId
Logical Rules
* represented by a long
* will never be negative
* must be digits only
* must fit into java long
Needs Pattern = yes
Suggested Regular Expression = "\\d{1,}" |