How to hide/reveal fields
This only applies to API V2 venues
As a venue organizer, you may hide fields in a comment or a submission. Comments (decisions, reviews, official comments, public comments, etc.) and submissions are represented by Notes in OpenReview.
If you want to restrict the visibility of a field to specific users, use the
readers property. You can use this property to hide fields that have sensitive information such as the name of the authors in a submission.To apply this feature, simply add the readers property to that particular field in the Invitation. Please see the speficiers section to know the different options you have when defining the
readers field.restricted_field: {
value: {
param: {
type: 'string',
optional: true
}
},
readers: {
param: {
regex: '^~.*$|OpenReview\.net\/Conference'
deletable: true
}
}
}
Adding the readers property is not sufficient for the field to be hidden. You still need to post an Edit including the value of the readers field. The following change only allows the users in the
readers field to see restricted_field.restricted_field: {
value: 'Not for your eyes',
readers: [ '~Author_One1', '~Author_Two1', 'OpenReview.net/Conference' ]
}
In case the Invitation does not allow a field to include a readers field and modifying it is not possible, there are two options around it. You can create a new Invitation whose sole purpose is to allow the readers property to be included in the field or use the Meta Invitation. Below is an example of what an Edit would look like that hides a field.
{
invitation: 'OpenReview.net/Conference/-/Edit',
signatures: [ 'OpenReview.net/Conference' ],
readers: [ 'OpenReview.net/Conference' ],
writers: [ 'OpenReview.net/Conference' ],
note: {
id: 'noteId1234',
content: {
restricted_field: {
readers: [ '~Author_One1', '~Author_Two1', 'OpenReview.net/Conference' ]
}
}
}
}
If you want to reveal the value of the
restricted_field, you need to remove the readers property from the field. You may do that by passing the { delete: true }. The Invitation needs to allow the field to be deleted with the property { deletable: true } as shown above.restricted_field: {
value: 'For your eyes',
readers: { 'delete': true }
}
In case an Invitation does not allow a field to be deleted, there are two options around it. You can create a new Invitation whose sole purpose is to delete the readers property or use the Meta Invitation. The syntax to remove the
readers field is the same as the one shown above when using the Meta Invitation.{
invitation: 'OpenReview.net/Conference/-/Edit',
signatures: [ 'OpenReview.net/Conference' ],
readers: [ 'OpenReview.net/Conference' ],
writers: [ 'OpenReview.net/Conference' ],
note: {
id: 'noteId1234',
content: {
restricted_field: {
readers: { 'delete': true }
}
}
}
}