first commit
This commit is contained in:
CHIEFSOFT\ameye
@@ -0,0 +1,121 @@
|
||||
{
|
||||
"title": "Announcement",
|
||||
"description": "An announcement or news item.",
|
||||
"required": [
|
||||
"assocType",
|
||||
"title"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"description": "The URL to this announcement in the REST API.",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"assocId": {
|
||||
"type": "integer",
|
||||
"description": "The journal, press or preprint server ID. Null for site-level announcements.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"assocType": {
|
||||
"type": "integer",
|
||||
"description": "The assoc object. This should always be `ASSOC_TYPE_JOURNAL` (OJS), `ASSOC_TYPE_PRESS` (OMP) or `ASSOC_TYPE_SERVER` (OPS).",
|
||||
"apiSummary": true
|
||||
},
|
||||
"dateExpire": {
|
||||
"type": "string",
|
||||
"description": "(Optional) The date that this announcement expires, if one is set. This is typically used to express closing dates for calls for papers.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"date_format:Y-m-d"
|
||||
]
|
||||
},
|
||||
"datePosted": {
|
||||
"type": "string",
|
||||
"description": "The date this announcement was posted.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"date_format:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "The full text of the announcement.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"descriptionShort": {
|
||||
"type": "string",
|
||||
"description": "A summary of this announcement.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"image": {
|
||||
"type": "object",
|
||||
"description": "The image to show with this announcement.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"altText": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"typeId": {
|
||||
"type": "integer",
|
||||
"description": "(Optional) One of the announcement type ids.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true,
|
||||
"description": "The URL to the published announcement."
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,135 @@
|
||||
{
|
||||
"title": "Author",
|
||||
"description": "An author of a publication.",
|
||||
"required": [
|
||||
"email",
|
||||
"givenName",
|
||||
"publicationId",
|
||||
"userGroupId"
|
||||
],
|
||||
"properties": {
|
||||
"affiliation": {
|
||||
"type": "string",
|
||||
"description": "The scholarly institution this contributor is employed by or affiliated with.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"biography": {
|
||||
"type": "string",
|
||||
"description": "An optional bio statement about this contributor.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"competingInterests": {
|
||||
"type": "string",
|
||||
"description": "A declaration of potential competing interests.",
|
||||
"multilingual": "true"
|
||||
},
|
||||
"country": {
|
||||
"type": "string",
|
||||
"description": "The author's country in a two-letter code (ISO 3166-1). See [all codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"country",
|
||||
"regex:/^[A-Z]{2}$/"
|
||||
]
|
||||
},
|
||||
"email": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"email_or_localhost"
|
||||
]
|
||||
},
|
||||
"familyName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"fullName": {
|
||||
"type": "string",
|
||||
"description": "The full name of the author. This will be the preferredPublicName or, if that is not available, a string containing the givenName and familyName.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"givenName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"includeInBrowse": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not to include this contributor in author lists when the publication appears in search results, tables of content and catalog entries.",
|
||||
"default": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The primary locale of the submission this author is attached to. This locale is used as the fallback when a language is missing from a multilingual property.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"orcid": {
|
||||
"type": "string",
|
||||
"description": "The ORCID of this contributor. See: https://orcid.org/",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"orcid"
|
||||
]
|
||||
},
|
||||
"preferredPublicName": {
|
||||
"type": "string",
|
||||
"description": "An optional field for contributors to specify how they prefer to be identified in this publication.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"publicationId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"seq": {
|
||||
"type": "integer",
|
||||
"description": "The order in which this contributor should appear in a list of contributors.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"description": "An optional URL to this contributor's webpage.",
|
||||
"validation": [
|
||||
"url",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"userGroupId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of this contributor's assigned user group. See userGroupName.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"userGroupName": {
|
||||
"type": "string",
|
||||
"description": "The name of this contributor's role in the publication, such as 'Author' or 'Translator'.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
{
|
||||
"title": "Category",
|
||||
"description": "A category of content.",
|
||||
"required": [
|
||||
"contextId",
|
||||
"path",
|
||||
"title"
|
||||
],
|
||||
"properties": {
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"description": "The journal, press or preprint server ID.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"sequence": {
|
||||
"type": "number",
|
||||
"description": "The sequence number for this category (for ordering)",
|
||||
"apiSummary": true
|
||||
},
|
||||
"parentId": {
|
||||
"type": "integer",
|
||||
"description": "The optional ID of the parent category.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"sortOption": {
|
||||
"type": "string",
|
||||
"description": "The sorting order for contents of this category.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "The title of the category.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "A description of the category.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"path": {
|
||||
"type": "string",
|
||||
"description": "A URL slug for this category.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"image": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,884 @@
|
||||
{
|
||||
"title": "Context",
|
||||
"description": "A journal or press.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"name",
|
||||
"primaryLocale",
|
||||
"supportedLocales",
|
||||
"urlPath",
|
||||
"contactName",
|
||||
"contactEmail"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"about": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"acronym": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"additionalHomeContent": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"agencies": {
|
||||
"type": "string",
|
||||
"description": "Enable agencies metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"announcementsIntroduction": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"authorGuidelines": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.authorGuidelines",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"authorInformation": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.forAuthors",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"automaticDoiDeposit": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"beginSubmissionHelp": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"defaultLocaleKey": "default.submission.step.beforeYouBegin"
|
||||
},
|
||||
"citations": {
|
||||
"type": "string",
|
||||
"description": "Enable citations metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"competingInterests": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"contactAffiliation": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"contactEmail": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"email_or_localhost"
|
||||
]
|
||||
},
|
||||
"contactName": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"contactPhone": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"contributorsHelp": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"defaultLocaleKey": "default.submission.step.contributors"
|
||||
},
|
||||
"copyrightHolderType": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:author,context,other"
|
||||
]
|
||||
},
|
||||
"copyrightHolderOther": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"copyrightNotice": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"country": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"country"
|
||||
]
|
||||
},
|
||||
"coverage": {
|
||||
"type": "string",
|
||||
"description": "Enable coverage metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"currency": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"currency"
|
||||
]
|
||||
},
|
||||
"customHeaders": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dateFormatLong": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dateFormatShort": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"datetimeFormatLong": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"datetimeFormatShort": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"defaultReviewMode": {
|
||||
"type": "integer",
|
||||
"default": 2,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:1,2,3"
|
||||
]
|
||||
},
|
||||
"defaultMetricType": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"detailsHelp": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"defaultLocaleKey": "default.submission.step.details"
|
||||
},
|
||||
"disableBulkEmailUserGroups": {
|
||||
"type": "array",
|
||||
"description": "User groups that a manager will be prevented from sending bulk email to using the notify feature. Only the admin may edit this property.",
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"disableUserReg": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"disciplines": {
|
||||
"type": "string",
|
||||
"description": "Enable disciplines metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"requireAuthorCompetingInterests": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"editorialTeam": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"copySubmissionAckPrimaryContact": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "A copy of the submission acknowledgement email will be sent to this context's primary contact when true.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"copySubmissionAckAddress": {
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"description": "A copy of the submission acknowledgement email will be sent to any of the email addresses entered here. Separate multiple email addresses with a comma. Example: one@example.com,two@example.com",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"emailSignature": {
|
||||
"type": "string",
|
||||
"defaultLocaleKey": "default.contextSettings.emailSignature",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableAnnouncements": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableDois": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"doiPrefix": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^10\\.[0-9]{4,7}$/",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"doiSuffixType": {
|
||||
"type": "string",
|
||||
"default": "default"
|
||||
},
|
||||
"registrationAgency": {
|
||||
"type": "string",
|
||||
"default": "",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"doiPublicationSuffixPattern": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"doiRepresentationSuffixPattern": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"disableSubmissions": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"editorialStatsEmail": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not to send the monthly editorial statistics email to editors. Default: `true`",
|
||||
"default": true
|
||||
},
|
||||
"enableClockss": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enabled": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"enableLockss": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"envelopeSender": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"email_or_localhost"
|
||||
]
|
||||
},
|
||||
"favicon": {
|
||||
"type": "object",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"altText": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"forTheEditorsHelp": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"defaultLocaleKey": "default.submission.step.forTheEditors"
|
||||
},
|
||||
"homepageImage": {
|
||||
"type": "object",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"altText": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"itemsPerPage": {
|
||||
"type": "integer",
|
||||
"default": 25,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"keywords": {
|
||||
"type": "string",
|
||||
"default": "request",
|
||||
"description": "Enable keywords metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"languages": {
|
||||
"type": "string",
|
||||
"description": "Enable languages metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"librarianInformation": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.forLibrarians",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"licenseUrl": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"mailingAddress": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"notifyAllAuthors": {
|
||||
"type": "boolean",
|
||||
"default": true,
|
||||
"description": "When enabled, all authors of a submission will receive a notification when an editorial decision is made regarding a submission. When disabled, only authors assigned to the submission will be notified.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"numAnnouncementsHomepage": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"numDaysBeforeInviteReminder": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"numDaysBeforeSubmitReminder": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"numPageLinks": {
|
||||
"type": "integer",
|
||||
"default": 10,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"numWeeksPerResponse": {
|
||||
"type": "integer",
|
||||
"default": 4,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"numWeeksPerReview": {
|
||||
"type": "integer",
|
||||
"default": 4,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"openAccessPolicy": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.openAccessPolicy",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"pageFooter": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"pageHeaderLogoImage": {
|
||||
"type": "object",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"altText": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"paymentsEnabled": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"primaryLocale": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
},
|
||||
"privacyStatement": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.privacyStatement",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"rateReviewerOnQuality": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"readerInformation": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.forReaders",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"restrictReviewerFileAccess": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"restrictSiteAccess": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"reviewerAccessKeysEnabled": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"reviewGuidelines": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"reviewHelp": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"defaultLocaleKey": "default.submission.step.review"
|
||||
},
|
||||
"rights": {
|
||||
"type": "string",
|
||||
"description": "Enable rights metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"searchDescription": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"seq": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"showEnsuringLink": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"sidebar": {
|
||||
"type": "array",
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"alpha_dash"
|
||||
]
|
||||
}
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"description": "Enable source metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"styleSheet": {
|
||||
"type": "object",
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"subjects": {
|
||||
"type": "string",
|
||||
"description": "Enable subjects metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"submissionAcknowledgement": {
|
||||
"type": "string",
|
||||
"description": "Which authors should receive an email confirmation when a new submission is submitted, which acknowledges that their submission was submitted. When empty, the author will not be sent an email. Default: `allAuthors`",
|
||||
"default": "allAuthors",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:,submittingAuthor,allAuthors"
|
||||
]
|
||||
},
|
||||
"submissionChecklist": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"defaultLocaleKey": "default.contextSettings.checklist"
|
||||
},
|
||||
"submitWithCategories": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Whether or not submitting authors should be asked to select categories when they make a new submission."
|
||||
},
|
||||
"supportedFormLocales": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
}
|
||||
},
|
||||
"supportedLocales": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
}
|
||||
},
|
||||
"supportedSubmissionLocales": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
}
|
||||
},
|
||||
"supportEmail": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"email_or_localhost"
|
||||
]
|
||||
},
|
||||
"supportName": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"supportPhone": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"themePluginPath": {
|
||||
"type": "string",
|
||||
"default": "default"
|
||||
},
|
||||
"timeFormat": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Enable types metadata. `0` is disabled. `enable` will make it available in the workflow. `request` will allow an author to enter a value during submission. `require` will require that the author enter a value during submission.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
},
|
||||
"uploadFilesHelp": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"defaultLocaleKey": "default.submission.step.uploadFiles"
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"urlPath": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^[a-zA-Z0-9]+([\\-_][a-zA-Z0-9]+)*$/"
|
||||
],
|
||||
"apiSummary": true
|
||||
},
|
||||
"enableGeoUsageStats": {
|
||||
"type": "string",
|
||||
"description": "Whether to track usage statistics by location, and whether to track at the country, region or city level.",
|
||||
"default": "disabled",
|
||||
"validation": [
|
||||
"in:disabled,country,country+region,country+region+city"
|
||||
]
|
||||
},
|
||||
"enableInstitutionUsageStats": {
|
||||
"type": "boolean",
|
||||
"description": "Whether to track usage statistics by institutions. Requires institutional IP ranges to be configured.",
|
||||
"default": false
|
||||
},
|
||||
"isSushiApiPublic": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not the access to the COUNTER SUSHI statistics API is public. If false, only users with admin or manager roles can access the API.",
|
||||
"default": true
|
||||
},
|
||||
"dataAvailability": {
|
||||
"type": "string",
|
||||
"description": "Whether to not request, request or require a Data Availability Statement from the authors.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,enable,request,require"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,94 @@
|
||||
{
|
||||
"title": "Editorial Decision",
|
||||
"description": "An editorial decision such as accept, decline or request revisions.",
|
||||
"required": [
|
||||
"dateDecided",
|
||||
"decision",
|
||||
"editorId",
|
||||
"stageId",
|
||||
"submissionId"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"description": "The URL to this decision in the REST API.",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"actions": {
|
||||
"type": "array",
|
||||
"description": "Optional. A list of actions to be taken with this decision, such as sending an email. Each decision supports different actions. See the request body examples for supported decision actions.",
|
||||
"writeOnly": true,
|
||||
"items": {
|
||||
"type": "object"
|
||||
}
|
||||
},
|
||||
"dateDecided": {
|
||||
"type": "string",
|
||||
"description": "The date the decision was taken.",
|
||||
"writeDisabledInApi": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"date_format:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"decision": {
|
||||
"type": "integer",
|
||||
"description": "The decision that was made. One of the `Decision::*` constants.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "A user-facing description of this decision type.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"editorId": {
|
||||
"type": "integer",
|
||||
"description": "The user id of the editor who took the decision.",
|
||||
"writeDisabledInApi": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"label": {
|
||||
"type": "string",
|
||||
"description": "A short label or name for this decision type.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"reviewRoundId": {
|
||||
"type": "integer",
|
||||
"description": "The unique id of the review round when this decision was taken. Do not include this if the decision is not recorded in a review stage. This is a globally unique id. It does not represent whether the decision was taken in the first or second round of reviews for a submission. See `round` below.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"round": {
|
||||
"type": "integer",
|
||||
"description": "The sequential review round when this decision was taken. For example, the first, second or third round of review for this submission. Do not include this unless using `reviewRoundId`.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"stageId": {
|
||||
"type": "integer",
|
||||
"description": "The workflow stage when this decision was taken. One of the `WORKFLOW_STAGE_ID_` constants.",
|
||||
"writeDisabledInApi": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"min:1",
|
||||
"max:5"
|
||||
]
|
||||
},
|
||||
"submissionId": {
|
||||
"type": "integer",
|
||||
"description": "The decision applies to this submission.",
|
||||
"writeDisabledInApi": true,
|
||||
"apiSummary": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
{
|
||||
"title": "DOI",
|
||||
"description": "The Digital Object Identifier (DOI) is a persistent ID assigned to published items.",
|
||||
"required": [
|
||||
"contextId",
|
||||
"doi"
|
||||
],
|
||||
"properties": {
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"description": "The context this DOI was created by.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true
|
||||
},
|
||||
"doi": {
|
||||
"type": "string",
|
||||
"description": "The DOI itself, such as `10.1234/5a6b-7c8d`.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"regex:/^\\d+(.\\d+)+\\//"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"description": "An internal id used to track the DOI.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"resolvingUrl": {
|
||||
"type": "string",
|
||||
"description": "The full URL to resolve the DOI, such as `https://doi.org/10.1234/5a6b-7c8d`.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"status": {
|
||||
"type": "integer",
|
||||
"description": "The status of the DOI, such as whether it has been successfully deposited. Must match the value of one of the following: `Doi::STATUS_UNREGISTERED`, `Doi::STATUS_SUBMITTED`, `Doi::STATUS_REGISTERED`, `Doi::STATUS_ERROR`, `Doi::STATUS_STALE`.",
|
||||
"apiSummary": true,
|
||||
"default": 1,
|
||||
"validation": [
|
||||
"in:1,2,3,4,5"
|
||||
]
|
||||
},
|
||||
"registrationAgency": {
|
||||
"type": "string",
|
||||
"description": "The agency with which the DOI is registered. If the DOI was manually marked registered, this will be `null`.",
|
||||
"apiSummary": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
{
|
||||
"title": "Email Template",
|
||||
"description": "A saved email message that can be sent by the application during registration, submission, peer review and all other operations of the application.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"contextId",
|
||||
"body",
|
||||
"name",
|
||||
"subject"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"alternateTo": {
|
||||
"type": "string",
|
||||
"description": "The `key` of another email template. This is used to assign a custom template to a `Mailable`. The value of `alternateTo` must match the email template key of a `Mailable`.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"body": {
|
||||
"type": "string",
|
||||
"description": "The email template to be used in the email's main body content.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the context (journal/press) this email is related to. Only used for custom email templates. Default is `null`.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"description": "The email template ID.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"key": {
|
||||
"type": "string",
|
||||
"description": "A unique key for this email template.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "A name for this email template.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"max:255"
|
||||
]
|
||||
},
|
||||
"subject": {
|
||||
"type": "string",
|
||||
"description": "The subject of the email to be used in the email's subject header.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,259 @@
|
||||
{
|
||||
"title": "Event Log",
|
||||
"description": "Logged action taken regarding the submission.",
|
||||
"required": [
|
||||
"assocType",
|
||||
"assocId",
|
||||
"dateLogged"
|
||||
],
|
||||
"properties": {
|
||||
"assocId": {
|
||||
"type": "integer",
|
||||
"description": "The submission or submission file ID.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"assocType": {
|
||||
"type": "integer",
|
||||
"description": "The assoc object. This should always be `ASSOC_TYPE_SUBMISSION` or `ASSOC_TYPE_SUBMISSION_FILE`.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"copyrightNotice": {
|
||||
"type": "string",
|
||||
"description": "The context derived copyright notice confirmed for the submission",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"data": {
|
||||
"type": "Object",
|
||||
"description": "Additional data attached to this event log.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dateLogged": {
|
||||
"type": "string",
|
||||
"description": "The date this event was recorded.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"date_format:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"decision": {
|
||||
"type": "integer",
|
||||
"description": "The decision type identifier. One of the Decision::* constants.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"editorId": {
|
||||
"type": "integer",
|
||||
"description": "The user ID of the editor associated with the event.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
|
||||
},
|
||||
"editorName": {
|
||||
"type": "string",
|
||||
"description": "The full name of the editor associated with the event, e.g., who made a decision or recommendation.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"eventType": {
|
||||
"type": "integer",
|
||||
"description": "The type of the event. One of the `SUBMISSION_LOG_` constants.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"fileId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the file associated with the submission file",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"filename": {
|
||||
"type": "string",
|
||||
"description": "The name of the file associated with the submission file",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"fileStage": {
|
||||
"type": "integer",
|
||||
"description": "One of the `SubmissionFile::SUBMISSION_FILE_` constants",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:2,3,4,5,6,7,8,9,10,11,13,15,17,18,19,20"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"description": "The id of the event log.",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"isTranslated": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the message is translated.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"message": {
|
||||
"type": "string",
|
||||
"description": "Custom log message, either a locale key or literal string.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"recipientCount": {
|
||||
"type": "integer",
|
||||
"description": "The number of users indicated as recipients of an email.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"recipientId": {
|
||||
"type": "integer",
|
||||
"description": "The user ID of the email recipient.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"recipientName": {
|
||||
"type": "string",
|
||||
"description": "The full name of the email recipient.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"reviewAssignmentId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of associated review assignment.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"reviewDueDate": {
|
||||
"type": "string",
|
||||
"description": "Date when the reviewer should accept or decline the assignment. Uses context's date and time format.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"reviewerName": {
|
||||
"type": "string",
|
||||
"description": "The full name of the reviewer associated with the event.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"round": {
|
||||
"type": "integer",
|
||||
"description": "The number of the review round.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"senderId": {
|
||||
"type": "integer",
|
||||
"description": "The user ID of the email sender.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"senderName": {
|
||||
"type": "string",
|
||||
"description": "The full name of the email sender.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"stageId": {
|
||||
"type": "integer",
|
||||
"description": "The workflow stage ID associated submission was in when this event was logged. One of the `WORKFLOW_STAGE_ID_` constants",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:1,2,3,4,5"
|
||||
]
|
||||
},
|
||||
"sourceSubmissionFileId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the source file from which the current submission file was promoted to another stage",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"subject": {
|
||||
"type": "string",
|
||||
"description": "The subject of the sent email.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"submissionFileId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the submission file associates with the logged event.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"submissionId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the submission associates with the logged event.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"userFullName": {
|
||||
"type": "string",
|
||||
"description": "The full name of the user/author associated with the event, e.g., confirming the copyright during submission.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"userGroupName": {
|
||||
"type": "string",
|
||||
"description": "The name of the role the user is in.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"userId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the user who triggered the event",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:1"
|
||||
]
|
||||
},
|
||||
"username": {
|
||||
"type": "string",
|
||||
"description": "The username of the user/author associated with the event.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
{
|
||||
"title": "Highlight",
|
||||
"description": "A highlight for the journal, press or preprint server, or at the site level. Each highlight is a text, image and URL and may be used by a theme to show a slider or similar highlighted items.",
|
||||
"required": [
|
||||
"sequence",
|
||||
"title",
|
||||
"url"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"description": "The URL to this highlight in the REST API.",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"description": "The journal, press or preprint server ID, or null when the highlight is for the site level.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"description": "The short text for this highlight.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"image": {
|
||||
"type": "object",
|
||||
"description": "The image to show with this highlight.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"altText": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"sequence": {
|
||||
"type": "integer",
|
||||
"description": "The order in which this highlight should be shown. Lower numbers appear first.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "The title or headline for this highlight.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"description": "The URL where this highlight should send the user when they click on it.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"urlText": {
|
||||
"type": "string",
|
||||
"description": "The text to use with the button or link to the URL.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,61 @@
|
||||
{
|
||||
"title": "Institution",
|
||||
"description": "An institution, such as a university, that may be used to track usage statistics, handle subscriptions, and more.",
|
||||
"required": [
|
||||
"contextId",
|
||||
"name"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"description": "The URL to this institution in the REST API.",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"description": "The context which added this institution.",
|
||||
"writeDisabledInApi": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"description": "The unique id of the institution in the database.",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of this institution.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"ror": {
|
||||
"type": "string",
|
||||
"description": "The [ROR](https://ror.org/) id of this institution.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"regex:#https://ror.org/0[^ILOU]{6}\\d{2}#"
|
||||
]
|
||||
},
|
||||
"deletedAt": {
|
||||
"type": "string",
|
||||
"description": "The date this institution was deleted, if it has been deleted. Institutions are kept after being deleted because they may be referenced in statistics data.",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"ipRanges": {
|
||||
"type": "array",
|
||||
"description": "A list of IP ranges belonging to this institution. Used to track usage statistics and subscription access by institution.",
|
||||
"apiSummary": true,
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,349 @@
|
||||
{
|
||||
"title": "Publication",
|
||||
"description": "A published version of a submission.",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"submissionId",
|
||||
"version"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"abstract": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"authors": {
|
||||
"type": "array",
|
||||
"description": "A list of the authors for this publication.",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/Author"
|
||||
}
|
||||
},
|
||||
"authorsString": {
|
||||
"type": "string",
|
||||
"description": "All of the authors rendered with the appropriate separators according to the locale.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"authorsStringIncludeInBrowse": {
|
||||
"type": "string",
|
||||
"description": "A list of authors that are included in publication lists, like tables of content and search results, rendered with the appropriate separators according to the locale.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"authorsStringShort": {
|
||||
"type": "string",
|
||||
"description": "A shortened version of the authors rendered with the appropriate separators according to the locale.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"categoryIds": {
|
||||
"type": "array",
|
||||
"apiSummary": true,
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"citations": {
|
||||
"type": "array",
|
||||
"description": "Optional metadata that contains an array of references for works cited in this submission. References have been split and parsed from the raw text.",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"citationsRaw": {
|
||||
"type": "string",
|
||||
"description": "Optional metadata that contains references for works cited in this submission as raw text.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"copyrightHolder": {
|
||||
"type": "string",
|
||||
"description": "The copyright statement for this publication.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"copyrightYear": {
|
||||
"type": "integer",
|
||||
"description": "The copyright year for this publication.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"coverage": {
|
||||
"type": "string",
|
||||
"description": "Optional metadata that usually indicates a work's location, time period or jurisdiction.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"coverImage": {
|
||||
"type": "object",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"altText": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"dataAvailability": {
|
||||
"type": "string",
|
||||
"description": "Optional metadata that describes whether the author(s) have made their data available and, if so, where readers may access it.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"datePublished": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"date_format:Y-m-d"
|
||||
]
|
||||
},
|
||||
"disciplines": {
|
||||
"type": "array",
|
||||
"description": "Optional metadata that describes the submission's types of study or branches of knowledge.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"doiObject": {
|
||||
"type": "object",
|
||||
"description": "An object representing the DOI for this publication.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"$ref": "#/definitions/Doi"
|
||||
},
|
||||
"doiId": {
|
||||
"type": "integer",
|
||||
"description": "The ID of the DOI to assign to this publication.",
|
||||
"writeOnly": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"fullTitle": {
|
||||
"type": "string",
|
||||
"description": "The combined prefix, title and subtitle. This may include inline HTML tags, such as `<i>` and `<b>`.",
|
||||
"multilingual": true,
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"keywords": {
|
||||
"type": "array",
|
||||
"description": "Optional metadata, usually one- to three-word phrases that are used to indicate the main topics of a submission.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"languages": {
|
||||
"type": "array",
|
||||
"description": "Optional metadata that identifies the submission's primary language.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"lastModified": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date_format:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"licenseUrl": {
|
||||
"type": "string",
|
||||
"description": "A URL to a webpage describing the license terms for this publication.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The primary locale of the submission this publication is attached to. This locale is used as the fallback when a language is missing from a multilingual property.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"prefix": {
|
||||
"type": "string",
|
||||
"description": "A prefix to be prepended to the title. In English, words such as \"The\" and \"A\" are commonly entered in the prefix instead of the title.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"primaryContactId": {
|
||||
"type": "integer",
|
||||
"description": "Which `contributor` is the primary contact for this publication.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"pub-id::publisher-id": {
|
||||
"type": "string",
|
||||
"description": "A unique ID provided by the publisher. It will be used in the publication's URL path instead of the `id` when present.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"rights": {
|
||||
"type": "string",
|
||||
"description": "Optional metadata that describes any rights held over the submission.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"seq": {
|
||||
"type": "integer",
|
||||
"default": 0,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"description": "Optional metadata that may be an ID, such as a DOI, of another work from which the submission is derived.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"subjects": {
|
||||
"type": "array",
|
||||
"description": "Optional metadata that consists of keywords, key phrases or classification codes that describe the submission's topics.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"submissionId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"subtitle": {
|
||||
"type": "string",
|
||||
"description": "The subtitle. This may include inline HTML tags, such as `<i>` and `<b>`.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"allowable_title_html_tags",
|
||||
"no_new_line"
|
||||
]
|
||||
},
|
||||
"supportingAgencies": {
|
||||
"type": "array",
|
||||
"description": "Optional metadata that indicates the source of research funding or other institutional support.",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "integer",
|
||||
"description": "Whether the publication is Queued (not yet scheduled for publication), Declined, Published or Scheduled (scheduled for publication at a future date). One of the `PKPSubmission::STATUS_*` constants. Default is `PKPSubmission::STATUS_QUEUED`.",
|
||||
"apiSummary": true,
|
||||
"default": 1,
|
||||
"validation": [
|
||||
"in:1,3,4,5"
|
||||
]
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"description": "The title without a prefix or subtitle. This may include inline HTML tags, such as `<i>` and `<b>`.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"allowable_title_html_tags",
|
||||
"no_new_line"
|
||||
]
|
||||
},
|
||||
"type": {
|
||||
"type": "string",
|
||||
"description": "Optional metadata that describes the type of the submission and usually matches on of the [Dublin Core Types](http://dublincore.org/documents/dcmi-type-vocabulary/#section-7-dcmi-type-vocabulary).",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"urlPath": {
|
||||
"type": "string",
|
||||
"description": "An optional path to use in the URL instead of the ID.",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"regex:/^[a-zA-Z0-9]+([\\.\\-_][a-zA-Z0-9]+)*$/"
|
||||
]
|
||||
},
|
||||
"urlPublished": {
|
||||
"type": "string",
|
||||
"description": "The public URL for this publication or where it will be available if it has not yet been published.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"version": {
|
||||
"type": "integer",
|
||||
"description": "The version number of this publication. Version numbers should increment by one so that the third publication of a submission will have the version number `3`. Version numbers should typically be set automatically and editorial staff should not be encouraged to modify them.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"min:1"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
{
|
||||
"title": "Review Round",
|
||||
"description": "A round of review assignments in the review stage.",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"round": {
|
||||
"type": "integer"
|
||||
},
|
||||
"stageId": {
|
||||
"type": "integer"
|
||||
},
|
||||
"status": {
|
||||
"type": "string",
|
||||
"readOnly": true
|
||||
},
|
||||
"statusId": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"title": "Section",
|
||||
"description": "A journal or server section, or press series.",
|
||||
"required": [
|
||||
"contextId",
|
||||
"title"
|
||||
],
|
||||
"properties": {
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"editorRestricted": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"isInactive": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"sequence": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,241 @@
|
||||
{
|
||||
"title": "Site",
|
||||
"description": "The overall site hosting one or more contexts (journals/presses).",
|
||||
"required": [
|
||||
"title",
|
||||
"contactName",
|
||||
"contactEmail"
|
||||
],
|
||||
"properties": {
|
||||
"about": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"announcementsIntroduction": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"contactEmail": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable",
|
||||
"email_or_localhost"
|
||||
]
|
||||
},
|
||||
"contactName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "common.software",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"counterR5StartDate": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableAnnouncements": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableBulkEmails": {
|
||||
"type": "array",
|
||||
"description": "Which hosted journals, presses or preprint servers are allowed to send bulk emails.",
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"compressStatsLogs": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not to compress usage statistics log files after they have been processed and archived.",
|
||||
"default": false
|
||||
},
|
||||
"enableGeoUsageStats": {
|
||||
"type": "string",
|
||||
"description": "Whether to track usage statistics by location, and whether to track at the country, region or city level.",
|
||||
"default": "disabled",
|
||||
"validation": [
|
||||
"in:disabled,country,country+region,country+region+city"
|
||||
]
|
||||
},
|
||||
"enableInstitutionUsageStats": {
|
||||
"type": "boolean",
|
||||
"description": "Whether to track usage statistics by institutions. Requires institutional IP ranges to be configured.",
|
||||
"default": false
|
||||
},
|
||||
"keepDailyUsageStats": {
|
||||
"type": "boolean",
|
||||
"description": "Whether to retain daily usage stats or consolidate monthly stats. Daily stats can quickly result in millions of database rows for large installs with lots of submissions.",
|
||||
"default": false
|
||||
},
|
||||
"isSiteSushiPlatform": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not to designate the site as the platform in COUNTER SUSHI statistics. Set this to true when all of the contexts (journals, presses or servers) of this site are published, owned or operated by the same provider.",
|
||||
"default": false
|
||||
},
|
||||
"sushiPlatformID": {
|
||||
"type": "string",
|
||||
"description": "The platform ID for COUNTER SUSHI statistics. Required when isSiteSushiPlatform is true.",
|
||||
"validation": [
|
||||
"regex:#^[a-zA-Z0-9._/]{1,17}$#",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"isSushiApiPublic": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not the access to the COUNTER SUSHI statistics API is public. If false, only users with admin or manager roles can access the API.",
|
||||
"default": true
|
||||
},
|
||||
"installedLocales": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
}
|
||||
},
|
||||
"minPasswordLength": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"min:4"
|
||||
]
|
||||
},
|
||||
"disableSharedReviewerStatistics": {
|
||||
"type": "boolean",
|
||||
"description": "Specify whether reviewer statistics can be shared with other contexts of the installation.",
|
||||
"default": false
|
||||
},
|
||||
"numAnnouncementsHomepage": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"min:0"
|
||||
]
|
||||
},
|
||||
"pageFooter": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"pageHeaderTitleImage": {
|
||||
"type": "object",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"altText": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"primaryLocale": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
},
|
||||
"privacyStatement": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"redirect": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"sidebar": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"alpha_num"
|
||||
]
|
||||
}
|
||||
},
|
||||
"styleSheet": {
|
||||
"type": "object",
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"supportedLocales": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
}
|
||||
},
|
||||
"themePluginPath": {
|
||||
"type": "string",
|
||||
"default": "default"
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"uniqueSiteId": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,269 @@
|
||||
{
|
||||
"title": "Submission",
|
||||
"description": "A submission to the journal, press or preprint server.",
|
||||
"required": [
|
||||
"contextId"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"description": "A URL to this object in the REST API.",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"commentsForTheEditors": {
|
||||
"type": "string",
|
||||
"description": "Optional. Comments from the submitting author to the editors. This is only available for submissions that have not yet been submitted. Once submitted, the message is converted to a discussion and you can not read or write to this property.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"description": "The id of the context this submission was created in.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true
|
||||
},
|
||||
"currentPublicationId": {
|
||||
"type": "integer",
|
||||
"description": "Which publication is the latest published version.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true
|
||||
},
|
||||
"dateLastActivity": {
|
||||
"type": "string",
|
||||
"description": "The last time activity was recorded related to this submission.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"dateSubmitted": {
|
||||
"type": "string",
|
||||
"description": "The date this submission was submitted.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"description": "The id of this submission.",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"lastModified": {
|
||||
"type": "string",
|
||||
"description": "The last time a modification was made to this submission or any of its associated objects.",
|
||||
"apiSummary": true,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The primary language of this submission.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
},
|
||||
"publications": {
|
||||
"type": "array",
|
||||
"description": "A list of publications that have been created for this submission.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/Publication"
|
||||
}
|
||||
},
|
||||
"reviewRounds": {
|
||||
"type": "array",
|
||||
"description": "A list of review rounds that have been opened for this submission.",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/ReviewRound"
|
||||
}
|
||||
},
|
||||
"reviewAssignments": {
|
||||
"type": "array",
|
||||
"description": "Information about pending and completed review assignments.",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"isCurrentUserAssigned": {
|
||||
"type": "integer",
|
||||
"readOnly": true
|
||||
},
|
||||
"status": {
|
||||
"type": "integer",
|
||||
"readOnly": true
|
||||
},
|
||||
"statusLabel": {
|
||||
"type": "integer",
|
||||
"readOnly": true
|
||||
},
|
||||
"dateDue": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"date|Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"dateResponseDue": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"date|Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"round": {
|
||||
"type": "integer"
|
||||
},
|
||||
"reviewRoundId": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"stageId": {
|
||||
"type": "integer",
|
||||
"description": "The stage of the editorial workflow that this submission is currently in. One of the `WORKFLOW_STAGE_ID_` constants. Default is `WORKFLOW_STAGE_ID_SUBMISSION`.",
|
||||
"apiSummary": true,
|
||||
"default": 1,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"min:1",
|
||||
"max:5"
|
||||
]
|
||||
},
|
||||
"stages": {
|
||||
"type": "array",
|
||||
"description": "Key data about the status, files and discussions of each stage.",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"label": {
|
||||
"type": "string"
|
||||
},
|
||||
"isActiveStage": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"currentUserAssignedRoles": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "integer"
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "string"
|
||||
},
|
||||
"statusId": {
|
||||
"type": "integer"
|
||||
},
|
||||
"files": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"count": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"queries": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"id": {
|
||||
"type": "integer"
|
||||
},
|
||||
"assocType": {
|
||||
"type": "integer"
|
||||
},
|
||||
"assocId": {
|
||||
"type": "integer"
|
||||
},
|
||||
"stageId": {
|
||||
"type": "integer"
|
||||
},
|
||||
"seq": {
|
||||
"type": "integer"
|
||||
},
|
||||
"closed": {
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"status": {
|
||||
"type": "integer",
|
||||
"description": "Whether the submission is Published, Declined, Scheduled or Queued (still in the workflow). One of the `PKPSubmission::STATUS_*` constants. Default is `PKPSubmission::STATUS_QUEUED`.",
|
||||
"apiSummary": true,
|
||||
"default": 1,
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"in:1,2,3,4,5"
|
||||
]
|
||||
},
|
||||
"statusLabel": {
|
||||
"type": "string",
|
||||
"description": "A human-readable version of the submission's status. It will be Published, Declined, Queued (still in the workflow) or Scheduled.",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"submissionProgress": {
|
||||
"type": "string",
|
||||
"description": "This value tracks the submission's progress in the submission wizard. It will be set to `start` or the current step when a submission is in progress. After it is submitted, this will be an empty string, indicating it is ready for an editor's consideration.",
|
||||
"apiSummary": true,
|
||||
"default": "start",
|
||||
"writeDisabledInApi": true,
|
||||
"validation": [
|
||||
"in:,start,details,files,contributors,editors,review"
|
||||
]
|
||||
},
|
||||
"userGroupId": {
|
||||
"type": "integer",
|
||||
"description": "Optional. The submitting user will be assigned to the submission in the user group under which they submit. Leave this empty to have the user automatically assigned as an author, when an author user group allows self-registration. Changing this property will have no effect after a submission is submitted.",
|
||||
"writeOnly": true
|
||||
},
|
||||
"urlAuthorWorkflow": {
|
||||
"type": "string",
|
||||
"description": "A URL to this submission for the author's editorial workflow.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"urlEditorialWorkflow": {
|
||||
"type": "string",
|
||||
"description": "A URL to this submission for the editors' and assistants' editorial workflow.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"urlSubmissionWizard": {
|
||||
"type": "string",
|
||||
"description": "A URL to the submission wizard for this submission. The submission wizard can not be accessed after a submission has been submitted.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"urlWorkflow": {
|
||||
"type": "string",
|
||||
"description": "A URL to this submission for the workflow most appropriate for the current user. It will match the `urlAuthorWorkflow` or `urlEditorialWorkflow`, depending on what roles the user is assigned.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"urlPublished": {
|
||||
"type": "string",
|
||||
"description": "A URL to view the published version of this submission. If it is not published, the URL will point to the location where it will be published in the future.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,282 @@
|
||||
{
|
||||
"title": "Submission File",
|
||||
"description": "A submission file including associated metadata.",
|
||||
"required": [
|
||||
"fileId",
|
||||
"fileStage",
|
||||
"name",
|
||||
"submissionId"
|
||||
],
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"format": "uri",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"assocId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"description": "Used with `assocType` to associate this file with an object such as a galley.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"assocType": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"description": "Used with `assocId` to associate this file with an object such as a galley. One of the following constants: `ASSOC_TYPE_SUBMISSION_FILE` (dependent files), `ASSOC_TYPE_REVIEW_ASSIGNMENT` (files uploaded by a reviewer), `ASSOC_TYPE_NOTE` (files uploaded with a discussion), `ASSOC_TYPE_REPRESENTATION` (files uploaded to a galley or publication format), `ASSOC_TYPE_REVIEW_ROUND` (review files and revisions for a particular review round).",
|
||||
"validation": [
|
||||
"in:515,517,520,521,523"
|
||||
]
|
||||
},
|
||||
"caption": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"description": "A caption for this file. Used with artwork such as images.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"copyrightOwner": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"description": "The copyright owner of this file. Used with artwork such as images.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"createdAt": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"description": "The date this submission file object was created in the system. Set automatically by the software.",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"creator": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"description": "An attribution for this file, such as the creator of a data set. Used with supplementary files.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"credit": {
|
||||
"type": "string",
|
||||
"description": "An attribution for this file, such as a photographer's name. Used with artwork such as images.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dateCreated": {
|
||||
"type": "string",
|
||||
"description": "Public metadata about when this content was created. Used with supplementary files.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dependentFiles": {
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"description": "Any dependent files, typically images or audio files that are loaded by an HTML file.",
|
||||
"items": {
|
||||
"$ref": "#/definitions/SubmissionFile"
|
||||
}
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"documentType": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"fileId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"file": {
|
||||
"type": "string",
|
||||
"format": "binary",
|
||||
"writeOnly": true
|
||||
},
|
||||
"fileStage": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"in:2,3,4,5,6,7,8,9,10,11,13,15,17,18"
|
||||
]
|
||||
},
|
||||
"genreId": {
|
||||
"type": "integer",
|
||||
"description": "The genre id of this file",
|
||||
"apiSummary": true
|
||||
},
|
||||
"genreName": {
|
||||
"type": "string",
|
||||
"description": "The genre name of this file, suc as Article Text or Data Set.",
|
||||
"isMultilingual": true,
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"genreIsDependent": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not this is a dependent file, such as images displayed by a HTML file, that are be displayed with published content.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"genreIsSupplementary": {
|
||||
"type": "boolean",
|
||||
"description": "Whether or not this is a supplementary file, such as data sets and research materials, that are displayed separately from the main publication files.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"language": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"description": "The language of this file if it contains text. Used with supplementary files.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"description": "The primary locale of the submission this file is attached to. This locale is used as the fallback when a language is missing from a multilingual property.",
|
||||
"readOnly": true
|
||||
},
|
||||
"mimetype": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"path": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"publisher": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"description": "The publisher of this file. Used with supplementary files.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"revisions": {
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"description": "Previous versions of this file.",
|
||||
"items": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"documentType": {
|
||||
"type": "string"
|
||||
},
|
||||
"fileId": {
|
||||
"type": "integer"
|
||||
},
|
||||
"mimetype": {
|
||||
"type": "string"
|
||||
},
|
||||
"path": {
|
||||
"type": "string"
|
||||
},
|
||||
"url": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"sourceSubmissionFileId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"description": "When a submission file is promoted from one stage to another, this property identifies the source file from which this file was promoted. Default: `null`."
|
||||
},
|
||||
"source": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"description": "An attribution for this file that identifies its source, such as a dataset from which this file was generated. Used with supplementary files.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"sponsor": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"description": "Sponsorship or funding disclosure for this file. Used with supplementary files.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"subject": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"description": "Subject metadata for this file. Used with supplementary files.",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"submissionId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"terms": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"description": "Licensing terms for this file. Used with artwork such as images."
|
||||
},
|
||||
"updatedAt": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"description": "When this object was last updated.",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"uploaderUserId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"uploaderUserName": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"viewable": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,237 @@
|
||||
{
|
||||
"title": "User",
|
||||
"description": "A registered user.",
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"affiliation": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"authStr": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"billingAddress": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"biography": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"country": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dateRegistered": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"dateValidated": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dateLastEmail": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"dateLastLogin": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"apiKey": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"apiKeyEnabled": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"inlineHelp": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"disabled": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"disabledReason": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"email": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"email_or_localhost"
|
||||
]
|
||||
},
|
||||
"familyName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"fullName": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"givenName": {
|
||||
"type": "string",
|
||||
"multilingual": true
|
||||
},
|
||||
"gossip": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"groups": {
|
||||
"type": "array",
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/UserGroup"
|
||||
}
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"profileImage": {
|
||||
"type": "object",
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"dateUploaded": {
|
||||
"type": "string"
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
}
|
||||
}
|
||||
},
|
||||
"interests": {
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"apiSummary": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/UserInterest"
|
||||
}
|
||||
},
|
||||
"locales": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
}
|
||||
},
|
||||
"mailingAddress": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"mustChangePassword": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"orcid": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"orcid",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"password": {
|
||||
"type": "string",
|
||||
"writeOnly": true
|
||||
},
|
||||
"phone": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"preferredPublicName": {
|
||||
"type": "string",
|
||||
"description": "An optional field for users to specify how they prefer to be identified.",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"signature": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"url": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"url",
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"userName": {
|
||||
"type": "string",
|
||||
"apiSummary": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,57 @@
|
||||
{
|
||||
"title": "UserGroup",
|
||||
"description": "A user group assigned to one of the allowed roles.",
|
||||
"properties": {
|
||||
"abbrev": {
|
||||
"type": "string",
|
||||
"description": "The short name of the user group.",
|
||||
"apiSummary": true,
|
||||
"multilingual": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"description": "The name of the user group.",
|
||||
"apiSummary": true,
|
||||
"multilingual": true
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"contextId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"permitSelfRegistration": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"permitMetadataEdit": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"recommendOnly": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"isDefault": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"roleId": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"in:16,1,17,65536,4096,4097,1048576,209715"
|
||||
]
|
||||
},
|
||||
"showTitle": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"nameLocaleKey": {
|
||||
"type": "string",
|
||||
"description": "A field that contains the the locale key of the group name",
|
||||
"apiSummary": true
|
||||
},
|
||||
"abbrevLocaleKey": {
|
||||
"type": "string",
|
||||
"description": "A field that contains the the locale key of the group abbreviaton",
|
||||
"apiSummary": true
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user