first commit
This commit is contained in:
@@ -0,0 +1,382 @@
|
||||
{
|
||||
"title": "Journal",
|
||||
"description": "A journal.",
|
||||
"properties": {
|
||||
"abbreviation": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"clockssLicense": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.clockssLicense",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"copyrightYearBasis": {
|
||||
"type": "string",
|
||||
"default": "issue",
|
||||
"validation": [
|
||||
"in:issue,submission"
|
||||
]
|
||||
},
|
||||
"currentIssueId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"delayedOpenAccessDuration": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"delayedOpenAccessPolicy": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enabledDoiTypes": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"in:publication,representation,issue"
|
||||
]
|
||||
},
|
||||
"default": ["publication"]
|
||||
},
|
||||
"doiCreationTime": {
|
||||
"type": "string",
|
||||
"default": "copyEditCreationTime"
|
||||
},
|
||||
"doiIssueSuffixPattern": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableOpenAccessNotification": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableOai": {
|
||||
"type": "boolean",
|
||||
"default": 1,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enablePublisherId": {
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"in:publication,galley,issue,issueGalley"
|
||||
]
|
||||
}
|
||||
},
|
||||
"enableSubscriptionOnlinePaymentNotificationPurchaseIndividual": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableSubscriptionOnlinePaymentNotificationPurchaseInstitutional": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableSubscriptionOnlinePaymentNotificationRenewIndividual": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"enableSubscriptionOnlinePaymentNotificationRenewInstitutional": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"journalThumbnail": {
|
||||
"type": "object",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
],
|
||||
"properties": {
|
||||
"temporaryFileId": {
|
||||
"type": "integer",
|
||||
"writeOnly": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"uploadName": {
|
||||
"type": "string"
|
||||
},
|
||||
"width": {
|
||||
"type": "integer"
|
||||
},
|
||||
"height": {
|
||||
"type": "integer"
|
||||
},
|
||||
"dateUploaded": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date_format:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"altText": {
|
||||
"type": "string"
|
||||
}
|
||||
}
|
||||
},
|
||||
"licenseTerms": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"lockssLicense": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"defaultLocaleKey": "default.contextSettings.lockssLicense",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"membershipFee": {
|
||||
"type": "number",
|
||||
"default": 0,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"membershipFeeDescription": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"membershipFeeName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"numMonthsAfterSubscriptionExpiryReminder": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"numMonthsBeforeSubscriptionExpiryReminder": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"numWeeksAfterSubscriptionExpiryReminder": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"numWeeksBeforeSubscriptionExpiryReminder": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"onlineIssn": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"issn"
|
||||
]
|
||||
},
|
||||
"paymentPluginName": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"printIssn": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"issn"
|
||||
]
|
||||
},
|
||||
"publicationFee": {
|
||||
"type": "number",
|
||||
"default": 0,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"publicationFeeDescription": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"publicationFeeName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"publisherInstitution": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"publisherUrl": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"publishingMode": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"in:0,1,2"
|
||||
]
|
||||
},
|
||||
"purchaseArticleFee": {
|
||||
"type": "number",
|
||||
"default": 0,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"purchaseArticleFeeDescription": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"purchaseArticleFeeEnabled": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"purchaseArticleFeeName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"purchaseIssueFee": {
|
||||
"type": "number",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"purchaseIssueFeeEnabled": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"restrictArticleAccess": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"restrictOnlyPdf": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"submissionFee": {
|
||||
"type": "number",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"submissionFeeDescription": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"submissionFeeName": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"subscriptionAdditionalInformation": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"subscriptionEmail": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable",
|
||||
"email_or_localhost"
|
||||
]
|
||||
},
|
||||
"subscriptionExpiryPartial": {
|
||||
"type": "boolean",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"subscriptionMailingAddress": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"subscriptionName": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"subscriptionPhone": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"doiVersioning": {
|
||||
"type": "boolean",
|
||||
"default": false,
|
||||
"description": "Whether each publication version should receive a unique DOI"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,96 @@
|
||||
{
|
||||
"title": "Galley",
|
||||
"description": "A galley representing a published file, such as a PDF or HTML file.",
|
||||
"required": [
|
||||
"submissionFileId",
|
||||
"label",
|
||||
"publicationId"
|
||||
],
|
||||
"properties": {
|
||||
"submissionFileId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"doiObject": {
|
||||
"type": "object",
|
||||
"description": "DOI object for this galley",
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"$ref": "#/definitions/Doi"
|
||||
},
|
||||
"doiId": {
|
||||
"type": "integer",
|
||||
"description": "Reference to the DOI for this galley",
|
||||
"writeOnly": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"file": {
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"$ref": "#/definitions/SubmissionFile"
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
},
|
||||
"isApproved": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"locale": {
|
||||
"type": "string",
|
||||
"description": "The primary locale of this galley.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"regex:/^([a-z]{2})((_[A-Z]{2})?)(@[a-z]{0,})?$/"
|
||||
]
|
||||
},
|
||||
"label": {
|
||||
"type": "string",
|
||||
"description": "A human-readable label for this galley. For the primary article, it is usually indicates the format like PDF, ePub or full text. For supplementary files it often indicates the content, such as source data or interview transcripts.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"pub-id::publisher-id": {
|
||||
"type": "string",
|
||||
"description": "A unique ID provided by the publisher. This is often used to record the ID of this galley in an external database, in cases where the publisher maintains separate records.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"publicationId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"seq": {
|
||||
"type": "integer",
|
||||
"description": "In what order this galley should appear in lists of galleys for this publication.",
|
||||
"apiSummary": true
|
||||
},
|
||||
"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]+)*$/"
|
||||
]
|
||||
},
|
||||
"urlRemote": {
|
||||
"type": "string",
|
||||
"description": "An optional URL where the galley can be viewed or downloaded.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"urlPublished": {
|
||||
"type": "string",
|
||||
"description": "The URL where this galley can be viewed or downloaded.",
|
||||
"apiSummary": true,
|
||||
"readOnly": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,167 @@
|
||||
{
|
||||
"title": "Issue",
|
||||
"description": "An issue.",
|
||||
"properties": {
|
||||
"_href": {
|
||||
"type": "string",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"accessStatus": {
|
||||
"type": "integer"
|
||||
},
|
||||
"articles": {
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/SubmissionSummary"
|
||||
}
|
||||
},
|
||||
"coverImage": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"coverImageAltText": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"coverImageUrl": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"validation": [
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"dateNotified": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"datePublished": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"description": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"doiObject": {
|
||||
"type": "object",
|
||||
"description": "DOI object for this galley",
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"$ref": "#/definitions/Doi"
|
||||
},
|
||||
"doiId": {
|
||||
"type": "integer",
|
||||
"description": "Reference to the DOI for this galley",
|
||||
"writeOnly": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"galleys": {
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"apiSummary": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/Galley"
|
||||
}
|
||||
},
|
||||
"id": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"identification": {
|
||||
"type": "string",
|
||||
"readOnly": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"journalId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"lastModified": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"number": {
|
||||
"type": "string",
|
||||
"apiSummary": true
|
||||
},
|
||||
"openAccessDate": {
|
||||
"type": "string",
|
||||
"validation": [
|
||||
"date:Y-m-d H:i:s"
|
||||
]
|
||||
},
|
||||
"originalStyleFileName": {
|
||||
"type": "string"
|
||||
},
|
||||
"published": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"publishedUrl": {
|
||||
"type": "string",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"url"
|
||||
]
|
||||
},
|
||||
"sections": {
|
||||
"type": "array",
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/SectionSummary"
|
||||
}
|
||||
},
|
||||
"showNumber": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"showTitle": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"showVolume": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"showYear": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"styleFileName": {
|
||||
"type": "string"
|
||||
},
|
||||
"title": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true
|
||||
},
|
||||
"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]+)*$/"
|
||||
]
|
||||
},
|
||||
"volume": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
},
|
||||
"year": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"description": "A published version of an article.",
|
||||
"required": [
|
||||
"sectionId"
|
||||
],
|
||||
"properties": {
|
||||
"accessStatus": {
|
||||
"type": "integer",
|
||||
"default": 0,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"galleys": {
|
||||
"type": "array",
|
||||
"apiSummary": true,
|
||||
"readOnly": true,
|
||||
"items": {
|
||||
"$ref": "#/definitions/Galley"
|
||||
}
|
||||
},
|
||||
"hideAuthor": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the contributor details should be displayed for this publication. Commonly used for editorial statements without individual authorship.",
|
||||
"default": false,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"issueId": {
|
||||
"type": "integer",
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"pages": {
|
||||
"type": "string",
|
||||
"description": "The pages of the issue in which this article appears if it is published in a physical format.",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"sectionId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,68 @@
|
||||
{
|
||||
"title": "Section",
|
||||
"description": "A journal or server section, or press series.",
|
||||
"required": [
|
||||
"contextId",
|
||||
"title"
|
||||
],
|
||||
"properties": {
|
||||
"abbrev": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"abstractsNotRequired": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"hideAuthor": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"hideTitle": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"identifyType": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"metaIndexed": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"metaReviewed": {
|
||||
"type": "boolean",
|
||||
"apiSummary": true
|
||||
},
|
||||
"policy": {
|
||||
"type": "string",
|
||||
"multilingual": true,
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"reviewFormId": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
},
|
||||
"wordCount": {
|
||||
"type": "integer",
|
||||
"apiSummary": true,
|
||||
"validation": [
|
||||
"nullable"
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"title": "Submission",
|
||||
"description": "A submission to the journal.",
|
||||
"required": [
|
||||
"sectionId"
|
||||
],
|
||||
"properties": {
|
||||
"sectionId": {
|
||||
"type": "integer",
|
||||
"description": "The section this submission should be assigned to. This can only be passed when creating a new submission and the data is assigned to the first publication. After the submission is created, edit the publication to change the `sectionId`.",
|
||||
"writeOnly": true
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user