- Mar 2019
-
internal-developer.veevavault.com internal-developer.veevavault.com
-
This option
Should move the "If omitted" as the last sentence. Otherwise, are we talking about the "set to true" option here? Or the option to omit?
-
not specified
Should be "If omitted" to be consistent
-
/api/{version}/query
I believe this looks "darkened" because you have both the code class endpt AND also backticks. It should only be the code class endpt
-
-
internal-developer.veevavault.com internal-developer.veevavault.com
-
FIELD_NAME
should be lowercase
-
LIKE
This is the section where we should move the wildcard paragraph to, from the "LongText Field Type" section
-
In addition, VQL does not support LIKE that starts with a wildcard (%). For example, name__v LIKE '%_DOC' will not work. If the wildcard is in the middle or the end of the LIKE, it works as expected. For example, name__v LIKE 'DOC%'. All other clauses besides LIKE work as expected with leading wildcards.
OMG there is a perfect place to put this now! We should move this paragraph to the LIKE section, under the WHERE clause of Syntax & Structure
-
’%’
code styling typo
-
OR
code taga
-
OR
code taga
-
OR
code tags?
-
Note that VQL does not support using the OR operator between different query objects in a WHERE clause.
Maybe an example of something that would not work? Because it kind of looks like there is an OR in a where clause below
-
Equal to (=)
I think only the "=" should be in code tags? Because "=" is the operator, "Equal to" is just a description.
I actually don't think we need this description at all, because we have a description column. We can neaten this column up to just have the operator
-
Learn more about operators below.
I would link this or remove it
-
Field
Is there a reason "Field" is capitalized here? In the SELECT example it is not capitalized
-
FIND, ORDER BY, WHERE
code styling? (omitting commas)
-
LIKE
code styling?
-
LIKE
code styling?
-
LIKE
code styling?
-
LongText
code styling?
-
LongText
code styling?
-
SELECT
code styling
-
17.1
v17.1
-
not queryable
remove italics
-
VERSION
this should be lowercase, but again this is a nice to have
-
GET
we could use the "success" styling here instead to make this green... nice to have, not urgent
-
V
lowercase v
-
In Vault, “objects” are divided into three main categories:
Maybe we should just say "Vault Objects are divided into the following categories:"
Because it says "three" here and clearly there are more than three. Also I think putting objects in quotes like this may be confusing?
-
API Transaction Limits
Maybe add a bullet here to learn more about API rate limits?
We have a nice detsiled section about it in the API reference: https://internal-developer.veevavault.com/docs/#api-rate-limits
-
limit
we should mention this is called "Daily Limit".
-
limit
we should mention this is called "Burst Limit".
-
ORDER BY rank
code styling instead of bold?
-
FIND
code styling instead of bold?
-
ORDER BY
code styling instead of bold?
-
OFFSET
code styling instead of bold?
-
"
There is an open quote here, so I think this needs an end quote?
-
Using the filter
Maybe we should indent this bullet? Because it's kind of like a sub-bullet to the first one? An example
-
Field Values
Good examples here! Very easy to understand
-
lower-case
I've written this word a few times and I am not hyphenating it. I think we should standardize to use no hyphen (unless you want to fight - I mean discuss this with me :P)
-
for
I think we should remove this word?
-
“Dosage
needs closing quotes
-
Ns
is there a space between these words?
-
all
maybe no italics here?
-
LATESTVERSION
code tag here
-
(even if it’s not the absolute latest version)
I don't know what latest version vs absolute latest version means
-
('properties’), or both ('all’)
Code highlighting error
-
'content’
Code highlighting error
-
‘SCOPE’
Code highlighting error
-
WonderDrug Information
Maybe the table or lead-in sentence to the table above should mention this document name?
-
Notes
Should this be "Version Description" instead of Notes? When a user creates a new version, there is a description just for this version called Version Description
-
By default, queries only include the latest version.
does this mean they use LATESTVERSION by default?
-
},
Similar comment here that this isn't ended properly, it looks cut off
-
Name
I'm not sure why this isn't "label__v"
-
”
These should be "straight quotes" rather than curly quotes
-
Below
Should this have a comma after it? Kind of like starting a sentence with "After" or "Next", I think they're always supposed to have a comma. But I agree with the comma it still looks weird.
Maybe we can re-write this to say "For example, perhaps you want to create a query on the
id
field. To check if this field is queryable, we need to call the metadata API as shown in the example below. The response shows..." -
Query API
Oddly, this is the first time the reader encounters this term. I think this is synonymous with "VQL"?
In the first overview paragraph we should mention this term to make sure readers know what this is
-
see
this link does not work (looks like wrong ID)
-
},
a comma indiates there is more to come (a comma like this at the end would cause a syntax error). We should also end the quare bracket we opened previously
I believe this should be:
"file 2"}]
-
{
If we are including the opening bracket here, we should have a closing bracket at the end as well
-
Name
should this be label__v?
-
Additional syntax can control how your results display:
The example below this does not display additional syntax. Maybe we want to end this sentence, and have a new sentence which says "The following is a skeleton for a VQL query:" or similar?
-
,
I think this comma should be removed? Something about this sentence is not making sense
-
(VQL)
The parens seem out of place here. Maybe we can just omit them?
-
/
Needs ending curly brace ( } )
-
-
internal-developer.veevavault.com internal-developer.veevavault.com
-
V
Should be lowercase "v"
-