OSJ/schemas/issue.json

{
	"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
		}
	}
}