repository
stringclasses 528
values | commit
stringlengths 40
40
| commitDate
timestamp[s] | path
stringlengths 11
149
| repoStars
int64 5
94.9k
| repoLastFetched
stringclasses 528
values | content
stringlengths 48
736k
| license
stringclasses 14
values | language
stringclasses 7
values |
|---|---|---|---|---|---|---|---|---|
jskherman/cv.typ | 2cb78fce168d85459be545718e1381848646f7d7 | 2023-11-15T16:29:18 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"default": {},
"examples": [
{
"affiliations": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"awards": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"certificates": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"education": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"interests": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"languages": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"personal": {
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
},
"projects": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"publications": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"references": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"skills": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"work": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
}
],
"properties": {
"affiliations": {
"default": [],
"examples": [
[
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
]
],
"items": {
"examples": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"properties": {
"endDate": {
"examples": [
"2021-05-30",
"2023-06-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
[
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
]
],
"items": {
"examples": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?",
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Cambridge, United Kingdom",
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"White Hat Hackers Association",
"London Bridge Toastmasters Club"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Vice President for Internal Affairs",
"Member"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2020-05-30",
"2022-06-15"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com",
""
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The affiliations Schema",
"type": "array"
},
"awards": {
"default": [],
"examples": [
[
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
]
],
"items": {
"examples": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"properties": {
"date": {
"examples": [
"2023-05-09",
"2020-07-12"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"highlights": {
"examples": [
null,
[
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
]
],
"items": {
"examples": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"null",
"array"
]
},
"issuer": {
"examples": [
"Toastmasters International",
"Sasin School of Management"
],
"title": "The issuer Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom",
"Bangkok, Thailand"
],
"title": "The location Schema",
"type": "string"
},
"title": {
"examples": [
"Champion in the Division A District X Speech Evaluation Contest",
"Finalist in the 2020 SCG Bangkok Business Challenge Global Competition"
],
"title": "The title Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The awards Schema",
"type": "array"
},
"certificates": {
"default": [],
"examples": [
[
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"properties": {
"date": {
"default": "",
"examples": [
"2021-09-01"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"issuer": {
"default": "",
"examples": [
"Coursera"
],
"title": "The issuer Schema",
"type": "string"
},
"name": {
"default": "",
"examples": [
"Learning How to Learn: Powerful mental tools to help you master tough subjects"
],
"title": "The name Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The certificates Schema",
"type": [
"array",
"null"
]
},
"education": {
"default": [],
"examples": [
[
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
]
],
"items": {
"examples": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"properties": {
"area": {
"examples": [
"Computer Science"
],
"title": "The area Schema",
"type": "string"
},
"courses": {
"examples": [
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
]
],
"items": {
"examples": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"title": "A Schema",
"type": "string"
},
"title": "The courses Schema",
"type": [
"array",
"null"
]
},
"endDate": {
"examples": [
"2021-06-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
]
],
"items": {
"examples": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"honors": {
"examples": [
[
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
[
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
]
],
"items": {
"examples": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List",
"Summa Cum Laude (4.0 GPA)"
],
"title": "A Schema",
"type": "string"
},
"title": "The honors Schema",
"type": [
"array",
"null"
]
},
"institution": {
"examples": [
"Open University",
"Harvard University"
],
"title": "The institution Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"startDate": {
"examples": [
"2017-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"studyType": {
"examples": [
"Bachelor of Science"
],
"title": "The studyType Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"institution",
"area",
"studyType",
"startDate",
"endDate",
"location",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The education Schema",
"type": "array"
},
"interests": {
"default": [],
"examples": [
[
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
]
],
"items": {
"examples": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"title": "A Schema",
"type": "string"
},
"title": "The interests Schema",
"type": "array"
},
"languages": {
"default": [],
"examples": [
[
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
]
],
"items": {
"examples": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"properties": {
"fluency": {
"examples": [
"Native speaker",
"Basic proficiency"
],
"title": "The fluency Schema",
"type": "string"
},
"language": {
"examples": [
"English",
"German",
"Japanese"
],
"title": "The language Schema",
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"title": "A Schema",
"type": "object"
},
"title": "The languages Schema",
"type": "array"
},
"personal": {
"default": {},
"examples": [
{
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
}
],
"properties": {
"email": {
"default": "",
"examples": [
"[email protected]"
],
"format": "email",
"title": "The email Schema",
"type": [
"string",
"null"
]
},
"location": {
"default": {},
"examples": [
{
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
}
],
"properties": {
"city": {
"default": "",
"examples": [
"New York"
],
"title": "The city Schema",
"type": "string"
},
"country": {
"default": "",
"examples": [
"United States of America"
],
"title": "The country Schema",
"type": "string"
},
"postalCode": {
"default": 0,
"examples": [
1234
],
"title": "The postalCode Schema",
"type": "integer"
},
"region": {
"default": "",
"examples": [
"New York"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"title": "The location Schema",
"type": [
"object",
"null"
]
},
"name": {
"default": "",
"examples": [
"John Smith L. Doe"
],
"title": "The name Schema",
"type": "string"
},
"phone": {
"default": "",
"examples": [
"(+1) 987 6543 210"
],
"title": "The phone Schema",
"type": [
"string",
"null"
]
},
"profiles": {
"default": [],
"examples": [
[
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
]
],
"items": {
"examples": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"properties": {
"network": {
"examples": [
"LinkedIn",
"GitHub"
],
"title": "The network Schema",
"type": "string"
},
"url": {
"examples": [
"https://linkedin.com/in/johndoe",
"https://github.com/johndoe"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
},
"username": {
"examples": [
"John Doe",
"johndoe"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The profiles Schema",
"type": "array"
},
"url": {
"default": "",
"examples": [
"https://johndoe.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"profiles"
],
"title": "The personal Schema",
"type": "object"
},
"projects": {
"default": [],
"examples": [
[
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
]
],
"items": {
"default": {},
"examples": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"properties": {
"affiliation": {
"default": "",
"examples": [
"Open University"
],
"title": "The affiliation Schema",
"type": "string"
},
"endDate": {
"default": "",
"examples": [
"2021-04-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"default": [],
"examples": [
[
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
]
],
"items": {
"examples": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": "array"
},
"name": {
"default": "",
"examples": [
"Job Tailor"
],
"title": "The name Schema",
"type": "string"
},
"startDate": {
"default": "",
"examples": [
"2020-11-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The projects Schema",
"type": [
"array",
"null"
]
},
"publications": {
"default": [],
"examples": [
[
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"A convolutional neural network for predicting Greenland glacier melt and glacial water flow"
],
"title": "The name Schema",
"type": "string"
},
"publisher": {
"default": "",
"examples": [
"Theoretical and Computational Fluid Dynamics"
],
"title": "The publisher Schema",
"type": "string"
},
"releaseDate": {
"default": "",
"examples": [
"2020-09-30"
],
"format": "date",
"title": "The releaseDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The publications Schema",
"type": [
"array",
"null"
]
},
"references": {
"default": [],
"examples": [
[
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"Dr. Jane Austin"
],
"title": "The name Schema",
"type": "string"
},
"reference": {
"default": "",
"examples": [
"John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition."
],
"title": "The reference Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://janeaustin.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"reference"
],
"title": "A Schema",
"type": "object"
},
"title": "The references Schema",
"type": [
"array",
"null"
]
},
"skills": {
"default": [],
"examples": [
[
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
]
],
"items": {
"examples": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"properties": {
"category": {
"examples": [
"Soft Skills",
"Programming",
"Tools",
"Web Development",
"BI & Data Analytics"
],
"title": "The category Schema",
"type": "string"
},
"skills": {
"examples": [
[
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
],
[
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
],
[
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
],
[
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
],
[
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
],
"items": {
"examples": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing",
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX",
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva",
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask",
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
],
"title": "A Schema",
"type": "string"
},
"title": "The skills Schema",
"type": "array"
}
},
"required": [
"category",
"skills"
],
"title": "A Schema",
"type": "object"
},
"title": "The skills Schema",
"type": "array"
},
"work": {
"default": [],
"examples": [
[
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
],
"items": {
"examples": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
],
"properties": {
"endDate": {
"examples": [
"present",
"2023-05-31"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
]
],
"items": {
"examples": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Remote / New York, New York",
"Pasadena, California"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"X Company",
"National Aeronautics and Space Administration - Jet Propulsion Laboratory"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Senior Developer"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2021-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The work Schema",
"type": "array"
}
},
"required": [
"personal",
"education",
"skills",
"languages"
],
"title": "jskherman/cv.typ schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | c55b13bdf1bd14b3a30ce95684320072c0820e5d | 2023-11-15T16:53:30 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"default": {},
"examples": [
{
"affiliations": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"awards": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"certificates": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"education": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"interests": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"languages": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"personal": {
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
},
"projects": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"publications": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"references": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"skills": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"work": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
}
],
"properties": {
"affiliations": {
"default": [],
"examples": [
[
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
]
],
"items": {
"examples": [
{
"endDate": "2021-05-30",
"highlights": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
"location": "Cambridge, United Kingdom",
"organization": "White Hat Hackers Association",
"position": "Vice President for Internal Affairs",
"startDate": "2020-05-30",
"url": "https://example.com"
},
{
"endDate": "2023-06-30",
"highlights": [
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"location": "City of London, United Kingdom",
"organization": "London Bridge Toastmasters Club",
"position": "Member",
"startDate": "2022-06-15",
"url": ""
}
],
"properties": {
"endDate": {
"examples": [
"2021-05-30",
"2023-06-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?"
],
[
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
]
],
"items": {
"examples": [
"But I must explain to you how all this mistaken idea of reprobating pleasure and extolling pain arose.",
"But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?",
"Can you then suppose that those heroic men performed their famous deeds without any motive at all?",
"Won Champion in the Division A District X Speech Evaluation Contest of Toastmasters International",
"Promising Toastmaster of the Year (PY 2022-2023)",
"Tell me, pray, what explanation do you put upon their actions?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Cambridge, United Kingdom",
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"White Hat Hackers Association",
"London Bridge Toastmasters Club"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Vice President for Internal Affairs",
"Member"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2020-05-30",
"2022-06-15"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com",
""
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The affiliations Schema",
"type": "array"
},
"awards": {
"default": [],
"examples": [
[
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
]
],
"items": {
"examples": [
{
"date": "2023-05-09",
"highlights": null,
"issuer": "Toastmasters International",
"location": "City of London, United Kingdom",
"title": "Champion in the Division A District X Speech Evaluation Contest",
"url": ""
},
{
"date": "2020-07-12",
"highlights": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"issuer": "Sasin School of Management",
"location": "Bangkok, Thailand",
"title": "Finalist in the 2020 SCG Bangkok Business Challenge Global Competition",
"url": ""
}
],
"properties": {
"date": {
"examples": [
"2023-05-09",
"2020-07-12"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"highlights": {
"examples": [
null,
[
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
]
],
"items": {
"examples": [
"Made it to the Top 5 (selected from over 100 teams) in the world for the semi-finals of the SCG Bangkok Business Challenge #sym.at Sasin 2020 Global Competition held at Bangkok, Thailand from July 7-12, 2020.",
"Served as the speaker and presented in the 60-second pitch round of the Opening Reception of the SCG Bangkok Business Challenge #sym.at Sasin 2022 for Team London Bridge."
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"null",
"array"
]
},
"issuer": {
"examples": [
"Toastmasters International",
"Sasin School of Management"
],
"title": "The issuer Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom",
"Bangkok, Thailand"
],
"title": "The location Schema",
"type": "string"
},
"title": {
"examples": [
"Champion in the Division A District X Speech Evaluation Contest",
"Finalist in the 2020 SCG Bangkok Business Challenge Global Competition"
],
"title": "The title Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"title",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The awards Schema",
"type": "array"
},
"certificates": {
"default": [],
"examples": [
[
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"date": "2021-09-01",
"issuer": "Coursera",
"name": "Learning How to Learn: Powerful mental tools to help you master tough subjects",
"url": "https://example.com"
}
],
"properties": {
"date": {
"default": "",
"examples": [
"2021-09-01"
],
"format": "date",
"title": "The date Schema",
"type": "string"
},
"issuer": {
"default": "",
"examples": [
"Coursera"
],
"title": "The issuer Schema",
"type": "string"
},
"name": {
"default": "",
"examples": [
"Learning How to Learn: Powerful mental tools to help you master tough subjects"
],
"title": "The name Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer"
],
"title": "A Schema",
"type": "object"
},
"title": "The certificates Schema",
"type": [
"array",
"null"
]
},
"education": {
"default": [],
"examples": [
[
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
]
],
"items": {
"examples": [
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
"institution": "Open University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
},
{
"area": "Computer Science",
"courses": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"endDate": "2021-06-30",
"highlights": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"honors": [
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
],
"institution": "Harvard University",
"location": "City of London, United Kingdom",
"startDate": "2017-08-01",
"studyType": "Bachelor of Science",
"url": "https://example.com/"
}
],
"properties": {
"area": {
"examples": [
"Computer Science"
],
"title": "The area Schema",
"type": "string"
},
"courses": {
"examples": [
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
[
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
]
],
"items": {
"examples": [
"Algorithms & Data Structures",
"Applications in Quantitative Finance",
"Engineering Data Analysis",
"Compiler Architecture"
],
"title": "A Schema",
"type": "string"
},
"title": "The courses Schema",
"type": [
"array",
"null"
]
},
"endDate": {
"examples": [
"2021-06-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
[
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
]
],
"items": {
"examples": [
"*Thesis*: A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"*Activites*: Debating, Chess, Cricket"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"honors": {
"examples": [
[
"4.0 / 4.0 GPA",
"President's List",
"Dean's List"
],
[
"Summa Cum Laude (4.0 GPA)",
"President's List",
"Dean's List"
]
],
"items": {
"examples": [
"4.0 / 4.0 GPA",
"President's List",
"Dean's List",
"Summa Cum Laude (4.0 GPA)"
],
"title": "A Schema",
"type": "string"
},
"title": "The honors Schema",
"type": [
"array",
"null"
]
},
"institution": {
"examples": [
"Open University",
"Harvard University"
],
"title": "The institution Schema",
"type": "string"
},
"location": {
"examples": [
"City of London, United Kingdom"
],
"title": "The location Schema",
"type": "string"
},
"startDate": {
"examples": [
"2017-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"studyType": {
"examples": [
"Bachelor of Science"
],
"title": "The studyType Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"institution",
"area",
"studyType",
"startDate",
"endDate",
"location",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The education Schema",
"type": "array"
},
"interests": {
"default": [],
"examples": [
[
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
]
],
"items": {
"examples": [
"Video Games",
"Anime",
"Reading Non-fiction",
"Classical and Original Soundtrack Music"
],
"title": "A Schema",
"type": "string"
},
"title": "The interests Schema",
"type": "array"
},
"languages": {
"default": [],
"examples": [
[
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
]
],
"items": {
"examples": [
{
"fluency": "Native speaker",
"language": "English"
},
{
"fluency": "Native speaker",
"language": "German"
},
{
"fluency": "Basic proficiency",
"language": "Japanese"
}
],
"properties": {
"fluency": {
"examples": [
"Native speaker",
"Basic proficiency"
],
"title": "The fluency Schema",
"type": "string"
},
"language": {
"examples": [
"English",
"German",
"Japanese"
],
"title": "The language Schema",
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"title": "A Schema",
"type": "object"
},
"title": "The languages Schema",
"type": "array"
},
"personal": {
"default": {},
"examples": [
{
"email": "[email protected]",
"location": {
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
},
"name": "John Smith L. Doe",
"phone": "(+1) 987 6543 210",
"profiles": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"url": "https://johndoe.com"
}
],
"properties": {
"email": {
"default": "",
"examples": [
"[email protected]"
],
"format": "email",
"title": "The email Schema",
"type": [
"string",
"null"
]
},
"location": {
"default": {},
"examples": [
{
"city": "New York",
"country": "United States of America",
"postalCode": 1234,
"region": "New York"
}
],
"properties": {
"city": {
"default": "",
"examples": [
"New York"
],
"title": "The city Schema",
"type": "string"
},
"country": {
"default": "",
"examples": [
"United States of America"
],
"title": "The country Schema",
"type": "string"
},
"postalCode": {
"default": 0,
"examples": [
1234
],
"title": "The postalCode Schema",
"type": "integer"
},
"region": {
"default": "",
"examples": [
"New York"
],
"title": "The region Schema",
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"title": "The location Schema",
"type": [
"object",
"null"
]
},
"name": {
"default": "",
"examples": [
"John Smith L. Doe"
],
"title": "The name Schema",
"type": "string"
},
"phone": {
"default": "",
"examples": [
"(+1) 987 6543 210"
],
"title": "The phone Schema",
"type": [
"string",
"null"
]
},
"profiles": {
"default": [],
"examples": [
[
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
]
],
"items": {
"examples": [
{
"network": "LinkedIn",
"url": "https://linkedin.com/in/johndoe",
"username": "John Doe"
},
{
"network": "GitHub",
"url": "https://github.com/johndoe",
"username": "johndoe"
}
],
"properties": {
"network": {
"examples": [
"LinkedIn",
"GitHub"
],
"title": "The network Schema",
"type": "string"
},
"url": {
"examples": [
"https://linkedin.com/in/johndoe",
"https://github.com/johndoe"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
},
"username": {
"examples": [
"John Doe",
"johndoe"
],
"title": "The username Schema",
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The profiles Schema",
"type": "array"
},
"url": {
"default": "",
"examples": [
"https://johndoe.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"profiles"
],
"title": "The personal Schema",
"type": "object"
},
"projects": {
"default": [],
"examples": [
[
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
]
],
"items": {
"default": {},
"examples": [
{
"affiliation": "Open University",
"endDate": "2021-04-30",
"highlights": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"name": "Job Tailor",
"startDate": "2020-11-01",
"url": "https://example.com/"
}
],
"properties": {
"affiliation": {
"default": "",
"examples": [
"Open University"
],
"title": "The affiliation Schema",
"type": "string"
},
"endDate": {
"default": "",
"examples": [
"2021-04-30"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"default": [],
"examples": [
[
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
]
],
"items": {
"examples": [
"Created an AI-powered resume editor application that allowed users to easily create different resumes and cover letters specifically tailored to and customized for individual job descriptions based on their personal information in their complete curriculum vitae.",
"Acquired more than 100,000 user sign ups in 3 months and more than 10,000 active monthly users in its lifetime before being sold to investors.",
"Generated profit of upwards \\$20,000 yearly with a team of only four developers and three business operatives"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": "array"
},
"name": {
"default": "",
"examples": [
"Job Tailor"
],
"title": "The name Schema",
"type": "string"
},
"startDate": {
"default": "",
"examples": [
"2020-11-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com/"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The projects Schema",
"type": [
"array",
"null"
]
},
"publications": {
"default": [],
"examples": [
[
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "A convolutional neural network for predicting Greenland glacier melt and glacial water flow",
"publisher": "Theoretical and Computational Fluid Dynamics",
"releaseDate": "2020-09-30",
"url": "https://example.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"A convolutional neural network for predicting Greenland glacier melt and glacial water flow"
],
"title": "The name Schema",
"type": "string"
},
"publisher": {
"default": "",
"examples": [
"Theoretical and Computational Fluid Dynamics"
],
"title": "The publisher Schema",
"type": "string"
},
"releaseDate": {
"default": "",
"examples": [
"2020-09-30"
],
"format": "date",
"title": "The releaseDate Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"title": "A Schema",
"type": "object"
},
"title": "The publications Schema",
"type": [
"array",
"null"
]
},
"references": {
"default": [],
"examples": [
[
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
]
],
"items": {
"default": {},
"examples": [
{
"name": "Dr. Jane Austin",
"reference": "John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition.",
"url": "https://janeaustin.com"
}
],
"properties": {
"name": {
"default": "",
"examples": [
"Dr. Jane Austin"
],
"title": "The name Schema",
"type": "string"
},
"reference": {
"default": "",
"examples": [
"John was a great student. He was always eager to learn new things and was very passionate about his studies. As his mentor, I am proud to say that he was also a great leader and was able to lead his team to victory in the 2020 SCG Bangkok Business Challenge Global Competition."
],
"title": "The reference Schema",
"type": "string"
},
"url": {
"default": "",
"examples": [
"https://janeaustin.com"
],
"format": "uri",
"title": "The url Schema",
"type": "string"
}
},
"required": [
"name",
"reference"
],
"title": "A Schema",
"type": "object"
},
"title": "The references Schema",
"type": [
"array",
"null"
]
},
"skills": {
"default": [],
"examples": [
[
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
]
],
"items": {
"examples": [
{
"category": "Soft Skills",
"skills": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
]
},
{
"category": "Programming",
"skills": [
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
]
},
{
"category": "Tools",
"skills": [
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
]
},
{
"category": "Web Development",
"skills": [
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
]
},
{
"category": "BI & Data Analytics",
"skills": [
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
}
],
"properties": {
"category": {
"examples": [
"Soft Skills",
"Programming",
"Tools",
"Web Development",
"BI & Data Analytics"
],
"title": "The category Schema",
"type": "string"
},
"skills": {
"examples": [
[
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing"
],
[
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX"
],
[
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva"
],
[
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask"
],
[
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
]
],
"items": {
"examples": [
"Public Speaking",
"Debating",
"Communication",
"Critical Thinking",
"Leadership",
"Persuasive Writing",
"Technical Writing",
"Python",
"SQL, PostgreSQL",
"MATLAB/Octave",
"HTML",
"CSS",
"Javascript",
"Typst",
"LaTeX",
"Microsoft Word",
"Git",
"Docker",
"Visual Studio Code",
"Canva",
"React",
"Next.js",
"million.js",
"Svelte & Sveltekit",
"Tailwind CSS",
"Node.js",
"Deno",
"FastAPI",
"Flask",
"Microsoft Excel",
"Microsoft Power BI",
"Jupyter Notebook",
"Numpy",
"Pandas",
"Plotly",
"Altair"
],
"title": "A Schema",
"type": "string"
},
"title": "The skills Schema",
"type": "array"
}
},
"required": [
"category",
"skills"
],
"title": "A Schema",
"type": "object"
},
"title": "The skills Schema",
"type": "array"
},
"work": {
"default": [],
"examples": [
[
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
]
],
"items": {
"examples": [
{
"endDate": "present",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Remote / New York, New York",
"organization": "X Company",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
},
{
"endDate": "2023-05-31",
"highlights": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"location": "Pasadena, California",
"organization": "National Aeronautics and Space Administration - Jet Propulsion Laboratory",
"position": "Senior Developer",
"startDate": "2021-08-01",
"url": "https://example.com"
}
],
"properties": {
"endDate": {
"examples": [
"present",
"2023-05-31"
],
"title": "The endDate Schema",
"type": "string"
},
"highlights": {
"examples": [
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
[
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
]
],
"items": {
"examples": [
"This being the theory I hold, why need I be afraid of not being able to reconcile it with the case of my ancestors?",
"The wise man therefore always holds in these matters to this principle of selection: he rejects pleasures to secure other greater pleasures, or else he endures pains to avoid worse pains.",
"Do you really believe that they charged an armed enemy, or treated their children, their own flesh and blood, so cruelly, without a thought for their own interest or advantage?"
],
"title": "A Schema",
"type": "string"
},
"title": "The highlights Schema",
"type": [
"array",
"null"
]
},
"location": {
"examples": [
"Remote / New York, New York",
"Pasadena, California"
],
"title": "The location Schema",
"type": "string"
},
"organization": {
"examples": [
"X Company",
"National Aeronautics and Space Administration - Jet Propulsion Laboratory"
],
"title": "The organization Schema",
"type": "string"
},
"position": {
"examples": [
"Senior Developer"
],
"title": "The position Schema",
"type": "string"
},
"startDate": {
"examples": [
"2021-08-01"
],
"format": "date",
"title": "The startDate Schema",
"type": "string"
},
"url": {
"examples": [
"https://example.com"
],
"format": "uri",
"title": "The url Schema",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"title": "A Schema",
"type": "object"
},
"title": "The work Schema",
"type": "array"
}
},
"required": [
"personal",
"education",
"skills",
"languages"
],
"title": "jskherman/cv.typ schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | bfc35da6291fd46e851e90ca71162eb5f5e73567 | 2023-06-20T11:19:21 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"description": "Schema for the @jskherman's Curriculum Vitae YAML-Typst Template",
"properties": {
"affiliations": {
"items": {
"properties": {
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"organization",
"position",
"location",
"url",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"awards": {
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"issuer": {
"type": "string"
},
"location": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"title",
"date",
"issuer",
"url",
"location",
"highlights"
],
"type": "object"
},
"type": "array"
},
"certificates": {
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"issuer": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer",
"url"
],
"type": "object"
},
"type": "array"
},
"education": {
"items": {
"properties": {
"area": {
"type": "string"
},
"courses": {
"items": {
"type": "string"
},
"type": "array"
},
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"honors": {
"items": {
"type": "string"
},
"type": "array"
},
"institution": {
"type": "string"
},
"location": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"studyType": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"institution",
"url",
"area",
"studyType",
"startDate",
"endDate",
"location",
"honors",
"courses",
"highlights"
],
"type": "object"
},
"type": "array"
},
"interests": {
"items": {
"type": "string"
},
"type": "array"
},
"languages": {
"items": {
"properties": {
"fluency": {
"type": "string"
},
"language": {
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"type": "object"
},
"type": "array"
},
"personal": {
"properties": {
"email": {
"format": "email",
"type": "string"
},
"location": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"region": {
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"type": "object"
},
"name": {
"type": "string"
},
"phone": {
"type": "string"
},
"profiles": {
"items": {
"properties": {
"network": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"type": "object"
},
"type": "array"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"email",
"phone",
"url",
"location",
"profiles"
],
"type": "object"
},
"projects": {
"items": {
"properties": {
"affiliation": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"publications": {
"items": {
"properties": {
"name": {
"type": "string"
},
"publisher": {
"type": "string"
},
"releaseDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"type": "object"
},
"type": "array"
},
"references": {
"items": {
"properties": {
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"reference",
"url"
],
"type": "object"
},
"type": "array"
},
"skills": {
"items": {
"properties": {
"category": {
"type": "string"
},
"skills": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"category",
"skills"
],
"type": "object"
},
"type": "array"
},
"work": {
"items": {
"properties": {
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"organization",
"position",
"url",
"location",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"personal",
"work",
"education",
"affiliations",
"awards",
"certificates",
"publications",
"projects",
"skills",
"languages",
"interests",
"references"
],
"title": "@jskherman's CV Typst Schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | 91f3be550b4247fb164f69b45147a64bb9380a2d | 2023-06-20T11:17:16 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "http://jsonresume.org/schema",
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Schema for the @jskherman's Curriculum Vitae YAML-Typst Template",
"properties": {
"affiliations": {
"items": {
"properties": {
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"organization",
"position",
"location",
"url",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"awards": {
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"issuer": {
"type": "string"
},
"location": {
"type": "string"
},
"title": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"title",
"date",
"issuer",
"url",
"location",
"highlights"
],
"type": "object"
},
"type": "array"
},
"certificates": {
"items": {
"properties": {
"date": {
"format": "date",
"type": "string"
},
"issuer": {
"type": "string"
},
"name": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer",
"url"
],
"type": "object"
},
"type": "array"
},
"education": {
"items": {
"properties": {
"area": {
"type": "string"
},
"courses": {
"items": {
"type": "string"
},
"type": "array"
},
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"honors": {
"items": {
"type": "string"
},
"type": "array"
},
"institution": {
"type": "string"
},
"location": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"studyType": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"institution",
"url",
"area",
"studyType",
"startDate",
"endDate",
"location",
"honors",
"courses",
"highlights"
],
"type": "object"
},
"type": "array"
},
"interests": {
"items": {
"type": "string"
},
"type": "array"
},
"languages": {
"items": {
"properties": {
"fluency": {
"type": "string"
},
"language": {
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"type": "object"
},
"type": "array"
},
"personal": {
"properties": {
"email": {
"format": "email",
"type": "string"
},
"location": {
"properties": {
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"postalCode": {
"type": "string"
},
"region": {
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"type": "object"
},
"name": {
"type": "string"
},
"phone": {
"type": "string"
},
"profiles": {
"items": {
"properties": {
"network": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"type": "object"
},
"type": "array"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"email",
"phone",
"url",
"location",
"profiles"
],
"type": "object"
},
"projects": {
"items": {
"properties": {
"affiliation": {
"type": "string"
},
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"publications": {
"items": {
"properties": {
"name": {
"type": "string"
},
"publisher": {
"type": "string"
},
"releaseDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"type": "object"
},
"type": "array"
},
"references": {
"items": {
"properties": {
"name": {
"type": "string"
},
"reference": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"reference",
"url"
],
"type": "object"
},
"type": "array"
},
"skills": {
"items": {
"properties": {
"category": {
"type": "string"
},
"skills": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"category",
"skills"
],
"type": "object"
},
"type": "array"
},
"work": {
"items": {
"properties": {
"endDate": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": "array"
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
}
},
"required": [
"organization",
"position",
"url",
"location",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"personal",
"work",
"education",
"affiliations",
"awards",
"certificates",
"publications",
"projects",
"skills",
"languages",
"interests",
"references"
],
"title": "@jskherman's CV Typst Schema",
"type": "object"
} | Apache-2.0 | en |
jskherman/cv.typ | 22c655517e4f01760660df3bc0233aadf11b3026 | 2024-01-22T12:30:13 | cv.typ.schema.json | 272 | 2024-05-27T04:52:52.744244Z | {
"$id": "https://raw.githubusercontent.com/jskherman/cv.typ/main/cv.typ.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"certificates": {
"default": [],
"items": {
"default": {},
"properties": {
"date": {
"default": "",
"format": "date",
"type": "string"
},
"issuer": {
"default": "",
"type": "string"
},
"name": {
"default": "",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"date",
"issuer"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"default": {},
"interests": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"languages": {
"default": [],
"items": {
"properties": {
"fluency": {
"type": "string"
},
"language": {
"type": "string"
}
},
"required": [
"language",
"fluency"
],
"type": "object"
},
"type": "array"
},
"projects": {
"default": [],
"items": {
"default": {},
"properties": {
"affiliation": {
"default": "",
"type": "string"
},
"endDate": {
"default": "",
"type": "string"
},
"highlights": {
"default": [],
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"default": "",
"type": "string"
},
"startDate": {
"default": "",
"format": "date",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"url",
"affiliation",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"properties": {
"affiliations": {
"default": [],
"items": {
"properties": {
"endDate": {
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
},
"awards": {
"default": [],
"items": {
"date": {
"format": "date",
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"null",
"array"
]
},
"issuer": {
"type": "string"
},
"location": {
"type": "string"
},
"properties": {
"title": {
"type": "string"
}
},
"required": [
"title",
"date",
"issuer"
],
"type": "object",
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"type": "array"
},
"education": {
"default": [],
"items": {
"properties": {
"area": {
"type": "string"
},
"courses": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"endDate": {
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"honors": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"institution": {
"type": "string"
},
"location": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"studyType": {
"type": "string"
},
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"institution",
"area",
"studyType",
"startDate",
"endDate",
"location",
"highlights"
],
"type": "object"
},
"type": "array"
},
"personal": {
"default": {},
"properties": {
"email": {
"default": "",
"format": "email",
"type": [
"string",
"null"
]
},
"location": {
"default": {},
"properties": {
"city": {
"default": "",
"type": "string"
},
"country": {
"default": "",
"type": "string"
},
"postalCode": {
"default": 0,
"type": "integer"
},
"region": {
"default": "",
"type": "string"
}
},
"required": [
"city",
"region",
"postalCode",
"country"
],
"type": [
"object",
"null"
]
},
"name": {
"default": "",
"type": "string"
},
"phone": {
"default": "",
"type": [
"string",
"null"
]
},
"profiles": {
"default": [],
"items": {
"properties": {
"network": {
"type": "string"
},
"url": {
"format": "uri",
"type": "string"
},
"username": {
"type": "string"
}
},
"required": [
"network",
"username",
"url"
],
"type": "object"
},
"type": "array"
},
"url": {
"default": "",
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"name",
"profiles"
],
"type": "object"
},
"work": {
"default": [],
"items": {
"properties": {
"endDate": {
"type": "string"
},
"highlights": {
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"location": {
"type": "string"
},
"organization": {
"type": "string"
},
"position": {
"type": "string"
},
"startDate": {
"format": "date",
"type": "string"
},
"url": {
"format": "uri",
"type": [
"string",
"null"
]
}
},
"required": [
"organization",
"position",
"location",
"startDate",
"endDate",
"highlights"
],
"type": "object"
},
"type": "array"
}
},
"publications": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"type": "string"
},
"publisher": {
"default": "",
"type": "string"
},
"releaseDate": {
"default": "",
"format": "date",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"publisher",
"releaseDate",
"url"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"references": {
"default": [],
"items": {
"default": {},
"properties": {
"name": {
"default": "",
"type": "string"
},
"reference": {
"default": "",
"type": "string"
},
"url": {
"default": "",
"format": "uri",
"type": "string"
}
},
"required": [
"name",
"reference"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"required": [
"personal",
"education",
"skills",
"languages"
],
"skills": {
"default": [],
"items": {
"properties": {
"category": {
"type": "string"
},
"skills": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"category",
"skills"
],
"type": "object"
},
"type": "array"
},
"title": "jskherman/cv.typ schema",
"type": "object"
} | Apache-2.0 | en |
lowRISC/opentitan | da976a21c21895dad72e7b4b29a2d4707ce4caa8 | 2024-03-15T15:21:35 | sw/host/cryptotest/testvectors/data/schemas/drbg_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/hmac_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for HMAC testing",
"items": {
"additionalProperties": false,
"properties": {
"additional_input_1": {
"$ref": "#/$defs/byte_array",
"description": "First additional value"
},
"additional_input_2": {
"$ref": "#/$defs/byte_array",
"description": "Second additional value"
},
"algorithm": {
"description": "Should be drbg",
"enum": [
"drbg"
],
"type": "string"
},
"entropy": {
"$ref": "#/$defs/byte_array",
"description": "Initial entropy value"
},
"output": {
"$ref": "#/$defs/byte_array",
"description": "Expected random returned bits"
},
"personalization_string": {
"$ref": "#/$defs/byte_array",
"description": "Personalization string for instantiation"
},
"reseed": {
"description": "Whether the test requires reseeding",
"type": "boolean"
},
"reseed_additional_input": {
"$ref": "#/$defs/byte_array",
"description": "Additional value for reseed if reseed = True"
},
"reseed_entropy": {
"$ref": "#/$defs/byte_array",
"description": "Reseed entropy if reseed = True"
},
"result": {
"description": "Whether the returned bits should match `output`",
"type": "boolean"
},
"test_case_id": {
"description": "Test case ID number -- used for debugging",
"type": "integer"
},
"vendor": {
"description": "test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest HMAC Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 1de83177f7590b237d117dff21b1344c9e2425e5 | 2024-03-15T15:21:35 | sw/host/cryptotest/testvectors/data/schemas/hmac_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/hmac_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for HMAC testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be hmac",
"enum": [
"hmac"
],
"type": "string"
},
"hash_alg": {
"description": "Hash algorithm",
"enum": [
"sha-1",
"sha-224",
"sha-256",
"sha-384",
"sha-512",
"sha3-256",
"sha3-384",
"sha3-512"
],
"type": "string"
},
"key": {
"$ref": "#/$defs/byte_array",
"description": "Key to use for tag generation"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to generate tag for"
},
"result": {
"description": "Whether the output tag should match `tag`",
"type": "boolean"
},
"tag": {
"$ref": "#/$defs/byte_array",
"description": "Message tag output by HMAC"
},
"test_case_id": {
"description": "test_case_id",
"type": "integer"
},
"vendor": {
"description": "test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest HMAC Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | bcc541152b4563f07c8946e06974380a1f10aa0d | 2024-03-15T15:21:35 | sw/host/cryptotest/testvectors/data/schemas/rsa_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/rsa_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for RSA Signature Verification testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be rsa",
"enum": [
"rsa"
],
"type": "string"
},
"ciphertext": {
"$ref": "#/$defs/byte_array",
"description": "Ciphertext to decrypt"
},
"d": {
"$ref": "#/$defs/byte_array",
"description": "RSA private value d"
},
"e": {
"description": "RSA exponent e",
"type": "integer"
},
"hash_alg": {
"description": "Hash algorithm for message encoding",
"enum": [
"sha-256",
"sha-384",
"sha-512",
"sha3-224",
"sha3-256",
"sha3-384",
"sha3-512",
"shake-128",
"shake-256"
],
"type": "string"
},
"label": {
"$ref": "#/$defs/byte_array",
"description": "Label for OAEP encryption"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Un-hashed plaintext message"
},
"n": {
"$ref": "#/$defs/byte_array",
"description": "RSA public value n"
},
"operation": {
"description": "RSA operation",
"enum": [
"sign",
"verify",
"encrypt",
"decrypt"
],
"type": "string"
},
"padding": {
"description": "RSA padding type",
"enum": [
"pkcs1_1.5",
"pss",
"oaep"
],
"type": "string"
},
"result": {
"description": "Expected signature verification result",
"type": "boolean"
},
"security_level": {
"description": "RSA security level",
"enum": [
2048,
3072,
4096
],
"type": "integer"
},
"signature": {
"$ref": "#/$defs/byte_array",
"description": "RSA signature"
},
"test_case_id": {
"description": "Test case ID from test vector source -- used for debugging",
"type": "integer"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest RSA Signature Verification Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 788f3e61dfbf2518b160d7fd403feb21235666d8 | 2024-03-06T01:06:03 | sw/host/cryptotest/testvectors/data/schemas/aes_gcm_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/aes_gcm_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for AES-GCM testing",
"items": {
"additionalProperties": false,
"properties": {
"aad": {
"$ref": "#/$defs/byte_array",
"description": "Additional Authenticated Data"
},
"ciphertext": {
"$ref": "#/$defs/byte_array",
"description": "Ciphertext"
},
"iv": {
"$ref": "#/$defs/byte_array",
"description": "AES intermediate value"
},
"key": {
"$ref": "#/$defs/byte_array",
"description": "AES key"
},
"key_len": {
"description": "Length in bits of the key",
"enum": [
128,
192,
256
],
"type": "integer"
},
"mode": {
"description": "Should be GCM",
"enum": [
"gcm"
],
"type": "string"
},
"operation": {
"description": "AES-GCM operation type",
"enum": [
"encrypt",
"decrypt"
],
"type": "string"
},
"plaintext": {
"$ref": "#/$defs/byte_array",
"description": "Plaintext"
},
"result": {
"description": "Derivation result",
"type": "boolean"
},
"test_case_id": {
"description": "Incremental test case ID -- used for debugging",
"type": "integer"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"title": "Cryptotest AES-GCM Testvector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | df82e9a5e2ff20db3f44ace12e21e0ffd79bc8a0 | 2023-01-25T00:24:50 | rules/scripts/bitstreams_manifest.schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"bitstreamInfo": {
"description": "Bitstream build output",
"properties": {
"@type": {
"const": "bitstreamInfo",
"description": "Tag for type of this object",
"type": "string"
},
"design": {
"description": "Design name / top for the bitstream",
"type": "string"
}
},
"required": [
"@type",
"design"
],
"type": "object"
},
"memoryMapInfo": {
"description": "Build output that maps memories to cells in a hardware implementation",
"properties": {
"@type": {
"const": "memoryMapInfo",
"description": "Tag for type of this object",
"type": "string"
},
"design": {
"description": "Design name / top for the bitstream",
"type": "string"
},
"memoryId": {
"description": "Name or key identifying the associated memory",
"type": "string"
}
},
"required": [
"@type",
"design",
"memoryId"
],
"type": "object"
},
"outputFile": {
"description": "Information about a build output file",
"properties": {
"buildTarget": {
"description": "Build target that generated the output",
"type": "string"
},
"outputInfo": {
"oneOf": [
{
"$ref": "#/$defs/bitstreamInfo"
},
{
"$ref": "#/$defs/memoryMapInfo"
}
]
}
},
"required": [
"outputInfo"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/rules/scripts/bitstreams_manifest.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A manifest of bitstreams in a cache entry, informing what is there and how to reproduce",
"properties": {
"buildId": {
"description": "Build ID associated with this entry (typically a git hash)",
"type": "string"
},
"outputFiles": {
"additionalProperties": {
"$ref": "#/$defs/outputFile"
},
"description": "Map of output file paths to their metadata objects",
"type": "object"
},
"schemaVersion": {
"description": "Version number of this manifest's schema",
"maximum": 1,
"minimum": 1,
"type": "number"
}
},
"required": [
"schemaVersion",
"buildId",
"outputFiles"
],
"title": "Bitstreams Cache Manifest v1",
"type": "object"
} | Apache-2.0 | en |
lowRISC/opentitan | 94f2cf5f1142a31312a213b59c96d99edc400242 | 2024-04-02T16:38:33 | sw/host/cryptotest/testvectors/data/schemas/ed25519_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/ed25519_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for Ed25519 Signature Verification testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be ed25519",
"enum": [
"ed25519"
],
"type": "string"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to be verified"
},
"operation": {
"description": "Ed25519 operation",
"enum": [
"verify"
],
"type": "string"
},
"public_key": {
"$ref": "#/$defs/byte_array",
"description": "Public key to use for verification"
},
"result": {
"description": "Verification result",
"type": "boolean"
},
"signature": {
"$ref": "#/$defs/byte_array",
"description": "Signature to verify"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest Ed25519 Signature Verification Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 6a66a71912870698c70876db759121fc5b2d857e | 2024-02-15T14:47:27 | sw/host/cryptotest/testvectors/data/schemas/ecdh_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/ecdh_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for ECDH Key Derivation testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be ecdh",
"enum": [
"ecdh"
],
"type": "string"
},
"curve": {
"description": "Curve type",
"enum": [
"p256",
"p384"
],
"type": "string"
},
"d": {
"$ref": "#/$defs/byte_array",
"description": "Private key d"
},
"operation": {
"description": "ECDH operation",
"enum": [
"derive"
],
"type": "string"
},
"qx": {
"$ref": "#/$defs/byte_array",
"description": "Peer's public key x coordinate"
},
"qy": {
"$ref": "#/$defs/byte_array",
"description": "Peer's public key y coordinate"
},
"result": {
"description": "Derivation result",
"type": "boolean"
},
"test_case_id": {
"description": "Test case ID from test vector source -- used for debugging",
"type": "integer"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
},
"z": {
"$ref": "#/$defs/byte_array",
"description": "Shared key Z"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest ECDH Key Derivation Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 9bcbd840ccf71a92b01628bfbcd71e3ab7512f1c | 2024-03-20T19:51:00 | sw/host/cryptotest/testvectors/data/schemas/hash_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/hash_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for SHA-2, SHA-3, SHAKE, and cSHAKE testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "The hash algorithm being tested",
"enum": [
"sha-224",
"sha-256",
"sha-384",
"sha-512",
"sha3-224",
"sha3-256",
"sha3-384",
"sha3-512",
"shake-128",
"shake-256",
"cshake-128",
"cshake-256"
],
"type": "string"
},
"customization_string": {
"$ref": "#/$defs/byte_array",
"description": "Customization string if using cSHAKE"
},
"digest": {
"$ref": "#/$defs/byte_array",
"description": "Digest output by the hash function"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to be hashed"
},
"result": {
"description": "Whether the hash of `message` should be equal to `digest`",
"type": "boolean"
},
"test_case_id": {
"description": "Test_case_id",
"type": "integer"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest Hash Function Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | fe4db384f1e7b9a65b0ffab438f171638026979e | 2024-02-09T15:12:03 | sw/host/cryptotest/testvectors/data/schemas/hmac_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/hmac_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for HMAC testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be hmac",
"enum": [
"hmac"
],
"type": "string"
},
"hash_alg": {
"description": "Hash algorithm",
"enum": [
"sha-1",
"sha-224",
"sha-256",
"sha-384",
"sha-512"
],
"type": "string"
},
"key": {
"$ref": "#/$defs/byte_array",
"description": "Key to use for tag generation"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to generate tag for"
},
"result": {
"description": "Whether the output tag should match `tag`",
"type": "boolean"
},
"tag": {
"$ref": "#/$defs/byte_array",
"description": "Message tag output by HMAC"
},
"test_case_id": {
"description": "test_case_id",
"type": "integer"
},
"vendor": {
"description": "test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest HMAC Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | a49ba8d1caef5dfc94fcf834ee7e6b930e9ddb11 | 2024-03-26T15:58:28 | sw/host/cryptotest/testvectors/data/schemas/ecdsa_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/ecdsa_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for ECDSA Signature Verification testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be ecdsa",
"enum": [
"ecdsa"
],
"type": "string"
},
"curve": {
"description": "Curve type",
"enum": [
"p256",
"p384"
],
"type": "string"
},
"d": {
"description": "d parameter",
"type": "string"
},
"hash_alg": {
"description": "Hash algorithm",
"enum": [
"sha-1",
"sha-224",
"sha-256",
"sha-384",
"sha-512",
"sha3-256",
"sha3-384",
"sha3-512"
],
"type": "string"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to be verified"
},
"operation": {
"description": "ECDSA operation",
"enum": [
"sign",
"verify"
],
"type": "string"
},
"qx": {
"description": "Qx",
"type": "string"
},
"qy": {
"description": "Qy",
"type": "string"
},
"r": {
"description": "r parameter",
"type": "string"
},
"result": {
"description": "Verification result",
"type": "boolean"
},
"s": {
"description": "s parameter",
"type": "string"
},
"test_case_id": {
"description": "test_case_id",
"type": "integer"
},
"vendor": {
"description": "test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest ECDSA Signature Verification Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 73fc849dae1a82547d90476603077e2ef6521d57 | 2024-04-12T14:29:47 | sw/host/cryptotest/testvectors/data/schemas/ecdsa_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/ecdsa_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for ECDSA Signature Verification testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be ecdsa",
"enum": [
"ecdsa"
],
"type": "string"
},
"curve": {
"description": "Curve type",
"enum": [
"p256",
"p384"
],
"type": "string"
},
"d": {
"description": "d parameter",
"type": "string"
},
"hash_alg": {
"description": "Hash algorithm",
"enum": [
"sha-1",
"sha-224",
"sha-256",
"sha-384",
"sha-512",
"sha3-256",
"sha3-384",
"sha3-512"
],
"type": "string"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to be verified"
},
"operation": {
"description": "ECDSA operation",
"enum": [
"sign",
"verify"
],
"type": "string"
},
"qx": {
"description": "Qx",
"type": "string"
},
"qy": {
"description": "Qy",
"type": "string"
},
"r": {
"description": "r parameter",
"type": "string"
},
"result": {
"description": "Verification result",
"type": "boolean"
},
"s": {
"description": "s parameter",
"type": "string"
},
"test_case_id": {
"description": "test_case_id",
"type": "integer"
},
"vendor": {
"description": "test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest ECDSA Signature Verification Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 18dee68d0124112dfe95c12a46dd09df8da28880 | 2024-03-14T16:56:56 | sw/host/cryptotest/testvectors/data/schemas/ecdh_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/ecdh_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for ECDH Key Derivation testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be ecdh",
"enum": [
"ecdh"
],
"type": "string"
},
"curve": {
"description": "Curve type",
"enum": [
"p256",
"p384"
],
"type": "string"
},
"d": {
"$ref": "#/$defs/byte_array",
"description": "Private key d, in big-endian two's-complement notation"
},
"operation": {
"description": "ECDH operation",
"enum": [
"derive"
],
"type": "string"
},
"qx": {
"$ref": "#/$defs/byte_array",
"description": "Peer's public key x coordinate"
},
"qy": {
"$ref": "#/$defs/byte_array",
"description": "Peer's public key y coordinate"
},
"result": {
"description": "Derivation result",
"type": "boolean"
},
"test_case_id": {
"description": "Test case ID from test vector source -- used for debugging",
"type": "integer"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
},
"z": {
"$ref": "#/$defs/byte_array",
"description": "Shared key Z"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest ECDH Key Derivation Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 4e630dd7fe9bc1f626a9faafed164637e2ff7a9d | 2024-02-13T20:52:59 | sw/host/cryptotest/testvectors/data/schemas/hash_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/hash_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for SHA-2, SHA-3, SHAKE, and cSHAKE testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "The hash algorithm being tested",
"enum": [
"sha-224",
"sha-256",
"sha-384",
"sha-512",
"sha3-256",
"sha3-384",
"sha3-512",
"shake-128",
"shake-256"
],
"type": "string"
},
"digest": {
"$ref": "#/$defs/byte_array",
"description": "Digest output by the hash function"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to be hashed"
},
"result": {
"description": "Whether the hash of `message` should be equal to `digest`",
"type": "boolean"
},
"test_case_id": {
"description": "Test_case_id",
"type": "integer"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest Hash Function Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 4e847d9cac3bbe8bfdd3f4352c5c7a533bdbd268 | 2024-03-11T21:41:06 | sw/host/cryptotest/testvectors/data/schemas/aes_gcm_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/aes_gcm_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for AES-GCM testing",
"items": {
"additionalProperties": false,
"properties": {
"aad": {
"$ref": "#/$defs/byte_array",
"description": "Additional Authenticated Data"
},
"ciphertext": {
"$ref": "#/$defs/byte_array",
"description": "Ciphertext"
},
"iv": {
"$ref": "#/$defs/byte_array",
"description": "AES intermediate value"
},
"key": {
"$ref": "#/$defs/byte_array",
"description": "AES key"
},
"key_len": {
"description": "Length in bits of the key",
"enum": [
128,
192,
256
],
"type": "integer"
},
"mode": {
"description": "Should be GCM",
"enum": [
"gcm"
],
"type": "string"
},
"operation": {
"description": "AES-GCM operation type",
"enum": [
"encrypt",
"decrypt"
],
"type": "string"
},
"plaintext": {
"$ref": "#/$defs/byte_array",
"description": "Plaintext"
},
"result": {
"description": "Derivation result",
"type": "boolean"
},
"tag": {
"$ref": "#/$defs/byte_array",
"description": "Authentication Tag"
},
"test_case_id": {
"description": "Incremental test case ID -- used for debugging",
"type": "integer"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"title": "Cryptotest AES-GCM Testvector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 19de1c00963a7d4348b0c7feb64e97eec885f04f | 2023-07-27T20:36:38 | rules/scripts/bitstreams_manifest.schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"bitstream_info": {
"description": "Bitstream build output",
"properties": {
"build_target": {
"description": "Build target that generated the output",
"type": "string"
},
"file": {
"description": "Path to bitstream file relative to root",
"type": "string"
}
},
"required": [
"file"
],
"type": "object"
},
"design": {
"description": "Files and metadata related to a design",
"properties": {
"bitstream": {
"$ref": "#/$defs/bitstream_info"
},
"build_id": {
"description": "Build ID associated with this design's output (typically a git hash)",
"type": "string"
},
"memory_map_info": {
"additionalProperties": {
"$ref": "#/$defs/memory_map_info"
},
"description": "Map of name or key identifying the associated memory to file describing contents",
"type": "object"
}
},
"required": [
"bitstream"
],
"type": "object"
},
"memory_map_info": {
"description": "Build output that maps memories to cells in a hardware implementation",
"properties": {
"build_target": {
"description": "Build target that generated the output",
"type": "string"
},
"file": {
"description": "Path to file with memory contents, relative to root",
"type": "string"
}
},
"required": [
"file"
],
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/rules/scripts/bitstreams_manifest.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A manifest of bitstreams in a cache entry, informing what is there and how to reproduce",
"properties": {
"designs": {
"additionalProperties": {
"$ref": "#/$defs/design"
},
"description": "Map of designs to their files and metadata objects",
"type": "object"
},
"schema_version": {
"description": "Version number of this manifest's schema",
"maximum": 2,
"minimum": 2,
"type": "number"
}
},
"required": [
"schema_version",
"designs"
],
"title": "Bitstreams Cache Manifest v2",
"type": "object"
} | Apache-2.0 | en |
lowRISC/opentitan | c19218ffe4863616d17773aded5e82669a46a317 | 2024-03-04T19:27:24 | sw/host/cryptotest/testvectors/data/schemas/kmac_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/kmac_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for KMAC testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be kmac",
"enum": [
"kmac"
],
"type": "string"
},
"customization_string": {
"$ref": "#/$defs/byte_array",
"description": "KMAC customization string"
},
"key": {
"$ref": "#/$defs/byte_array",
"description": "Key to use for tag generation"
},
"message": {
"$ref": "#/$defs/byte_array",
"description": "Message to generate tag for"
},
"mode": {
"description": "Whether to use Kmac128 or Kmac256",
"enum": [
128,
256
],
"type": "integer"
},
"result": {
"description": "Whether the output tag should match `tag`",
"type": "boolean"
},
"tag": {
"$ref": "#/$defs/byte_array",
"description": "Message tag output by KMAC"
},
"test_case_id": {
"description": "test_case_id",
"type": "integer"
},
"vendor": {
"description": "test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"minItems": 1,
"title": "Cryptotest KMAC Test Vector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 3332953bcd6fd8be8ee8aebe6acaf5d7f087094f | 2023-10-23T18:14:51 | sw/host/cryptotest/testvectors/data/schemas/aes_block_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/aes_block_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for AES block cipher testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "Should be AES",
"enum": [
"aes"
],
"type": "string"
},
"ciphertext": {
"$ref": "#/$defs/byte_array",
"description": "Ciphertext"
},
"iv": {
"$ref": "#/$defs/byte_array",
"description": "AES intermediate value"
},
"key": {
"$ref": "#/$defs/byte_array",
"description": "AES key"
},
"key_len": {
"description": "Length in bits of the key",
"enum": [
128,
192,
256
],
"type": "integer"
},
"mode": {
"description": "Block cipher mode of operation",
"enum": [
"cbc",
"cfb1",
"cfb8",
"cfb128",
"ecb",
"ofb"
],
"type": "string"
},
"operation": {
"description": "AES operation",
"enum": [
"encrypt",
"decrypt"
],
"type": "string"
},
"padding": {
"description": "Padding scheme",
"enum": [
"null",
"pkcs7",
"iso9797m2"
],
"type": "string"
},
"plaintext": {
"$ref": "#/$defs/byte_array",
"description": "Plaintext"
}
},
"type": "object"
},
"title": "Cryptotest AES Block Cipher Testvector",
"type": "array"
} | Apache-2.0 | en |
lowRISC/opentitan | 38ba5ec86fda6629432d327c730ccde640370669 | 2024-03-05T16:52:08 | sw/host/cryptotest/testvectors/data/schemas/aes_kw_schema.json | 2,393 | 2024-05-29T15:59:34.933762Z | {
"$defs": {
"byte_array": {
"items": {
"maximum": 255,
"minimum": 0,
"type": "integer"
},
"type": "array"
}
},
"$id": "https://raw.githubusercontent.com/lowRISC/opentitan/master/sw/host/cryptotest/testvectors/data/schemas/aes_kw_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "A list of testvectors for AES-KWP testing",
"items": {
"additionalProperties": false,
"properties": {
"algorithm": {
"description": "AES (Advanced Encryption Standard) or TDEA (Triple Data Encryption Algorithm)",
"enum": [
"aes",
"tdea"
],
"type": "string"
},
"ciphertext": {
"$ref": "#/$defs/byte_array",
"description": "Ciphertext"
},
"key": {
"$ref": "#/$defs/byte_array",
"description": "AES key"
},
"key_len": {
"description": "Length in bits of the key",
"enum": [
128,
192,
256
],
"type": "integer"
},
"operation": {
"description": "Operation type",
"enum": [
"encrypt",
"decrypt"
],
"type": "string"
},
"padding": {
"description": "Existence of padding",
"type": "boolean"
},
"plaintext": {
"$ref": "#/$defs/byte_array",
"description": "Plaintext"
},
"result": {
"description": "Derivation result",
"type": "boolean"
},
"test_case_id": {
"description": "Incremental test case ID -- used for debugging",
"type": "integer"
},
"transformation_mode": {
"description": "Cipher transformation mode used for encryption-decryption",
"enum": [
"null",
"inverse",
"forward"
],
"type": "string"
},
"vendor": {
"description": "Test vector vendor name",
"type": "string"
}
},
"type": "object"
},
"title": "Cryptotest AES-KWP Testvector",
"type": "array"
} | Apache-2.0 | en |
sodascience/metasyn | ede23375c14079c856207f3fcc6a82f24b12b440 | 2023-09-25T08:13:11 | metasyn/schema/generative_metadata_format.json | 31 | 2024-05-27T06:10:57.113762Z | {
"$defs": {
"DiscreteUniformDistribution": {
"properties": {
"name": {
"const": "DiscreteUniformDistribution"
},
"parameters": {
"properties": {
"high": {
"type": "integer"
},
"low": {
"type": "integer"
}
},
"required": [
"low",
"high"
],
"type": "object"
}
},
"type": "object"
},
"ExponentialDistribution": {
"properties": {
"name": {
"const": "ExponentialDistribution"
},
"parameters": {
"properties": {
"rate": {
"type": "number"
}
},
"required": [
"rate"
],
"type": "object"
}
},
"type": "object"
},
"FakerDistribution": {
"properties": {
"name": {
"const": "FakerDistribution"
},
"parameters": {
"properties": {
"faker_type": {
"type": "string"
},
"locale": {
"type": "string"
}
},
"required": [
"faker_type",
"locale"
],
"type": "object"
}
},
"type": "object"
},
"LogNormalDistribution": {
"properties": {
"name": {
"const": "LogNormalDistribution"
},
"parameters": {
"properties": {
"mu": {
"type": "number"
},
"sigma": {
"type": "number"
}
},
"required": [
"mu",
"sigma"
],
"type": "object"
}
},
"type": "object"
},
"MultinoulliDistribution": {
"properties": {
"name": {
"const": "MultinoulliDistribution"
},
"parameters": {
"properties": {
"labels": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"probs": {
"items": {
"type": "number"
},
"type": "array"
}
},
"required": [
"labels",
"probs"
],
"type": "object"
}
},
"type": "object"
},
"NormalDistribution": {
"properties": {
"name": {
"const": "NormalDistribution"
},
"parameters": {
"properties": {
"mean": {
"type": "number"
},
"std_dev": {
"type": "number"
}
},
"required": [
"mean",
"std_dev"
],
"type": "object"
}
},
"type": "object"
},
"PoissonDistribution": {
"properties": {
"name": {
"const": "PoissonDistribution"
},
"parameters": {
"properties": {
"mu": {
"type": "number"
}
},
"required": [
"mu"
],
"type": "object"
}
},
"type": "object"
},
"RegexDistribution": {
"properties": {
"name": {
"const": "RegexDistribution"
},
"parameters": {
"properties": {
"re_list": {
"items": {
"additionalItems": false,
"minItems": 2,
"prefixItems": [
{
"type": "string"
},
{
"type": "number"
}
],
"type": "array"
},
"type": "array"
}
},
"required": [
"re_list"
],
"type": "object"
}
},
"type": "object"
},
"TruncatedNormalDistribution": {
"properties": {
"name": {
"const": "TruncatedNormalDistribution"
},
"parameters": {
"properties": {
"lower_bound": {
"type": "number"
},
"mu": {
"type": "number"
},
"sigma": {
"type": "number"
},
"upper_bound": {
"type": "number"
}
},
"required": [
"lower_bound",
"upper_bound",
"mu",
"sigma"
],
"type": "object"
}
},
"type": "object"
},
"UniformDateDistribution": {
"properties": {
"name": {
"const": "UniformDateDistribution"
},
"parameters": {
"properties": {
"end": {
"type": "string"
},
"start": {
"type": "string"
}
},
"required": [
"start",
"end"
],
"type": "object"
}
},
"type": "object"
},
"UniformDateTimeDistribution": {
"properties": {
"name": {
"const": "UniformDateTimeDistribution"
},
"parameters": {
"properties": {
"end": {
"type": "string"
},
"precision": {
"type": "string"
},
"start": {
"type": "string"
}
},
"required": [
"start",
"end",
"precision"
],
"type": "object"
}
},
"type": "object"
},
"UniformDistribution": {
"properties": {
"name": {
"const": "UniformDistribution"
},
"parameters": {
"properties": {
"max_val": {
"type": "number"
},
"min_val": {
"type": "number"
}
},
"required": [
"min_val",
"max_val"
],
"type": "object"
}
},
"type": "object"
},
"UniformTimeDistribution": {
"properties": {
"name": {
"const": "UniformTimeDistribution"
},
"parameters": {
"properties": {
"end": {
"type": "string"
},
"precision": {
"type": "string"
},
"start": {
"type": "string"
}
},
"required": [
"start",
"end",
"precision"
],
"type": "object"
}
},
"type": "object"
},
"UniqueKeyDistribution": {
"properties": {
"name": {
"const": "UniqueKeyDistribution"
},
"parameters": {
"properties": {
"consecutive": {
"enum": [
0,
1
]
},
"low": {
"type": "integer"
}
},
"required": [
"low",
"consecutive"
],
"type": "object"
}
},
"type": "object"
},
"UniqueRegexDistribution": {
"properties": {
"name": {
"const": "UniqueRegexDistribution"
},
"parameters": {
"properties": {
"re_list": {
"items": {
"additionalItems": false,
"minItems": 2,
"prefixItems": [
{
"type": "string"
},
{
"type": "number"
}
],
"type": "array"
},
"type": "array"
}
},
"required": [
"re_list"
],
"type": "object"
}
},
"type": "object"
},
"all_dist_def": {
"anyOf": [
{
"$ref": "#/$defs/MultinoulliDistribution"
},
{
"$ref": "#/$defs/RegexDistribution"
},
{
"$ref": "#/$defs/UniqueRegexDistribution"
},
{
"$ref": "#/$defs/FakerDistribution"
},
{
"$ref": "#/$defs/LogNormalDistribution"
},
{
"$ref": "#/$defs/NormalDistribution"
},
{
"$ref": "#/$defs/UniformDistribution"
},
{
"$ref": "#/$defs/DiscreteUniformDistribution"
},
{
"$ref": "#/$defs/PoissonDistribution"
},
{
"$ref": "#/$defs/UniqueKeyDistribution"
},
{
"$ref": "#/$defs/UniformDateDistribution"
},
{
"$ref": "#/$defs/UniformTimeDistribution"
},
{
"$ref": "#/$defs/UniformDateTimeDistribution"
},
{
"$ref": "#/$defs/TruncatedNormalDistribution"
},
{
"$ref": "#/$defs/ExponentialDistribution"
}
]
}
},
"$id": "http://sodascience.github.io/generative_metadata_format/core/1.0.0/generative_metadata_format",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"n_columns": {
"type": "number"
},
"n_rows": {
"type": "number"
},
"provenance": {
"properties": {
"created by": {
"type": "object"
},
"creation time": {
"type": "string"
}
},
"required": [
"created by",
"creation time"
],
"type": "object"
},
"vars": {
"items": {
"properties": {
"description": {
"type": "string"
},
"distribution": {
"$ref": "#/$defs/all_dist_def"
},
"dtype": {
"type": "string"
},
"name": {
"type": "string"
},
"prop_missing": {
"type": "number"
},
"type": {
"enum": [
"discrete",
"continuous",
"string",
"categorical",
"date",
"datetime",
"time"
]
}
},
"type": "object"
},
"required": [
"name",
"type",
"dtype",
"provenance",
"prop_missing",
"distribution"
],
"type": "array"
}
},
"required": [
"n_rows",
"n_columns",
"vars"
],
"type": "object"
} | MIT | en |
rdkcentral/BundleGen | 4a3d4c10ab400a78588da146e06b2049bc481c55 | 2023-01-03T14:21:44 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"arch_type": {
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"devs_type": {
"items": {
"properties": {
"access": {
"type": "string"
},
"fileMode": {
"type": "integer"
},
"gid": {
"type": "integer"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"required": [
"type",
"path",
"major",
"minor"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"dobby_type": {
"properties": {
"dobbyInitPath": {
"type": "string"
},
"generateCompliantConfig": {
"type": "boolean"
},
"hookLauncherExecutablePath": {
"type": "string"
},
"hookLauncherParametersPath": {
"type": "string"
},
"pluginDependencies": {
"$ref": "#/$defs/supportedFeatures_type"
},
"pluginDir": {
"type": "string"
}
},
"type": "object"
},
"extraMounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gfxLibs_type": {
"items": {
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"src",
"dst"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gpu_type": {
"properties": {
"devs": {
"$ref": "#/$defs/devs_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"extraMounts": {
"$ref": "#/$defs/extraMounts_type"
},
"gfxLibs": {
"$ref": "#/$defs/gfxLibs_type"
},
"waylandDisplay": {
"type": "string"
},
"westeros": {
"$ref": "#/$defs/westeros_type"
}
},
"required": [
"gfxLibs"
],
"type": "object"
},
"hardware_type": {
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam": {
"type": "string"
}
},
"required": [
"graphics"
],
"type": "object"
},
"ipc_type": {
"properties": {
"debug": {
"type": "string"
},
"session": {
"type": "string"
},
"system": {
"type": "string"
}
},
"type": "object"
},
"journaldOptions_type": {
"properties": {
"priority": {
"type": "string"
}
},
"type": "object"
},
"logging_type": {
"else": {
"required": [
"mode"
]
},
"if": {
"properties": {
"mode": {
"const": "file"
}
}
},
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"enum": [
"file",
"journald",
"devnull"
],
"type": "string"
}
},
"then": {
"required": [
"mode",
"logDir"
]
},
"type": "object"
},
"minidump_type": {
"properties": {
"destinationPath": {
"type": "string"
}
},
"type": "object"
},
"mounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"network_type": {
"properties": {
"options": {
"$ref": "#/$defs/supportedFeatures_type"
}
},
"required": [
"options"
],
"type": "object"
},
"oomcrash_type": {
"properties": {
"path": {
"type": "string"
}
},
"type": "object"
},
"options_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"persistent_type": {
"properties": {
"fstype": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"storageDir"
],
"type": "object"
},
"rdk_type": {
"properties": {
"supportedFeatures": {
"$ref": "#/$defs/supportedFeatures_type"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"supportedFeatures"
],
"type": "object"
},
"resourceLimits_type": {
"items": {
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"hard",
"soft"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"root_type": {
"properties": {
"path": {
"type": "string"
},
"readonly": {
"type": "boolean"
}
},
"type": "object"
},
"storage_type": {
"properties": {
"persistent": {
"$ref": "#/$defs/persistent_type"
},
"temp": {
"$ref": "#/$defs/temp_type"
}
},
"type": "object"
},
"supportedFeatures_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"tarball_type": {
"properties": {
"fileMask": {
"type": "string"
},
"fileOwnershipSameAsUser": {
"type": "boolean"
}
},
"type": "object"
},
"temp_type": {
"properties": {
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
}
},
"type": "object"
},
"usersAndGroups_type": {
"properties": {
"uid": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"westeros_type": {
"properties": {
"hostSocket": {
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"arch": {
"$ref": "#/$defs/arch_type"
},
"disableUserNamespacing": {
"type": "boolean"
},
"dobby": {
"$ref": "#/$defs/dobby_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"gpu": {
"$ref": "#/$defs/gpu_type"
},
"hardware": {
"$ref": "#/$defs/hardware_type"
},
"hostname": {
"type": "string"
},
"ipc": {
"$ref": "#/$defs/ipc_type"
},
"journaldOptions": {
"$ref": "#/$defs/journaldOptions_type"
},
"logging": {
"$ref": "#/$defs/logging_type"
},
"minidump": {
"$ref": "#/$defs/minidump_type"
},
"mounts": {
"$ref": "#/$defs/mounts_type"
},
"network": {
"$ref": "#/$defs/network_type"
},
"oomcrash": {
"$ref": "#/$defs/oomcrash_type"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/$defs/rdk_type"
},
"resourceLimits": {
"$ref": "#/$defs/resourceLimits_type"
},
"root": {
"$ref": "#/$defs/root_type"
},
"storage": {
"$ref": "#/$defs/storage_type"
},
"tarball": {
"$ref": "#/$defs/tarball_type"
}
},
"required": [
"platformName",
"os",
"arch",
"rdk",
"hardware",
"network"
],
"type": "object"
} | Apache-2.0 | en |
rdkcentral/BundleGen | c0d183d1e84893530d7c70cb2a68395d9817cb5b | 2022-10-19T10:41:10 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"Arch": {
"additionalProperties": false,
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch",
"variant"
],
"title": "Arch",
"type": "object"
},
"Dev": {
"additionalProperties": false,
"properties": {
"access": {
"type": "string"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"access",
"major",
"minor",
"path",
"type"
],
"title": "Dev",
"type": "object"
},
"ExtraMount": {
"additionalProperties": false,
"properties": {
"destination": {
"type": "string"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"destination",
"options",
"source",
"type"
],
"title": "ExtraMount",
"type": "object"
},
"GPU": {
"additionalProperties": false,
"properties": {
"devs": {
"items": {
"$ref": "#/$defs/Dev"
},
"type": "array"
},
"envvar": {
"items": {
"type": "string"
},
"type": "array"
},
"extraMounts": {
"items": {
"$ref": "#/$defs/ExtraMount"
},
"type": "array"
},
"gfxLibs": {
"items": {
"$ref": "#/$defs/GfxLIB"
},
"type": "array"
}
},
"required": [
"devs",
"envvar",
"extraMounts",
"gfxLibs"
],
"title": "GPU",
"type": "object"
},
"GfxLIB": {
"additionalProperties": false,
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"dst",
"src"
],
"title": "GfxLIB",
"type": "object"
},
"Hardware": {
"additionalProperties": false,
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam_disabled": {
"type": "string"
}
},
"required": [
"graphics",
"maxRam_disabled"
],
"title": "Hardware",
"type": "object"
},
"LIB": {
"additionalProperties": false,
"properties": {
"apiversions": {
"items": {
"type": "string"
},
"type": "array"
},
"deps": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"parentlib": {
"$ref": "#/$defs/Parentlib"
},
"sublibs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"apiversions",
"deps",
"name"
],
"title": "LIB",
"type": "object"
},
"Logging": {
"additionalProperties": false,
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"type": "string"
}
},
"required": [
"logDir",
"mode"
],
"title": "Logging",
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"options": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"options"
],
"title": "Network",
"type": "object"
},
"Parentlib": {
"enum": [
"/lib/libc.so.6"
],
"title": "Parentlib",
"type": "string"
},
"Persistent": {
"additionalProperties": false,
"properties": {
"maxSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"maxSize",
"storageDir"
],
"title": "Persistent",
"type": "object"
},
"Rdk": {
"additionalProperties": false,
"properties": {
"supportedFeatures": {
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"type": "string"
}
},
"required": [
"supportedFeatures",
"version"
],
"title": "Rdk",
"type": "object"
},
"ResourceLimit": {
"additionalProperties": false,
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"hard",
"soft",
"type"
],
"title": "ResourceLimit",
"type": "object"
},
"Seccomp": {
"additionalProperties": false,
"properties": {
"architectures": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultAction": {
"type": "string"
},
"syscalls": {
"items": {
"$ref": "#/$defs/Syscall"
},
"type": "array"
}
},
"required": [
"architectures",
"defaultAction",
"syscalls"
],
"title": "Seccomp",
"type": "object"
},
"Storage": {
"additionalProperties": false,
"properties": {
"persistent": {
"$ref": "#/$defs/Persistent"
}
},
"required": [
"persistent"
],
"title": "Storage",
"type": "object"
},
"Syscall": {
"additionalProperties": false,
"properties": {
"action": {
"type": "string"
},
"names": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"action",
"names"
],
"title": "Syscall",
"type": "object"
},
"Welcome9": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Arch"
},
"disableUserNamespacing": {
"type": "boolean"
},
"envvar": {
"items": {
"type": "string"
},
"type": "array"
},
"gpu": {
"$ref": "#/$defs/GPU"
},
"hardware": {
"$ref": "#/$defs/Hardware"
},
"libs": {
"items": {
"$ref": "#/$defs/LIB"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/Logging"
},
"mounts": {
"items": {},
"type": "array"
},
"network": {
"$ref": "#/$defs/Network"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/$defs/Rdk"
},
"resourceLimits": {
"items": {
"$ref": "#/$defs/ResourceLimit"
},
"type": "array"
},
"seccomp": {
"$ref": "#/$defs/Seccomp"
},
"storage": {
"$ref": "#/$defs/Storage"
}
},
"required": [
"arch",
"disableUserNamespacing",
"envvar",
"gpu",
"hardware",
"libs",
"logging",
"mounts",
"network",
"os",
"platformName",
"rdk",
"resourceLimits",
"seccomp",
"storage"
],
"title": "Welcome9",
"type": "object"
}
},
"$ref": "#/$defs/Welcome9",
"$schema": "http://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
rdkcentral/BundleGen | 40c6f41ce488359f1910b7732b0717aa0a9414d5 | 2022-11-07T05:15:54 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"arch_type": {
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"devs_type": {
"items": {
"properties": {
"access": {
"type": "string"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"path",
"major",
"minor"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"extraMounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/supportedFeatures_type"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gfxLibs_type": {
"items": {
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"src",
"dst"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gpu_type": {
"properties": {
"devs": {
"$ref": "#/$defs/devs_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"extraMounts": {
"$ref": "#/$defs/extraMounts_type"
},
"gfxLibs": {
"$ref": "#/$defs/gfxLibs_type"
}
},
"required": [
"gfxLibs"
],
"type": "object"
},
"hardware_type": {
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam_disabled": {
"type": "string"
}
},
"required": [
"graphics",
"maxRam_disabled"
],
"type": "object"
},
"logging_type": {
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"type": "string"
}
},
"required": [
"mode",
"logDir"
],
"type": "object"
},
"mounts_type": {
"minItems": 0,
"type": "array"
},
"network_type": {
"properties": {
"options": {
"$ref": "#/$defs/supportedFeatures_type"
}
},
"required": [
"options"
],
"type": "object"
},
"persistent_type": {
"properties": {
"maxSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"storageDir"
],
"type": "object"
},
"rdk_type": {
"properties": {
"supportedFeatures": {
"$ref": "#/$defs/supportedFeatures_type"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"supportedFeatures"
],
"type": "object"
},
"resourceLimits_type": {
"items": {
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"hard",
"soft"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"storage_type": {
"properties": {
"persistent": {
"$ref": "#/$defs/persistent_type"
}
},
"type": "object"
},
"supportedFeatures_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"arch": {
"$ref": "#/$defs/arch_type"
},
"disableUserNamespacing": {
"type": "boolean"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"gpu": {
"$ref": "#/$defs/gpu_type"
},
"hardware": {
"$ref": "#/$defs/hardware_type"
},
"logging": {
"$ref": "#/$defs/logging_type"
},
"mounts": {
"$ref": "#/$defs/mounts_type"
},
"network": {
"$ref": "#/$defs/network_type"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/$defs/rdk_type"
},
"resourceLimits": {
"$ref": "#/$defs/resourceLimits_type"
},
"storage": {
"$ref": "#/$defs/storage_type"
}
},
"required": [
"platformName",
"os",
"arch",
"rdk",
"hardware",
"storage",
"gpu",
"network",
"logging"
],
"type": "object"
} | Apache-2.0 | en |
rdkcentral/BundleGen | 40c6f41ce488359f1910b7732b0717aa0a9414d5 | 2022-11-07T05:15:54 | bundlegen/schema/platform_libsSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"apiversions_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"deps_type": {
"minItems": 0,
"type": "array"
},
"libs_type": {
"items": {
"properties": {
"apiversions": {
"$ref": "#/$defs/apiversions_type"
},
"deps": {
"$ref": "#/$defs/deps_type"
},
"name": {
"type": "string"
}
},
"required": [
"apiversions",
"deps",
"name"
],
"type": "object"
},
"minItems": 0,
"type": "array"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"libs": {
"$ref": "#/$defs/libs_type"
}
},
"required": [
"libs"
],
"type": "object"
} | Apache-2.0 | en |
rdkcentral/BundleGen | 70b101415c948bac8ea354ad37ee3f6d7a955492 | 2022-10-18T07:25:41 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$ref": "#/definitions/Welcome9",
"$schema": "http://json-schema.org/draft-06/schema#",
"definitions": {
"Arch": {
"additionalProperties": false,
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch",
"variant"
],
"title": "Arch",
"type": "object"
},
"Dev": {
"additionalProperties": false,
"properties": {
"access": {
"type": "string"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"access",
"major",
"minor",
"path",
"type"
],
"title": "Dev",
"type": "object"
},
"ExtraMount": {
"additionalProperties": false,
"properties": {
"destination": {
"type": "string"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"destination",
"options",
"source",
"type"
],
"title": "ExtraMount",
"type": "object"
},
"GPU": {
"additionalProperties": false,
"properties": {
"devs": {
"items": {
"$ref": "#/definitions/Dev"
},
"type": "array"
},
"envvar": {
"items": {
"type": "string"
},
"type": "array"
},
"extraMounts": {
"items": {
"$ref": "#/definitions/ExtraMount"
},
"type": "array"
},
"gfxLibs": {
"items": {
"$ref": "#/definitions/GfxLIB"
},
"type": "array"
}
},
"required": [
"devs",
"envvar",
"extraMounts",
"gfxLibs"
],
"title": "GPU",
"type": "object"
},
"GfxLIB": {
"additionalProperties": false,
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"dst",
"src"
],
"title": "GfxLIB",
"type": "object"
},
"Hardware": {
"additionalProperties": false,
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam_disabled": {
"type": "string"
}
},
"required": [
"graphics",
"maxRam_disabled"
],
"title": "Hardware",
"type": "object"
},
"LIB": {
"additionalProperties": false,
"properties": {
"apiversions": {
"items": {
"type": "string"
},
"type": "array"
},
"deps": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"parentlib": {
"$ref": "#/definitions/Parentlib"
},
"sublibs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"apiversions",
"deps",
"name"
],
"title": "LIB",
"type": "object"
},
"Logging": {
"additionalProperties": false,
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"type": "string"
}
},
"required": [
"logDir",
"mode"
],
"title": "Logging",
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"options": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"options"
],
"title": "Network",
"type": "object"
},
"Parentlib": {
"enum": [
"/lib/libc.so.6"
],
"title": "Parentlib",
"type": "string"
},
"Persistent": {
"additionalProperties": false,
"properties": {
"maxSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"maxSize",
"storageDir"
],
"title": "Persistent",
"type": "object"
},
"Rdk": {
"additionalProperties": false,
"properties": {
"supportedFeatures": {
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"type": "string"
}
},
"required": [
"supportedFeatures",
"version"
],
"title": "Rdk",
"type": "object"
},
"ResourceLimit": {
"additionalProperties": false,
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"hard",
"soft",
"type"
],
"title": "ResourceLimit",
"type": "object"
},
"Seccomp": {
"additionalProperties": false,
"properties": {
"architectures": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultAction": {
"type": "string"
},
"syscalls": {
"items": {
"$ref": "#/definitions/Syscall"
},
"type": "array"
}
},
"required": [
"architectures",
"defaultAction",
"syscalls"
],
"title": "Seccomp",
"type": "object"
},
"Storage": {
"additionalProperties": false,
"properties": {
"persistent": {
"$ref": "#/definitions/Persistent"
}
},
"required": [
"persistent"
],
"title": "Storage",
"type": "object"
},
"Syscall": {
"additionalProperties": false,
"properties": {
"action": {
"type": "string"
},
"names": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"action",
"names"
],
"title": "Syscall",
"type": "object"
},
"Welcome9": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/definitions/Arch"
},
"disableUserNamespacing": {
"type": "boolean"
},
"envvar": {
"items": {
"type": "string"
},
"type": "array"
},
"gpu": {
"$ref": "#/definitions/GPU"
},
"hardware": {
"$ref": "#/definitions/Hardware"
},
"libs": {
"items": {
"$ref": "#/definitions/LIB"
},
"type": "array"
},
"logging": {
"$ref": "#/definitions/Logging"
},
"mounts": {
"items": {},
"type": "array"
},
"network": {
"$ref": "#/definitions/Network"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/definitions/Rdk"
},
"resourceLimits": {
"items": {
"$ref": "#/definitions/ResourceLimit"
},
"type": "array"
},
"seccomp": {
"$ref": "#/definitions/Seccomp"
},
"storage": {
"$ref": "#/definitions/Storage"
}
},
"required": [
"arch",
"disableUserNamespacing",
"envvar",
"gpu",
"hardware",
"libs",
"logging",
"mounts",
"network",
"os",
"platformName",
"rdk",
"resourceLimits",
"seccomp",
"storage"
],
"title": "Welcome9",
"type": "object"
}
}
} | Apache-2.0 | en |
rdkcentral/BundleGen | 236ae3df14472181242ccaa2e099955ce747aec1 | 2022-11-09T07:09:07 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"arch_type": {
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"devs_type": {
"items": {
"properties": {
"access": {
"type": "string"
},
"fileMode": {
"type": "integer"
},
"gid": {
"type": "integer"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"required": [
"type",
"path",
"major",
"minor"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"dobby_type": {
"properties": {
"dobbyInitPath": {
"type": "string"
},
"generateCompliantConfig": {
"type": "boolean"
},
"hookLauncherExecutablePath": {
"type": "string"
},
"hookLauncherParametersPath": {
"type": "string"
},
"plugin": {
"type": "string"
},
"pluginDependencies": {
"$ref": "#/$defs/supportedFeatures_type"
}
},
"type": "object"
},
"extraMounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gfxLibs_type": {
"items": {
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"src",
"dst"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gpu_type": {
"properties": {
"devs": {
"$ref": "#/$defs/devs_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"extraMounts": {
"$ref": "#/$defs/extraMounts_type"
},
"gfxLibs": {
"$ref": "#/$defs/gfxLibs_type"
},
"waylandDisplay": {
"type": "string"
},
"westeros": {
"$ref": "#/$defs/westeros_type"
}
},
"required": [
"gfxLibs"
],
"type": "object"
},
"hardware_type": {
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam": {
"type": "string"
}
},
"required": [
"graphics"
],
"type": "object"
},
"logging_type": {
"else": {
"required": [
"mode"
]
},
"if": {
"properties": {
"mode": {
"const": "file"
}
}
},
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"enum": [
"file",
"journald",
"devnull"
],
"type": "string"
}
},
"then": {
"required": [
"mode",
"logDir"
]
},
"type": "object"
},
"mounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"network_type": {
"properties": {
"options": {
"$ref": "#/$defs/supportedFeatures_type"
}
},
"required": [
"options"
],
"type": "object"
},
"options_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"persistent_type": {
"properties": {
"fstype": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"storageDir"
],
"type": "object"
},
"rdk_type": {
"properties": {
"supportedFeatures": {
"$ref": "#/$defs/supportedFeatures_type"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"supportedFeatures"
],
"type": "object"
},
"resourceLimits_type": {
"items": {
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"hard",
"soft"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"root_type": {
"properties": {
"path": {
"type": "string"
},
"readonly": {
"type": "boolean"
}
},
"type": "object"
},
"storage_type": {
"properties": {
"persistent": {
"$ref": "#/$defs/persistent_type"
},
"temp": {
"$ref": "#/$defs/temp_type"
}
},
"type": "object"
},
"supportedFeatures_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"tarball_type": {
"properties": {
"fileMask": {
"type": "string"
},
"fileOwnershipSameAsUser": {
"type": "boolean"
}
},
"type": "object"
},
"temp_type": {
"properties": {
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
}
},
"type": "object"
},
"usersAndGroups_type": {
"properties": {
"uid": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"westeros_type": {
"properties": {
"hostSocket": {
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"arch": {
"$ref": "#/$defs/arch_type"
},
"disableUserNamespacing": {
"type": "boolean"
},
"dobby": {
"$ref": "#/$defs/dobby_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"gpu": {
"$ref": "#/$defs/gpu_type"
},
"hardware": {
"$ref": "#/$defs/hardware_type"
},
"hostname": {
"type": "string"
},
"logging": {
"$ref": "#/$defs/logging_type"
},
"mounts": {
"$ref": "#/$defs/mounts_type"
},
"network": {
"$ref": "#/$defs/network_type"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/$defs/rdk_type"
},
"resourceLimits": {
"$ref": "#/$defs/resourceLimits_type"
},
"root": {
"$ref": "#/$defs/root_type"
},
"storage": {
"$ref": "#/$defs/storage_type"
},
"tarball": {
"$ref": "#/$defs/tarball_type"
}
},
"required": [
"platformName",
"os",
"arch",
"rdk",
"hardware",
"network"
],
"type": "object"
} | Apache-2.0 | en |
rdkcentral/BundleGen | 688977c056e996b6745c6e928a4b6e5cc62105f6 | 2023-02-16T18:41:34 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"arch_type": {
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"architectures_type": {
"items": {
"type": "string"
},
"type": "array"
},
"devs_type": {
"items": {
"properties": {
"access": {
"type": "string"
},
"fileMode": {
"type": "integer"
},
"gid": {
"type": "integer"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"required": [
"type",
"path",
"major",
"minor"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"dobby_type": {
"properties": {
"dobbyInitPath": {
"type": "string"
},
"generateCompliantConfig": {
"type": "boolean"
},
"hookLauncherExecutablePath": {
"type": "string"
},
"hookLauncherParametersPath": {
"type": "string"
},
"pluginDependencies": {
"$ref": "#/$defs/supportedFeatures_type"
},
"pluginDir": {
"type": "string"
}
},
"type": "object"
},
"extraMounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gfxLibs_type": {
"items": {
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"src",
"dst"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gpu_type": {
"properties": {
"devs": {
"$ref": "#/$defs/devs_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"extraMounts": {
"$ref": "#/$defs/extraMounts_type"
},
"gfxLibs": {
"$ref": "#/$defs/gfxLibs_type"
},
"waylandDisplay": {
"type": "string"
},
"westeros": {
"$ref": "#/$defs/westeros_type"
}
},
"required": [
"gfxLibs"
],
"type": "object"
},
"hardware_type": {
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam": {
"type": "string"
}
},
"required": [
"graphics"
],
"type": "object"
},
"ipc_type": {
"properties": {
"debug": {
"type": "string"
},
"session": {
"type": "string"
},
"system": {
"type": "string"
}
},
"type": "object"
},
"journaldOptions_type": {
"properties": {
"priority": {
"type": "string"
}
},
"type": "object"
},
"logging_type": {
"else": {
"required": [
"mode"
]
},
"if": {
"properties": {
"mode": {
"const": "file"
}
}
},
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"enum": [
"file",
"journald",
"devnull"
],
"type": "string"
}
},
"then": {
"required": [
"mode",
"logDir"
]
},
"type": "object"
},
"minidump_type": {
"properties": {
"destinationPath": {
"type": "string"
}
},
"type": "object"
},
"mounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"names_type": {
"items": {
"type": "string"
},
"type": "array"
},
"network_type": {
"properties": {
"options": {
"$ref": "#/$defs/supportedFeatures_type"
}
},
"required": [
"options"
],
"type": "object"
},
"oomcrash_type": {
"properties": {
"path": {
"type": "string"
}
},
"type": "object"
},
"options_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"persistent_type": {
"properties": {
"fstype": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"storageDir"
],
"type": "object"
},
"rdk_type": {
"properties": {
"supportedFeatures": {
"$ref": "#/$defs/supportedFeatures_type"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"supportedFeatures"
],
"type": "object"
},
"resourceLimits_type": {
"items": {
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"hard",
"soft"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"root_type": {
"properties": {
"path": {
"type": "string"
},
"readonly": {
"type": "boolean"
}
},
"type": "object"
},
"seccomp_type": {
"properties": {
"architectures": {
"$ref": "#/$defs/architectures_type"
},
"defaultAction": {
"type": "string"
},
"syscalls": {
"$ref": "#/$defs/syscalls_type"
}
},
"type": "object"
},
"storage_type": {
"properties": {
"persistent": {
"$ref": "#/$defs/persistent_type"
},
"temp": {
"$ref": "#/$defs/temp_type"
}
},
"type": "object"
},
"supportedFeatures_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"syscalls_type": {
"properties": {
"action": {
"type": "string"
},
"names": {
"$ref": "#/$defs/names_type"
}
},
"type": "array"
},
"tarball_type": {
"properties": {
"fileMask": {
"type": "string"
},
"fileOwnershipSameAsUser": {
"type": "boolean"
}
},
"type": "object"
},
"temp_type": {
"properties": {
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
}
},
"type": "object"
},
"usersAndGroups_type": {
"properties": {
"uid": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"westeros_type": {
"properties": {
"hostSocket": {
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"apparmorProfile": {
"type": "string"
},
"arch": {
"$ref": "#/$defs/arch_type"
},
"disableUserNamespacing": {
"type": "boolean"
},
"dobby": {
"$ref": "#/$defs/dobby_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"gpu": {
"$ref": "#/$defs/gpu_type"
},
"hardware": {
"$ref": "#/$defs/hardware_type"
},
"hostname": {
"type": "string"
},
"ipc": {
"$ref": "#/$defs/ipc_type"
},
"journaldOptions": {
"$ref": "#/$defs/journaldOptions_type"
},
"logging": {
"$ref": "#/$defs/logging_type"
},
"minidump": {
"$ref": "#/$defs/minidump_type"
},
"mounts": {
"$ref": "#/$defs/mounts_type"
},
"network": {
"$ref": "#/$defs/network_type"
},
"oomcrash": {
"$ref": "#/$defs/oomcrash_type"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/$defs/rdk_type"
},
"resourceLimits": {
"$ref": "#/$defs/resourceLimits_type"
},
"root": {
"$ref": "#/$defs/root_type"
},
"seccomp": {
"$ref": "#/$defs/seccomp_type"
},
"storage": {
"$ref": "#/$defs/storage_type"
},
"tarball": {
"$ref": "#/$defs/tarball_type"
}
},
"required": [
"platformName",
"os",
"arch",
"rdk",
"hardware",
"network"
],
"type": "object"
} | Apache-2.0 | en |
rdkcentral/BundleGen | 391f8fe665518f64834928eae511b7af40e9083f | 2022-11-21T04:14:51 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"arch_type": {
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"devs_type": {
"items": {
"properties": {
"access": {
"type": "string"
},
"fileMode": {
"type": "integer"
},
"gid": {
"type": "integer"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
},
"uid": {
"type": "integer"
}
},
"required": [
"type",
"path",
"major",
"minor"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"dobby_type": {
"properties": {
"dobbyInitPath": {
"type": "string"
},
"generateCompliantConfig": {
"type": "boolean"
},
"hookLauncherExecutablePath": {
"type": "string"
},
"hookLauncherParametersPath": {
"type": "string"
},
"pluginDependencies": {
"$ref": "#/$defs/supportedFeatures_type"
},
"pluginDir": {
"type": "string"
}
},
"type": "object"
},
"extraMounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gfxLibs_type": {
"items": {
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"src",
"dst"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"gpu_type": {
"properties": {
"devs": {
"$ref": "#/$defs/devs_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"extraMounts": {
"$ref": "#/$defs/extraMounts_type"
},
"gfxLibs": {
"$ref": "#/$defs/gfxLibs_type"
},
"waylandDisplay": {
"type": "string"
},
"westeros": {
"$ref": "#/$defs/westeros_type"
}
},
"required": [
"gfxLibs"
],
"type": "object"
},
"hardware_type": {
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam": {
"type": "string"
}
},
"required": [
"graphics"
],
"type": "object"
},
"logging_type": {
"else": {
"required": [
"mode"
]
},
"if": {
"properties": {
"mode": {
"const": "file"
}
}
},
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"enum": [
"file",
"journald",
"devnull"
],
"type": "string"
}
},
"then": {
"required": [
"mode",
"logDir"
]
},
"type": "object"
},
"mounts_type": {
"items": {
"properties": {
"destination": {
"type": "string"
},
"options": {
"$ref": "#/$defs/options_type"
},
"source": {
"type": "string"
}
},
"required": [
"destination"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"network_type": {
"properties": {
"options": {
"$ref": "#/$defs/supportedFeatures_type"
}
},
"required": [
"options"
],
"type": "object"
},
"options_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"persistent_type": {
"properties": {
"fstype": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"storageDir"
],
"type": "object"
},
"rdk_type": {
"properties": {
"supportedFeatures": {
"$ref": "#/$defs/supportedFeatures_type"
},
"version": {
"type": "string"
}
},
"required": [
"version",
"supportedFeatures"
],
"type": "object"
},
"resourceLimits_type": {
"items": {
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"type",
"hard",
"soft"
],
"type": "object"
},
"minItems": 0,
"type": "array"
},
"root_type": {
"properties": {
"path": {
"type": "string"
},
"readonly": {
"type": "boolean"
}
},
"type": "object"
},
"storage_type": {
"properties": {
"persistent": {
"$ref": "#/$defs/persistent_type"
},
"temp": {
"$ref": "#/$defs/temp_type"
}
},
"type": "object"
},
"supportedFeatures_type": {
"items": {
"type": "string"
},
"minItems": 0,
"type": "array"
},
"tarball_type": {
"properties": {
"fileMask": {
"type": "string"
},
"fileOwnershipSameAsUser": {
"type": "boolean"
}
},
"type": "object"
},
"temp_type": {
"properties": {
"maxSize": {
"type": "string"
},
"maxTotalSize": {
"type": "string"
},
"minSize": {
"type": "string"
}
},
"type": "object"
},
"usersAndGroups_type": {
"properties": {
"uid": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch"
],
"type": "object"
},
"westeros_type": {
"properties": {
"hostSocket": {
"type": "string"
}
},
"type": "object"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema#",
"properties": {
"arch": {
"$ref": "#/$defs/arch_type"
},
"disableUserNamespacing": {
"type": "boolean"
},
"dobby": {
"$ref": "#/$defs/dobby_type"
},
"envvar": {
"$ref": "#/$defs/supportedFeatures_type"
},
"gpu": {
"$ref": "#/$defs/gpu_type"
},
"hardware": {
"$ref": "#/$defs/hardware_type"
},
"hostname": {
"type": "string"
},
"logging": {
"$ref": "#/$defs/logging_type"
},
"mounts": {
"$ref": "#/$defs/mounts_type"
},
"network": {
"$ref": "#/$defs/network_type"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/$defs/rdk_type"
},
"resourceLimits": {
"$ref": "#/$defs/resourceLimits_type"
},
"root": {
"$ref": "#/$defs/root_type"
},
"storage": {
"$ref": "#/$defs/storage_type"
},
"tarball": {
"$ref": "#/$defs/tarball_type"
}
},
"required": [
"platformName",
"os",
"arch",
"rdk",
"hardware",
"network"
],
"type": "object"
} | Apache-2.0 | en |
rdkcentral/BundleGen | ad123f65f56040317544cec2e06859533cee0214 | 2022-10-19T10:48:10 | bundlegen/schema/platformSchema.json | 5 | 2024-05-27T22:16:16.460616Z | {
"$defs": {
"Arch": {
"additionalProperties": false,
"properties": {
"arch": {
"type": "string"
},
"variant": {
"type": "string"
}
},
"required": [
"arch",
"variant"
],
"title": "Arch",
"type": "object"
},
"Dev": {
"additionalProperties": false,
"properties": {
"access": {
"type": "string"
},
"major": {
"type": "integer"
},
"minor": {
"type": "integer"
},
"path": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"access",
"major",
"minor",
"path",
"type"
],
"title": "Dev",
"type": "object"
},
"ExtraMount": {
"additionalProperties": false,
"properties": {
"destination": {
"type": "string"
},
"options": {
"items": {
"type": "string"
},
"type": "array"
},
"source": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"destination",
"options",
"source",
"type"
],
"title": "ExtraMount",
"type": "object"
},
"GPU": {
"additionalProperties": false,
"properties": {
"devs": {
"items": {
"$ref": "#/$defs/Dev"
},
"type": "array"
},
"envvar": {
"items": {
"type": "string"
},
"type": "array"
},
"extraMounts": {
"items": {
"$ref": "#/$defs/ExtraMount"
},
"type": "array"
},
"gfxLibs": {
"items": {
"$ref": "#/$defs/GfxLIB"
},
"type": "array"
}
},
"required": [
"devs",
"envvar",
"extraMounts",
"gfxLibs"
],
"title": "GPU",
"type": "object"
},
"GfxLIB": {
"additionalProperties": false,
"properties": {
"dst": {
"type": "string"
},
"src": {
"type": "string"
}
},
"required": [
"dst",
"src"
],
"title": "GfxLIB",
"type": "object"
},
"Hardware": {
"additionalProperties": false,
"properties": {
"graphics": {
"type": "boolean"
},
"maxRam_disabled": {
"type": "string"
}
},
"required": [
"graphics",
"maxRam_disabled"
],
"title": "Hardware",
"type": "object"
},
"LIB": {
"additionalProperties": false,
"properties": {
"apiversions": {
"items": {
"type": "string"
},
"type": "array"
},
"deps": {
"items": {
"type": "string"
},
"type": "array"
},
"name": {
"type": "string"
},
"parentlib": {
"$ref": "#/$defs/Parentlib"
},
"sublibs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"apiversions",
"deps",
"name"
],
"title": "LIB",
"type": "object"
},
"Logging": {
"additionalProperties": false,
"properties": {
"logDir": {
"type": "string"
},
"mode": {
"type": "string"
}
},
"required": [
"logDir",
"mode"
],
"title": "Logging",
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"options": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"options"
],
"title": "Network",
"type": "object"
},
"Parentlib": {
"enum": [
"/lib/libc.so.6"
],
"title": "Parentlib",
"type": "string"
},
"Persistent": {
"additionalProperties": false,
"properties": {
"maxSize": {
"type": "string"
},
"storageDir": {
"type": "string"
}
},
"required": [
"maxSize",
"storageDir"
],
"title": "Persistent",
"type": "object"
},
"Rdk": {
"additionalProperties": false,
"properties": {
"supportedFeatures": {
"items": {
"type": "string"
},
"type": "array"
},
"version": {
"type": "string"
}
},
"required": [
"supportedFeatures",
"version"
],
"title": "Rdk",
"type": "object"
},
"ResourceLimit": {
"additionalProperties": false,
"properties": {
"hard": {
"type": "integer"
},
"soft": {
"type": "integer"
},
"type": {
"type": "string"
}
},
"required": [
"hard",
"soft",
"type"
],
"title": "ResourceLimit",
"type": "object"
},
"Seccomp": {
"additionalProperties": false,
"properties": {
"architectures": {
"items": {
"type": "string"
},
"type": "array"
},
"defaultAction": {
"type": "string"
},
"syscalls": {
"items": {
"$ref": "#/$defs/Syscall"
},
"type": "array"
}
},
"required": [
"architectures",
"defaultAction",
"syscalls"
],
"title": "Seccomp",
"type": "object"
},
"Storage": {
"additionalProperties": false,
"properties": {
"persistent": {
"$ref": "#/$defs/Persistent"
}
},
"required": [
"persistent"
],
"title": "Storage",
"type": "object"
},
"Syscall": {
"additionalProperties": false,
"properties": {
"action": {
"type": "string"
},
"names": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"action",
"names"
],
"title": "Syscall",
"type": "object"
},
"Welcome9": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Arch"
},
"disableUserNamespacing": {
"type": "boolean"
},
"envvar": {
"items": {
"type": "string"
},
"type": "array"
},
"gpu": {
"$ref": "#/$defs/GPU"
},
"hardware": {
"$ref": "#/$defs/Hardware"
},
"libs": {
"items": {
"$ref": "#/$defs/LIB"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/Logging"
},
"mounts": {
"items": {},
"type": "array"
},
"network": {
"$ref": "#/$defs/Network"
},
"os": {
"type": "string"
},
"platformName": {
"type": "string"
},
"rdk": {
"$ref": "#/$defs/Rdk"
},
"resourceLimits": {
"items": {
"$ref": "#/$defs/ResourceLimit"
},
"type": "array"
},
"seccomp": {
"$ref": "#/$defs/Seccomp"
},
"storage": {
"$ref": "#/$defs/Storage"
}
},
"required": [
"arch",
"disableUserNamespacing",
"envvar",
"gpu",
"hardware",
"libs",
"logging",
"mounts",
"network",
"os",
"platformName",
"rdk",
"resourceLimits",
"seccomp",
"storage"
],
"title": "Welcome9",
"type": "object"
}
},
"$ref": "#/$defs/Welcome9",
"$schema": "http://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
unum-cloud/ustore | 0f833467c09441c156cf4842339482b49e5be774 | 2023-04-16T10:00:32 | assets/configs/collection.schema.json | 496 | 2024-05-27T05:47:15.408345Z | {
"$id": "http://github.com/unum-cloud/ustore/collection.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"expected_max_size": {},
"type": {
"default": "binary",
"enum": [
"binary",
"graph",
"doc"
],
"pattern": "binary|graph|doc",
"type": "string"
},
"value_length_bytes": {
"exclusiveMinimum": 0,
"maximum": 4096,
"type": "integer"
}
},
"type": "object"
} | Apache-2.0 | en |
unum-cloud/ustore | 0f833467c09441c156cf4842339482b49e5be774 | 2023-04-16T10:00:32 | assets/configs/db.schema.json | 496 | 2024-05-27T05:47:15.408345Z | {
"$id": "http://github.com/unum-cloud/ustore/collection.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"config_path": {
"description": "For RocksDB and LevelDB provides path to config file",
"minLength": 1,
"type": "string"
},
"max_concurrent_sessions": {
"minimum": 0,
"type": "integer"
},
"path": {
"description": "Default data location. Optional for in-memory stores",
"minLength": 1,
"type": "string"
},
"ram_limit_kilobytes": {
"description": "Total amount of RAM available to running DBMS",
"exclusiveMinimum": 0,
"type": "integer"
},
"ram_limit_per_transaction_kilobytes": {
"exclusiveMinimum": 0,
"type": "integer"
},
"threads": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"ram_limit_per_transaction_kilobytes"
],
"type": "object"
} | Apache-2.0 | en |
Siemens-Healthineers/K2s | 03a151e542d1b063ecfd98a76b8acda00696d283 | 2024-01-16T11:21:03 | addons/addon.manifest.schema.json | 25 | 2024-05-27T06:15:55.444654Z | {
"$defs": {
"command": {
"$id": "/schemas/command",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Command manifest containing all metadata for defining addon CLI commands for k2s executable",
"properties": {
"cli": {
"description": "The CLI config",
"properties": {
"examples": {
"description": "Command usage examples for CLI help generation",
"items": {
"description": "CLI usage example",
"properties": {
"cmd": {
"description": "The actual CLI example, e.g. 'k2s addons enable <addon-name>'",
"type": "string"
},
"comment": {
"description": "Comment to be displayed above the command example, e.g. 'this enables the addon <addon-name>'",
"type": "string"
}
},
"required": [
"cmd"
],
"type": "object"
},
"type": "array"
},
"flags": {
"description": "The available CLI flags",
"items": {
"description": "CLI flag config",
"properties": {
"constraints": {
"description": "flag value constraints",
"else": {
"properties": {
"range": {
"description": "range of valid values",
"properties": {
"max": {
"type": "number"
},
"min": {
"type": "number"
}
},
"required": [
"min",
"max"
],
"type": "object"
}
},
"required": [
"range"
]
},
"if": {
"properties": {
"kind": {
"const": "validation-set"
}
}
},
"properties": {
"kind": {
"default": "validation-set",
"enum": [
"validation-set",
"range"
]
}
},
"required": [
"kind"
],
"then": {
"properties": {
"validationSet": {
"description": "set of valid values",
"items": {
"type": "string"
},
"minItems": 1,
"type": "array",
"uniqueItems": true
}
},
"required": [
"validationSet"
]
},
"type": "object"
},
"default": {
"description": "flag default value",
"type": [
"number",
"string",
"boolean"
]
},
"description": {
"description": "flag description for CLI help generation",
"type": "string"
},
"name": {
"description": "flag name as it is used via CLI, e.g. 'proxy' for usage '--proxy'",
"type": "string"
},
"shorthand": {
"description": "flag shorthand as it is used via CLI, e.g. 'p' for usage '-p'",
"type": "string"
}
},
"required": [
"name",
"default"
],
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"script": {
"description": "The PowerShell script config",
"properties": {
"parameterMappings": {
"description": "The mapping between CLI flags and PowerShell script parameters",
"items": {
"description": "CLI flag <-> PS parameter mapping",
"properties": {
"cliFlagName": {
"description": "name of the CLI flag",
"type": "string"
},
"scriptParameterName": {
"description": "name of the PS script Parameter",
"type": "string"
}
},
"required": [
"cliFlagName",
"scriptParameterName"
],
"type": "object"
},
"type": "array"
},
"subPath": {
"description": "The path (relative to the addon's directory) of the PowerShell script to be invoked when executing this command",
"type": "string"
}
},
"required": [
"subPath"
],
"type": "object"
}
},
"required": [
"script"
],
"type": "object"
},
"curl": {
"$id": "/schemas/curl",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"destination": {
"type": "string"
},
"url": {
"type": "string"
}
},
"required": [
"url",
"destination"
],
"type": "object"
},
"offline_usage": {
"$id": "/schemas/offline_usage",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Offline usage metadata for package/container image import/export",
"properties": {
"linux": {
"properties": {
"additionalImages": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"curl": {
"items": {
"$ref": "/schemas/curl"
},
"type": "array"
},
"deb": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"repos": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"repos",
"deb",
"additionalImages",
"curl"
],
"type": "object"
},
"windows": {
"properties": {
"curl": {
"items": {
"$ref": "/schemas/curl"
},
"type": "array"
}
},
"required": [
"curl"
],
"type": "object"
}
},
"required": [
"linux",
"windows"
],
"type": "object"
}
},
"$id": "https://github.com/Siemens-Healthineers/K2s/addon.manifest.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Addon manifest containing all metadata and available commands",
"properties": {
"apiVersion": {
"type": "string"
},
"kind": {
"const": "AddonManifest"
},
"metadata": {
"properties": {
"description": {
"description": "The description of an addon for user display",
"type": "string"
},
"name": {
"description": "The unique name of an addon",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
},
"spec": {
"properties": {
"commands": {
"description": "Metadata for mandatory commands the addon has to support/provide",
"properties": {
"disable": {
"$ref": "/schemas/command",
"description": "Command to enable the addon"
},
"enable": {
"$ref": "/schemas/command",
"description": "Command to enable the addon"
}
},
"required": [
"enable",
"disable"
],
"type": "object"
},
"offline_usage": {
"$ref": "/schemas/offline_usage"
}
},
"required": [
"commands"
],
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "Addon Manifest",
"type": "object"
} | MIT | en |
xddq/schema2typebox | ab48758b7c27abe9fa16108c9c521a19394b07ef | 2024-05-16T22:50:34 | test/fixture/dayOfWeek.json | 49 | 2024-05-27T05:30:33.568568Z | {
"$id": "schema:DayOfWeek",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "The day of the week, e.g. used to specify to which day the opening hours of an OpeningHoursSpecification refer.\n\nOriginally, URLs from [GoodRelations](http://purl.org/goodrelations/v1) were used (for [[Monday]], [[Tuesday]], [[Wednesday]], [[Thursday]], [[Friday]], [[Saturday]], [[Sunday]] plus a special entry for [[PublicHolidays]]); these have now been integrated directly into schema.org.\n ",
"oneOf": [
{
"const": "Friday",
"description": "The day of the week between Thursday and Saturday."
},
{
"const": "Monday",
"description": "The day of the week between Sunday and Tuesday."
},
{
"const": "PublicHolidays",
"description": "This stands for any day that is a public holiday; it is a placeholder for all official public holidays in some particular location. While not technically a \"day of the week\", it can be used with [[OpeningHoursSpecification]]. In the context of an opening hours specification it can be used to indicate opening hours on public holidays, overriding general opening hours for the day of the week on which a public holiday occurs."
},
{
"const": "Saturday",
"description": "The day of the week between Friday and Sunday."
},
{
"const": "Sunday",
"description": "The day of the week between Saturday and Monday."
},
{
"const": "Thursday",
"description": "The day of the week between Wednesday and Friday."
},
{
"const": "Tuesday",
"description": "The day of the week between Monday and Wednesday."
},
{
"const": "Wednesday",
"description": "The day of the week between Tuesday and Thursday."
}
],
"title": "DayOfWeek",
"type": "string"
} | MIT | en |
hyperledger/caliper | 56ecafa073ddb751375f3357200f84b4264ee13e | 2024-05-16T17:37:43 | json-schema/hyperledger-caliper-runtime-configuration.schema.json | 636 | 2024-05-27T04:42:01.150148Z | {
"$ref": "#/definitions/ConfigurationHelper",
"$schema": "https://json-schema.org/draft-06/schema",
"definitions": {
"ConfigurationHelper": {
"additionalProperties": false,
"properties": {
"caliper": {
"properties": {
"auth": {
"additionalProperties": false,
"description": "Define settings related to authorization for Prometheus and Prometheus push",
"properties": {
"prometheus": {
"additionalProperties": false,
"description": "Prometheus",
"properties": {
"password": {
"description": "Prometheus; password",
"type": "null"
},
"username": {
"description": "Prometheus; username",
"type": "null"
}
},
"title": "Prometheus",
"type": "object"
},
"prometheuspush": {
"additionalProperties": false,
"description": "Prometheus Push Gateway",
"properties": {
"password": {
"description": "Prometheus Push Gateway; password",
"type": "null"
},
"username": {
"description": "Prometheus Push Gateway; username",
"type": "null"
}
},
"title": "Prometheus Push",
"type": "object"
}
},
"title": "Authentication",
"type": "object"
},
"benchconfig": {
"description": "Path to the benchmark configuration file that describes the test worker(s), test rounds and monitors",
"title": "Bench Configuration",
"type": "null"
},
"bind": {
"additionalProperties": false,
"description": "We use the bind command to inform caliper which platform to target and which platform SDK version to use. Settings related to the binding command",
"properties": {
"args": {
"description": "The additional arguments to pass to the binding (i.e., npm install) command",
"type": "null"
},
"cwd": {
"description": "The Current Working Directory to use for the binding (i.e., npm install) command",
"type": "null"
},
"file": {
"description": "The file to use when binding (replace supported defaults)",
"type": "null"
},
"sut": {
"description": "SUT/platform name and SDK version: The binding specification of the SUT in the <SUT type>:<SDK version> format",
"type": "null"
}
},
"title": "Bind",
"type": "object"
},
"fabric": {
"additionalProperties": false,
"description": "Configurations related to the Fabric Connector",
"properties": {
"gateway": {
"additionalProperties": false,
"description": "Settings for the 1.4 SUT with gateway enabled option and the 2.2 SUT (except the enabled option)Settings for the 1.4 SUT with gateway enabled option and the 2.2 SUT (except the enabled option)",
"properties": {
"enabled": {
"description": "For 1.4 SUT, Indicates whether to use the Fabric Gateway API. For 2.2 SUT it is always true and cannot be changed",
"type": "boolean"
},
"eventstrategy": {
"description": "Which event strategy to use",
"type": "string"
},
"localhost": {
"description": "Indicates whether to convert discovered endpoints to localhost. Ignored when if discover is set to false in network config",
"type": "boolean"
},
"querystrategy": {
"description": "Which query strategy to use",
"type": "string"
}
},
"title": "Gateway",
"type": "object"
},
"latencythreshold": {
"description": "For 1.4 SUT without gateway enabled, determines the reported commit time of a transaction based on the given percentage of event sources",
"type": "integer"
},
"loadbalancing": {
"description": "For 1.4 SUT without gateway enabled, determines how automatic load balancing is applied if the worker callback module doesn\u2019t provide explicit targets. Use the value 'worker' to perform worker-based load balancing, meaning that each worker process will have fix target peers and target orderer. Use the value 'tx' to perform transaction-based load balancing, meaning that the peer and orderer targets change for every submitted transaction or query.",
"type": "string"
},
"timeout": {
"additionalProperties": false,
"description": "Contains worker-side timeouts",
"properties": {
"invokeorquery": {
"description": "The default timeout in seconds to use for invoking or querying transactions (applied for the entire life-cycle)",
"type": "integer"
}
},
"required": [
"invokeorquery"
],
"title": "Timeout",
"type": "object"
},
"verify": {
"additionalProperties": false,
"description": "Enables extra verification steps during the transaction proposal phase for 1.4 SUT without gateway being enabled",
"properties": {
"proposalresponse": {
"description": "For 1.4 SUT without gateway enabled, Indicates whether to verify the identity of the endorsers and their signatures for each proposal response after endorsing a transaction. Note, that this is a CPU intensive step, use it with caution",
"type": "boolean"
},
"readwritesets": {
"description": "For 1.4 SUT without gateway enabled, indicates whether to verify that the read-write sets returned by the endorsers match",
"type": "boolean"
}
},
"title": "Verify",
"type": "object"
}
},
"title": "Fabric",
"type": "object"
},
"flow": {
"additionalProperties": false,
"description": "Caliper flow options",
"properties": {
"only": {
"additionalProperties": false,
"description": "Only options",
"properties": {
"end": {
"description": "Indicates whether to skip the end command script in the network configuration file, if provided",
"type": "boolean"
},
"init": {
"description": "Indicates whether to skip the init phase of the benchmark",
"type": "boolean"
},
"install": {
"description": "Indicates whether to skip the smart contract install phase of the benchmark",
"type": "boolean"
},
"start": {
"description": "Indicates whether to skip the start command script in the network configuration file, if provided",
"type": "boolean"
},
"test": {
"description": "Indicates whether to skip the test phase of the benchmark",
"type": "boolean"
}
},
"title": "Only",
"type": "object"
},
"skip": {
"additionalProperties": false,
"properties": {
"end": {
"description": "Indicates whether to skip the end command script in the network configuration file, if provided",
"type": "boolean"
},
"init": {
"description": "Indicates whether to skip the init phase of the benchmark",
"type": "boolean"
},
"install": {
"description": "Indicates whether to skip the smart contract install phase of the benchmark",
"type": "boolean"
},
"start": {
"description": "Indicates whether to skip the start command script in the network configuration file, if provided",
"type": "boolean"
},
"test": {
"description": "Indicates whether to skip the test phase of the benchmark",
"type": "boolean"
}
},
"title": "Only",
"type": "object"
}
},
"title": "Flow",
"type": "object"
},
"logging": {
"additionalProperties": false,
"description": "Specifies the message structure through placeholders",
"properties": {
"formats": {
"additionalProperties": false,
"description": "The caliper.logging.formats hierarchy is special in a sense that every leaf property can be overridden one-by-one, even from the command line or from environment variables. As you will see later, this is not the case for the logging target settings. The logging subsystem relies on winston\u2019s format mechanism to further modify the log messages. The corresponding settings are under the caliper.logging.formats property",
"properties": {
"align": {
"description": "Prepends the message part of the log with a tabulator ('\t') to align the messages of different logs in the same place. For example: --caliper-logging-formats-align=true",
"type": "boolean"
},
"attributeformat": {
"additionalProperties": false,
"properties": {
"label": {
"description": "put [] around the label and space before it",
"type": "string"
},
"level": {
"description": "add a space before the level",
"type": "string"
},
"metadata": {
"description": "put () around the metadata and space before it",
"type": "string"
},
"module": {
"description": "put [] around the module name and space before/after it",
"type": "string"
}
},
"title": "Attributeformat",
"type": "object"
},
"colorize": {
"additionalProperties": false,
"description": "Applies color coding for the different attributes of a message. Enabling/disabling coloring is specified on an attribute basis. The following sub-properties can be set to true/false to enable/disable coloring for the corresponding attribute",
"properties": {
"colors": {
"additionalProperties": false,
"properties": {
"debug": {
"type": "string"
},
"error": {
"type": "string"
},
"info": {
"type": "string"
},
"warn": {
"type": "string"
}
},
"title": "Colors",
"type": "object"
},
"level": {
"description": "Apply it to levels",
"type": "boolean"
},
"message": {
"description": "Apply it to messages",
"type": "boolean"
}
},
"title": "Colorize",
"type": "object"
},
"json": {
"description": "Outputs the messages as JSON strings. Useful for file-based logs that will be processed automatically by another tool. The format accepts a space sub-property as an options, which corresponds to the space parameter of the JSON.stringify function. For example: --caliper-logging-formats-json='{space:0}'",
"type": "boolean"
},
"label": {
"description": "Adds a custom label to the message. This is useful for differentiating multiple Caliper instances (or the distributed client instances) after collecting their logs. For example: --caliper-logging-formats-label='caliper-test-1'",
"type": "string"
},
"pad": {
"description": "Makes every log level string the same length, i.e., adds an extra space after 'info' and 'warn' make them the same length as 'error' and 'debug'. For example: --caliper-logging-formats-pad=true",
"type": "boolean"
},
"timestamp": {
"description": "Adds the timestamp to the message in the specified format. The format string must conform to the rules of the fecha package. For example: --caliper-logging-formats-timestamp='YYYY.MM.DD-HH:mm:ss.SSS'",
"type": "string"
}
},
"title": "Formats",
"type": "object"
},
"targets": {
"additionalProperties": false,
"description": "The source and target(s) of log messages are decoupled, thanks to the transport mechanism of winston. This means that a log message can be easily logged to multiple places, like the console, or different log files. Moreover, this is completely transparent to the module generating the log message. The different targets are specified under the caliper.logging.targets property.",
"properties": {
"console": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "indicates whether the target is enabled. Defaults to true if omitted.",
"type": "boolean"
},
"options": {
"additionalProperties": false,
"description": "this object will be given as-is to the specific winston transport as options. See the table below for the supported options of each transport",
"properties": {
"level": {
"type": "string"
}
},
"required": [
"level"
],
"title": "Console Options",
"type": "object"
},
"target": {
"description": "the identifier of a supported target (console, file, daily rotate file)",
"type": "string"
}
},
"title": "Console",
"type": "object"
},
"file": {
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"options": {
"additionalProperties": false,
"properties": {
"filename": {
"type": "string"
},
"level": {
"type": "string"
},
"maxSize": {
"type": "string"
},
"options": {
"additionalProperties": false,
"properties": {
"flags": {
"type": "string"
},
"mode": {
"type": "integer"
}
},
"required": [
"flags",
"mode"
],
"title": "Options Options",
"type": "object"
},
"zippedArchive": {
"type": "boolean"
}
},
"title": "File Options",
"type": "object"
},
"target": {
"description": "",
"type": "string"
}
},
"title": "File",
"type": "object"
}
},
"title": "Targets",
"type": "object"
},
"template": {
"type": "string"
}
},
"title": "Logging",
"type": "object"
},
"machineconfig": {
"description": "machineconfig: If multiple users use the same workstation and want to share common settings across Caliper projects and users, then a machine-level configuration file can be included into the hierarchy by specifying its path through the caliper-machineconfig settings key using one of the higher priority locations above. More information: https://hyperledger.github.io/caliper/v0.5.0/runtime-config/#machine-level",
"title": "Machine Configuration",
"type": "null"
},
"monitor": {
"additionalProperties": false,
"description": "Each declared resource monitoring module is accompanied with options required to configure each of the named monitors. A common option for some modules is interval, which is used to configure the refresh interval at which point resource utilization is measured by the monitor. Heer, mention configurations related to caliper resource monitors",
"properties": {
"interval": {
"description": "Update interval",
"type": "integer"
}
},
"title": "Monitor",
"type": "object"
},
"networkconfig": {
"description": "Path to the network configuration file that contains information required to interact with the SUT",
"title": "Network Configuration",
"type": "null"
},
"observer": {
"additionalProperties": false,
"description": "Transaction monitors are used by Caliper workers to act on the completion of transactions. They are used internally to aggregate and dispatch transaction statistics to the manager process to enable transaction statistics aggregation for progress reporting via the default observer, and report generation. Here, configurations related to caliper transaction observers",
"properties": {
"internal": {
"additionalProperties": false,
"description": "Internal transaction observer",
"properties": {
"interval": {
"description": "The integer interval at which observers fetch information from their targets, in seconds, is specified as an integer under the label observer.interval; this is a required property for local and prometheus observers",
"type": "integer"
}
},
"title": "Observer Internal",
"type": "object"
},
"prometheus": {
"additionalProperties": false,
"description": "Prometheus transaction observer",
"properties": {
"scrapeport": {
"description": "Default scrape port for prometheus transaction observer",
"type": "integer"
}
},
"title": "Observer Prometheus",
"type": "object"
},
"prometheuspush": {
"additionalProperties": false,
"description": "Prometheus PushGateway transaction observer",
"properties": {
"interval": {
"description": "Update interval",
"type": "integer"
}
},
"title": "Observer Prometheus Push",
"type": "object"
}
},
"title": "Observer",
"type": "object"
},
"progress": {
"additionalProperties": false,
"description": "Configurations related to caliper test progress",
"properties": {
"reporting": {
"additionalProperties": false,
"properties": {
"enabled": {
"description": "Enable the reporting action",
"type": "boolean"
},
"interval": {
"description": "Reporting frequency",
"type": "integer"
}
},
"title": "Reporting",
"type": "object"
}
},
"title": "Progress",
"type": "object"
},
"projectconfig": {
"description": "projectconfig:If you have a group of settings that are always overridden in your Caliper benchmark project, then it is recommended to define them as a project-level configuration file. This file will usually consist of a subset of settings defined in the default configuration file (and probably your custom settings associated with your custom user module). More information: https://hyperledger.github.io/caliper/v0.5.0/runtime-config/#project-level",
"title": "Project Configuration",
"type": "null"
},
"report": {
"additionalProperties": false,
"description": "Report file-related options",
"properties": {
"charting": {
"additionalProperties": false,
"description": "Charting options",
"properties": {
"hue": {
"type": "integer"
},
"scheme": {
"type": "string"
},
"transparency": {
"type": "number"
}
},
"title": "Charting",
"type": "object"
},
"options": {
"additionalProperties": false,
"description": "The options to pass to fs.writeFile",
"properties": {
"flag": {
"description": "The mode in which file will be opened in",
"type": "string"
},
"mode": {
"description": "Access Permissions for file",
"type": "integer"
}
},
"title": "report Options",
"type": "object"
},
"path": {
"description": "The absolute or workspace-relative path of the report file.",
"type": "string"
},
"precision": {
"description": "Precision (significant figures) for the report output",
"type": "integer"
}
},
"title": "Report",
"type": "object"
},
"userconfig": {
"description": "userconfig: If you find yourself overriding the same settings for multiple Caliper benchmark projects, then it is recommended to extract the common settings into a user-level configuration file. More information: https://hyperledger.github.io/caliper/v0.5.0/runtime-config/#user-level",
"title": "User Configuration",
"type": "null"
},
"worker": {
"additionalProperties": false,
"description": "Indicate if workers are in distributed mode",
"properties": {
"communication": {
"additionalProperties": false,
"description": "Worker communication details",
"properties": {
"address": {
"description": "The address of the MQTT broker used for distributed worker management",
"type": "string"
},
"method": {
"description": "Indicates the type of the communication between the manager and workers",
"type": "string"
}
},
"title": "Communication",
"type": "object"
},
"remote": {
"description": "Indicates whether the workers operate in distributed mode",
"type": "boolean"
}
},
"title": "Worker",
"type": "object"
},
"workspace": {
"description": "Workspace directory that contains all configuration information",
"title": "Workspace",
"type": "string"
}
},
"title": "Caliper",
"type": "object"
}
},
"title": "Configuration Helper",
"type": "object"
}
}
} | Apache-2.0 | en |
favware/cliff-jumper | 765fe15f005d36e674b08dd0dd82b2fe74546c98 | 2022-04-17T21:39:59 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"bump": {
"default": false,
"description": "Whether the package should be bumped or not",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 6d86477335a39a13c7f074b7502b05067ebd47fc | 2022-04-26T21:22:57 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 933a6e5c4ec88e48e9de88aa995ea1a2d94c3d20 | 2022-04-21T21:35:06 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | e7104f28ca53dc82ddd186687c14d8d86f677d71 | 2023-11-19T15:51:38 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"identifierBase": {
"description": "The base number (0 or 1) to be used for the \"prerelease identifier\". Supply `false` to not use one.",
"type": [
"boolean",
"string"
]
},
"install": {
"default": false,
"description": "Whether to run npm install after bumping the version but before committing and creating a git tag. This is useful when you have a mono repo where bumping one package would then cause the lockfile to be out of date.",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"tagTemplate": {
"description": "A custom tag template to use.\n\nWhen \"org\" is provided this will default to \"@{{org}}/{{name}}@{{new-version}}\", for example \"@favware/[email protected]\"\nWhen \"org\" is not provided this will default to \"v{{new-version}}\", for example \"v1.0.0\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{org}}\" in your template, this will be replaced with the org provided through \"-o\", \"--org\" or the same value set in your config \nfile.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config \nfile.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 63b13d4e66f28e8fbd3fa493d5acbdac660d0e2b | 2023-06-09T10:16:42 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"install": {
"default": false,
"description": "Whether to run npm install after bumping the version but before committing and creating a git tag. This is useful when you have a mono repo where bumping one package would then cause the lockfile to be out of date.",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"tagTemplate": {
"description": "A custom tag template to use.\n\nWhen \"org\" is provided this will default to \"@{{org}}/{{name}}@{{new-version}}\", for example \"@favware/[email protected]\"\nWhen \"org\" is not provided this will default to \"v{{new-version}}\", for example \"v1.0.0\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{org}}\" in your template, this will be replaced with the org provided through \"-o\", \"--org\" or the same value set in your config \nfile.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config \nfile.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 37c919e4da511c28e9926745194016202c78c84a | 2023-09-22T08:08:41 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"identifierBase": {
"description": "The base number (0 or 1) to be used for the \"prerelease identifier\". Supply `false` to not use one.",
"type": [
"boolean",
"string"
]
},
"install": {
"default": false,
"description": "Whether to run npm install after bumping the version but before committing and creating a git tag. This is useful when you have a mono repo where bumping one package would then cause the lockfile to be out of date.",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"tagTemplate": {
"description": "A custom tag template to use.\n\nWhen \"org\" is provided this will default to \"@{{org}}/{{name}}@{{new-version}}\", for example \"@favware/[email protected]\"\nWhen \"org\" is not provided this will default to \"v{{new-version}}\", for example \"v1.0.0\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{org}}\" in your template, this will be replaced with the org provided through \"-o\", \"--org\" or the same value set in your config \nfile.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config \nfile.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 87b3ba02550aaa7181b974b14e70ebf6bc09031f | 2022-04-17T22:30:03 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 0ab906ae5cb25edf782e9744a5416e0af34d9745 | 2024-04-11T21:28:01 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"githubRepo": {
"description": "The GitHub repository to use for linking to issues and PRs in the changelog.\n\nYou can pass the unique string \"auto\" to automatically set this value as \"{{org}}/{{name}}\" as provided from \"--org\" and \"--name\". This should be in the format \"owner/repo\". You can use the \"GITHUB_REPO\" environment variable to automatically set this value",
"type": "string"
},
"githubToken": {
"description": "A token to authenticate requests to the GitHub API. This is required when using the \"--github-repo\" option.\nYou can also set the one of the following environment variables.\n- GITHUB_TOKEN\n- GH_TOKEN\n- TOKEN_GITHUB\n- TOKEN_GH",
"type": "string"
},
"identifierBase": {
"description": "The base number (0 or 1) to be used for the \"prerelease identifier\". Supply `false` to not use one.",
"type": [
"boolean",
"string"
]
},
"install": {
"default": false,
"description": "Whether to run npm install after bumping the version but before committing and creating a git tag. This is useful when you have a mono repo where bumping one package would then cause the lockfile to be out of date.",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"tagTemplate": {
"description": "A custom tag template to use.\n\nWhen \"org\" is provided this will default to \"@{{org}}/{{name}}@{{new-version}}\", for example \"@favware/[email protected]\"\nWhen \"org\" is not provided this will default to \"v{{new-version}}\", for example \"v1.0.0\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{org}}\" in your template, this will be replaced with the org provided through \"-o\", \"--org\" or the same value set in your config \nfile.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config \nfile.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 1e047b660303495812fcdecaeb26ec205856323b | 2022-05-07T14:19:50 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"taTgemplate": {
"description": "A custom tag template to use.\n\nWhen \"org\" is provided this will default to \"@{{org}}/{{name}}@{{new-version}}\", for example \"@favware/[email protected]\"\nWhen \"org\" is not provided this will default to \"v{{new-version}}\", for example \"v1.0.0\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{org}}\" in your template, this will be replaced with the org provided through \"-o\", \"--org\" or the same value set in your config \nfile.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config \nfile.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | 7ec4f9dde6135008bd8194cf33ef2df0e44b1055 | 2024-02-25T11:54:57 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"githubRepo": {
"description": "The GitHub repository to use for linking to issues and PRs in the changelog.\n\nYou can pass the unique string \"auto\" to automatically set this value as \"{{org}}/{{name}}\" as provided from \"--org\" and \"--name\". This should be in the format \"owner/repo\". You can use the \"GITHUB_REPO\" environment variable to automatically set this value",
"type": "string"
},
"githubToken": {
"description": "A token to authenticate requests to the GitHub API. This is required when using the \"--github-repo\" option. You can also set the \"GITHUB_TOKEN\" environment variable.",
"type": "string"
},
"identifierBase": {
"description": "The base number (0 or 1) to be used for the \"prerelease identifier\". Supply `false` to not use one.",
"type": [
"boolean",
"string"
]
},
"install": {
"default": false,
"description": "Whether to run npm install after bumping the version but before committing and creating a git tag. This is useful when you have a mono repo where bumping one package would then cause the lockfile to be out of date.",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"tagTemplate": {
"description": "A custom tag template to use.\n\nWhen \"org\" is provided this will default to \"@{{org}}/{{name}}@{{new-version}}\", for example \"@favware/[email protected]\"\nWhen \"org\" is not provided this will default to \"v{{new-version}}\", for example \"v1.0.0\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{org}}\" in your template, this will be replaced with the org provided through \"-o\", \"--org\" or the same value set in your config \nfile.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config \nfile.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | df316deeb67f9c64fd38fc8138f73dd9a28e55c7 | 2022-05-15T13:25:46 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"tagTemplate": {
"description": "A custom tag template to use.\n\nWhen \"org\" is provided this will default to \"@{{org}}/{{name}}@{{new-version}}\", for example \"@favware/[email protected]\"\nWhen \"org\" is not provided this will default to \"v{{new-version}}\", for example \"v1.0.0\"\n\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\n\nYou can use \"{{org}}\" in your template, this will be replaced with the org provided through \"-o\", \"--org\" or the same value set in your config \nfile.\n\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config \nfile.\n\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
favware/cliff-jumper | b21b772dd2196689c934b7a0f3af18a60d89af5b | 2022-04-28T19:41:53 | assets/cliff-jumper.schema.json | 35 | 2024-05-27T04:27:56.144629Z | {
"$schema": "http://json-schema.org/draft-04/schema#",
"properties": {
"commitMessageTemplate": {
"description": "A custom commit message template to use.\nDefaults to \"chore({{name}}): release {{full-name}}@{{new-version}}\"\nYou can use \"{{new-version}}\" in your template which will be dynamically replaced with whatever the new version is that will be published.\nYou can use \"{{name}}\" in your template, this will be replaced with the name provided through \"-n\", \"--name\" or the same value set in your config file.\nYou can use \"{{full-name}}\" in your template, this will be replaced \"{{name}}\" (when \"org\" is not provided), or \"@{{org}}/{{name}}\" (when \"org\" is provided).",
"type": "string"
},
"dryRun": {
"default": false,
"description": "Whether the package should be bumped or not. When this is set no actions will be taken and only the release strategy will be logged",
"type": "boolean"
},
"firstRelease": {
"default": false,
"description": "Whether this is the first release (skips bumping the version)",
"type": "boolean"
},
"monoRepo": {
"default": false,
"description": "Whether the package to be bumped resides in a mono repo,\nwhich enables Lerna-like scanning for what kind of version bump should be applied\nDefaults to \"true\" when \"org\" is set, false otherwise",
"type": "boolean"
},
"name": {
"description": "The package name to release",
"type": "string"
},
"org": {
"description": "The NPM org scope that should be used WITHOUT \"@\" sign or trailing \"/\"",
"type": "string"
},
"packagePath": {
"description": "The path to the current package. For non-monorepos this is just \".\"",
"type": "string"
},
"preid": {
"description": "The \"prerelease identifier\" to use as a prefix for the \"prerelease\" part of a semver",
"type": "string"
},
"skipChangelog": {
"default": false,
"description": "Whether to skip updating your CHANGELOG.md (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"skipTag": {
"default": false,
"description": "Whether to skip creating a git tag (default `true` when CI=true, `false` otherwise)",
"type": "boolean"
},
"verbose": {
"default": false,
"description": "Whether to print verbose information",
"type": "boolean"
}
},
"required": [
"name",
"packagePath"
],
"type": "object"
} | MIT | en |
dapr/components-contrib | f15a50581d679341b2368131d0e6b3b6299eff98 | 2022-09-27T17:44:54 | component-metadata-schema.json | 530 | 2024-05-29T15:16:27.006394Z | {
"$defs": {
"AuthenticationProfile": {
"additionalProperties": false,
"description": "AuthenticationProfile is the type for an authentication profile.",
"properties": {
"description": {
"description": "Additional description for the authentication profile, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"title": {
"description": "Title of the authentication profile.",
"type": "string"
}
},
"required": [
"title",
"description"
],
"type": "object"
},
"Binding": {
"additionalProperties": false,
"description": "Binding represents properties that are specific to bindings",
"properties": {
"input": {
"description": "If \"true\", the binding can be used as input binding.",
"type": "boolean"
},
"operations": {
"description": "List of operations that the output binding support.\nRequired in output bindings, and not allowed in input-only bindings.",
"items": {
"$ref": "#/$defs/BindingOperation"
},
"type": "array"
},
"output": {
"description": "If \"true\", the binding can be used as output binding.",
"type": "boolean"
}
},
"required": [
"operations"
],
"type": "object"
},
"BindingOperation": {
"additionalProperties": false,
"description": "BindingOperation represents an operation offered by an output binding.",
"properties": {
"description": {
"description": "Descrption of the operation.",
"type": "string"
},
"name": {
"description": "Name of the operation, such as \"create\", \"post\", \"delete\", etc.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
},
"Metadata": {
"additionalProperties": false,
"description": "Metadata property.",
"properties": {
"allowedValues": {
"description": "If set, forces the value to be one of those specified in this allowlist.",
"items": {
"type": "string"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/MetadataBinding",
"description": "If set, specifies that the property is only applicable to bindings of the type specified below.\nAt least one of \"input\" and \"output\" must be \"true\"."
},
"default": {
"description": "Default value for the property.\nIf it's a string, don't forget to add quotes.",
"type": "string"
},
"description": {
"description": "Description of the property.",
"type": "string"
},
"example": {
"description": "Example value.",
"type": "string"
},
"name": {
"description": "Name of the metadata property.",
"type": "string"
},
"required": {
"description": "If \"true\", the property is required",
"type": "boolean"
},
"sensitive": {
"description": "If \"true\", the property represents a sensitive value such as a password.",
"type": "boolean"
},
"type": {
"description": "Type of the property.\nIf this is empty, it's interpreted as \"string\".",
"enum": [
"string",
"number",
"bool",
"duration"
],
"type": "string"
}
},
"required": [
"name",
"description",
"example"
],
"type": "object"
},
"MetadataBinding": {
"additionalProperties": false,
"description": "MetadataBinding is the type for the \"binding\" property in the \"metadata\" object.",
"properties": {
"input": {
"description": "If \"true\", the property can be used with the binding as input binding only.",
"type": "boolean"
},
"output": {
"description": "If \"true\", the property can be used with the binding as output binding only.",
"type": "boolean"
}
},
"type": "object"
},
"URL": {
"additionalProperties": false,
"description": "URL represents one URL with additional resources.",
"properties": {
"title": {
"description": "Title of the URL.",
"type": "string"
},
"url": {
"description": "URL.",
"type": "string"
}
},
"required": [
"title",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/dapr/components-contrib/build-tools/pkg/metadataschema/component-metadata",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "ComponentMetadata is the schema for the metadata.yaml / metadata.json files.",
"properties": {
"authenticationProfiles": {
"description": "Authentication profiles for the component.",
"items": {
"$ref": "#/$defs/AuthenticationProfile"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/Binding",
"description": "Properties for bindings only.\nThis should not present unless \"type\" is \"bindings\"."
},
"capabilities": {
"description": "Component capabilities.\nFor state stores, the presence of \"actorStateStore\" implies that the metadata property \"actorStateStore\" can be set. In that case, do not manually specify \"actorStateStore\" as metadata option.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Additional description for the component, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options for the component.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the component (without the inital type, e.g. \"http\" instead of \"bindings.http\").",
"type": "string"
},
"schemaVersion": {
"description": "Version of the component metadata schema.",
"enum": [
"v1"
],
"type": "string"
},
"status": {
"description": "Component status.",
"enum": [
"stable",
"beta",
"alpha",
"development-only"
],
"type": "string"
},
"title": {
"description": "Title of the component, e.g. \"HTTP\".",
"type": "string"
},
"type": {
"description": "Component type, of one of the allowed values.",
"enum": [
"bindings",
"state",
"secretstores",
"pubsub",
"configuration",
"lock",
"middleware"
],
"type": "string"
},
"urls": {
"description": "URLs with additional resources for the component, such as docs.",
"items": {
"$ref": "#/$defs/URL"
},
"type": "array"
},
"version": {
"description": "Version of the component, with the leading \"v\", e.g. \"v1\".",
"type": "string"
}
},
"required": [
"schemaVersion",
"type",
"name",
"version",
"status",
"title",
"urls"
],
"title": "ComponentMetadata",
"type": "object"
} | Apache-2.0 | en |
dapr/components-contrib | 5dad8a867c62a6100a939093619b0d5bc620120e | 2023-04-12T00:04:34 | component-metadata-schema.json | 530 | 2024-05-29T15:16:27.006394Z | {
"$defs": {
"AuthenticationProfile": {
"additionalProperties": false,
"description": "AuthenticationProfile is the type for an authentication profile.",
"properties": {
"description": {
"description": "Additional description for the authentication profile, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"title": {
"description": "Title of the authentication profile.",
"type": "string"
}
},
"required": [
"title",
"description"
],
"type": "object"
},
"Binding": {
"additionalProperties": false,
"description": "Binding represents properties that are specific to bindings",
"properties": {
"input": {
"description": "If \"true\", the binding can be used as input binding.",
"type": "boolean"
},
"operations": {
"description": "List of operations that the output binding support.\nRequired in output bindings, and not allowed in input-only bindings.",
"items": {
"$ref": "#/$defs/BindingOperation"
},
"type": "array"
},
"output": {
"description": "If \"true\", the binding can be used as output binding.",
"type": "boolean"
}
},
"required": [
"operations"
],
"type": "object"
},
"BindingOperation": {
"additionalProperties": false,
"description": "BindingOperation represents an operation offered by an output binding.",
"properties": {
"description": {
"description": "Descrption of the operation.",
"type": "string"
},
"name": {
"description": "Name of the operation, such as \"create\", \"post\", \"delete\", etc.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
},
"BuiltinAuthenticationProfile": {
"additionalProperties": false,
"description": "BuiltinAuthenticationProfile is a reference to a built-in authentication profile.",
"properties": {
"metadata": {
"description": "Additional metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the built-in authentication profile.\nCurrently supports:\n\n- `azuread` (Azure AD, including Managed Identity).",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Metadata": {
"additionalProperties": false,
"description": "Metadata property.",
"properties": {
"allowedValues": {
"description": "If set, forces the value to be one of those specified in this allowlist.",
"items": {
"type": "string"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/MetadataBinding",
"description": "If set, specifies that the property is only applicable to bindings of the type specified below.\nAt least one of \"input\" and \"output\" must be \"true\"."
},
"default": {
"description": "Default value for the property.\nIf it's a string, don't forget to add quotes.",
"type": "string"
},
"description": {
"description": "Description of the property.",
"type": "string"
},
"example": {
"description": "Example value.",
"type": "string"
},
"name": {
"description": "Name of the metadata property.",
"type": "string"
},
"required": {
"description": "If \"true\", the property is required",
"type": "boolean"
},
"sensitive": {
"description": "If \"true\", the property represents a sensitive value such as a password.",
"type": "boolean"
},
"type": {
"description": "Type of the property.\nIf this is empty, it's interpreted as \"string\".",
"enum": [
"string",
"number",
"bool",
"duration"
],
"type": "string"
},
"url": {
"$ref": "#/$defs/URL",
"description": "URL with additional information, such as docs."
}
},
"required": [
"name",
"description",
"example"
],
"type": "object"
},
"MetadataBinding": {
"additionalProperties": false,
"description": "MetadataBinding is the type for the \"binding\" property in the \"metadata\" object.",
"properties": {
"input": {
"description": "If \"true\", the property can be used with the binding as input binding only.",
"type": "boolean"
},
"output": {
"description": "If \"true\", the property can be used with the binding as output binding only.",
"type": "boolean"
}
},
"type": "object"
},
"URL": {
"additionalProperties": false,
"description": "URL represents one URL with additional resources.",
"properties": {
"title": {
"description": "Title of the URL.",
"type": "string"
},
"url": {
"description": "URL.",
"type": "string"
}
},
"required": [
"title",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/dapr/components-contrib/build-tools/pkg/metadataschema/component-metadata",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "ComponentMetadata is the schema for the metadata.yaml / metadata.json files.",
"properties": {
"authenticationProfiles": {
"description": "Authentication profiles for the component.",
"items": {
"$ref": "#/$defs/AuthenticationProfile"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/Binding",
"description": "Properties for bindings only.\nThis should not present unless \"type\" is \"bindings\"."
},
"builtinAuthenticationProfiles": {
"description": "Built-in authentication profiles to import.",
"items": {
"$ref": "#/$defs/BuiltinAuthenticationProfile"
},
"type": "array"
},
"capabilities": {
"description": "Component capabilities.\nFor state stores, the presence of \"actorStateStore\" implies that the metadata property \"actorStateStore\" can be set. In that case, do not manually specify \"actorStateStore\" as metadata option.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Additional description for the component, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options for the component.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the component (without the inital type, e.g. \"http\" instead of \"bindings.http\").",
"type": "string"
},
"schemaVersion": {
"description": "Version of the component metadata schema.",
"enum": [
"v1"
],
"type": "string"
},
"status": {
"description": "Component status.",
"enum": [
"stable",
"beta",
"alpha",
"development-only"
],
"type": "string"
},
"title": {
"description": "Title of the component, e.g. \"HTTP\".",
"type": "string"
},
"type": {
"description": "Component type, of one of the allowed values.",
"enum": [
"bindings",
"state",
"secretstores",
"pubsub",
"workflows",
"configuration",
"lock",
"middleware"
],
"type": "string"
},
"urls": {
"description": "URLs with additional resources for the component, such as docs.",
"items": {
"$ref": "#/$defs/URL"
},
"type": "array"
},
"version": {
"description": "Version of the component, with the leading \"v\", e.g. \"v1\".",
"type": "string"
}
},
"required": [
"schemaVersion",
"type",
"name",
"version",
"status",
"title",
"urls"
],
"title": "ComponentMetadata",
"type": "object"
} | Apache-2.0 | en |
dapr/components-contrib | c035f0bcc4e8707b584f16d42b0c119489662448 | 2022-10-25T03:10:19 | component-metadata-schema.json | 530 | 2024-05-29T15:16:27.006394Z | {
"$defs": {
"AuthenticationProfile": {
"additionalProperties": false,
"description": "AuthenticationProfile is the type for an authentication profile.",
"properties": {
"description": {
"description": "Additional description for the authentication profile, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"title": {
"description": "Title of the authentication profile.",
"type": "string"
}
},
"required": [
"title",
"description"
],
"type": "object"
},
"Binding": {
"additionalProperties": false,
"description": "Binding represents properties that are specific to bindings",
"properties": {
"input": {
"description": "If \"true\", the binding can be used as input binding.",
"type": "boolean"
},
"operations": {
"description": "List of operations that the output binding support.\nRequired in output bindings, and not allowed in input-only bindings.",
"items": {
"$ref": "#/$defs/BindingOperation"
},
"type": "array"
},
"output": {
"description": "If \"true\", the binding can be used as output binding.",
"type": "boolean"
}
},
"required": [
"operations"
],
"type": "object"
},
"BindingOperation": {
"additionalProperties": false,
"description": "BindingOperation represents an operation offered by an output binding.",
"properties": {
"description": {
"description": "Descrption of the operation.",
"type": "string"
},
"name": {
"description": "Name of the operation, such as \"create\", \"post\", \"delete\", etc.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
},
"Metadata": {
"additionalProperties": false,
"description": "Metadata property.",
"properties": {
"allowedValues": {
"description": "If set, forces the value to be one of those specified in this allowlist.",
"items": {
"type": "string"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/MetadataBinding",
"description": "If set, specifies that the property is only applicable to bindings of the type specified below.\nAt least one of \"input\" and \"output\" must be \"true\"."
},
"default": {
"description": "Default value for the property.\nIf it's a string, don't forget to add quotes.",
"type": "string"
},
"description": {
"description": "Description of the property.",
"type": "string"
},
"example": {
"description": "Example value.",
"type": "string"
},
"name": {
"description": "Name of the metadata property.",
"type": "string"
},
"required": {
"description": "If \"true\", the property is required",
"type": "boolean"
},
"sensitive": {
"description": "If \"true\", the property represents a sensitive value such as a password.",
"type": "boolean"
},
"type": {
"description": "Type of the property.\nIf this is empty, it's interpreted as \"string\".",
"enum": [
"string",
"number",
"bool",
"duration"
],
"type": "string"
}
},
"required": [
"name",
"description",
"example"
],
"type": "object"
},
"MetadataBinding": {
"additionalProperties": false,
"description": "MetadataBinding is the type for the \"binding\" property in the \"metadata\" object.",
"properties": {
"input": {
"description": "If \"true\", the property can be used with the binding as input binding only.",
"type": "boolean"
},
"output": {
"description": "If \"true\", the property can be used with the binding as output binding only.",
"type": "boolean"
}
},
"type": "object"
},
"URL": {
"additionalProperties": false,
"description": "URL represents one URL with additional resources.",
"properties": {
"title": {
"description": "Title of the URL.",
"type": "string"
},
"url": {
"description": "URL.",
"type": "string"
}
},
"required": [
"title",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/dapr/components-contrib/build-tools/pkg/metadataschema/component-metadata",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "ComponentMetadata is the schema for the metadata.yaml / metadata.json files.",
"properties": {
"authenticationProfiles": {
"description": "Authentication profiles for the component.",
"items": {
"$ref": "#/$defs/AuthenticationProfile"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/Binding",
"description": "Properties for bindings only.\nThis should not present unless \"type\" is \"bindings\"."
},
"capabilities": {
"description": "Component capabilities.\nFor state stores, the presence of \"actorStateStore\" implies that the metadata property \"actorStateStore\" can be set. In that case, do not manually specify \"actorStateStore\" as metadata option.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Additional description for the component, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options for the component.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the component (without the inital type, e.g. \"http\" instead of \"bindings.http\").",
"type": "string"
},
"schemaVersion": {
"description": "Version of the component metadata schema.",
"enum": [
"v1"
],
"type": "string"
},
"status": {
"description": "Component status.",
"enum": [
"stable",
"beta",
"alpha",
"development-only"
],
"type": "string"
},
"title": {
"description": "Title of the component, e.g. \"HTTP\".",
"type": "string"
},
"type": {
"description": "Component type, of one of the allowed values.",
"enum": [
"bindings",
"state",
"secretstores",
"pubsub",
"workflows",
"configuration",
"lock",
"middleware"
],
"type": "string"
},
"urls": {
"description": "URLs with additional resources for the component, such as docs.",
"items": {
"$ref": "#/$defs/URL"
},
"type": "array"
},
"version": {
"description": "Version of the component, with the leading \"v\", e.g. \"v1\".",
"type": "string"
}
},
"required": [
"schemaVersion",
"type",
"name",
"version",
"status",
"title",
"urls"
],
"title": "ComponentMetadata",
"type": "object"
} | Apache-2.0 | en |
dapr/components-contrib | 54c176610f2d7cf55628d38982bd565a0ecea2e5 | 2023-04-19T01:22:31 | component-metadata-schema.json | 530 | 2024-05-29T15:16:27.006394Z | {
"$defs": {
"AuthenticationProfile": {
"additionalProperties": false,
"description": "AuthenticationProfile is the type for an authentication profile.",
"properties": {
"description": {
"description": "Additional description for the authentication profile, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"title": {
"description": "Title of the authentication profile.",
"type": "string"
}
},
"required": [
"title",
"description"
],
"type": "object"
},
"Binding": {
"additionalProperties": false,
"description": "Binding represents properties that are specific to bindings",
"properties": {
"input": {
"description": "If \"true\", the binding can be used as input binding.",
"type": "boolean"
},
"operations": {
"description": "List of operations that the output binding support.\nRequired in output bindings, and not allowed in input-only bindings.",
"items": {
"$ref": "#/$defs/BindingOperation"
},
"type": "array"
},
"output": {
"description": "If \"true\", the binding can be used as output binding.",
"type": "boolean"
}
},
"required": [
"operations"
],
"type": "object"
},
"BindingOperation": {
"additionalProperties": false,
"description": "BindingOperation represents an operation offered by an output binding.",
"properties": {
"description": {
"description": "Descrption of the operation.",
"type": "string"
},
"name": {
"description": "Name of the operation, such as \"create\", \"post\", \"delete\", etc.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
},
"BuiltinAuthenticationProfile": {
"additionalProperties": false,
"description": "BuiltinAuthenticationProfile is a reference to a built-in authentication profile.",
"properties": {
"metadata": {
"description": "Additional metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the built-in authentication profile.\nCurrently supports:\n\n- `azuread` (Azure AD, including Managed Identity).",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Metadata": {
"additionalProperties": false,
"description": "Metadata property.",
"properties": {
"allowedValues": {
"description": "If set, forces the value to be one of those specified in this allowlist.",
"items": {
"type": "string"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/MetadataBinding",
"description": "If set, specifies that the property is only applicable to bindings of the type specified below.\nAt least one of \"input\" and \"output\" must be \"true\"."
},
"default": {
"description": "Default value for the property.\nIf it's a string, don't forget to add quotes.",
"type": "string"
},
"deprecated": {
"description": "If set, specifies that the property is deprecated and should not be used in new configurations.",
"type": "boolean"
},
"description": {
"description": "Description of the property.",
"type": "string"
},
"example": {
"description": "Example value.",
"type": "string"
},
"name": {
"description": "Name of the metadata property.",
"type": "string"
},
"required": {
"description": "If \"true\", the property is required",
"type": "boolean"
},
"sensitive": {
"description": "If \"true\", the property represents a sensitive value such as a password.",
"type": "boolean"
},
"type": {
"description": "Type of the property.\nIf this is empty, it's interpreted as \"string\".",
"enum": [
"string",
"number",
"bool",
"duration"
],
"type": "string"
},
"url": {
"$ref": "#/$defs/URL",
"description": "URL with additional information, such as docs."
}
},
"required": [
"name",
"description",
"example"
],
"type": "object"
},
"MetadataBinding": {
"additionalProperties": false,
"description": "MetadataBinding is the type for the \"binding\" property in the \"metadata\" object.",
"properties": {
"input": {
"description": "If \"true\", the property can be used with the binding as input binding only.",
"type": "boolean"
},
"output": {
"description": "If \"true\", the property can be used with the binding as output binding only.",
"type": "boolean"
}
},
"type": "object"
},
"URL": {
"additionalProperties": false,
"description": "URL represents one URL with additional resources.",
"properties": {
"title": {
"description": "Title of the URL.",
"type": "string"
},
"url": {
"description": "URL.",
"type": "string"
}
},
"required": [
"title",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/dapr/components-contrib/build-tools/pkg/metadataschema/component-metadata",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "ComponentMetadata is the schema for the metadata.yaml / metadata.json files.",
"properties": {
"authenticationProfiles": {
"description": "Authentication profiles for the component.",
"items": {
"$ref": "#/$defs/AuthenticationProfile"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/Binding",
"description": "Properties for bindings only.\nThis should not present unless \"type\" is \"bindings\"."
},
"builtinAuthenticationProfiles": {
"description": "Built-in authentication profiles to import.",
"items": {
"$ref": "#/$defs/BuiltinAuthenticationProfile"
},
"type": "array"
},
"capabilities": {
"description": "Component capabilities.\nFor state stores, the presence of \"actorStateStore\" implies that the metadata property \"actorStateStore\" can be set. In that case, do not manually specify \"actorStateStore\" as metadata option.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Additional description for the component, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options for the component.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the component (without the inital type, e.g. \"http\" instead of \"bindings.http\").",
"type": "string"
},
"schemaVersion": {
"description": "Version of the component metadata schema.",
"enum": [
"v1"
],
"type": "string"
},
"status": {
"description": "Component status.",
"enum": [
"stable",
"beta",
"alpha",
"development-only"
],
"type": "string"
},
"title": {
"description": "Title of the component, e.g. \"HTTP\".",
"type": "string"
},
"type": {
"description": "Component type, of one of the allowed values.",
"enum": [
"bindings",
"state",
"secretstores",
"pubsub",
"workflows",
"configuration",
"lock",
"middleware"
],
"type": "string"
},
"urls": {
"description": "URLs with additional resources for the component, such as docs.",
"items": {
"$ref": "#/$defs/URL"
},
"type": "array"
},
"version": {
"description": "Version of the component, with the leading \"v\", e.g. \"v1\".",
"type": "string"
}
},
"required": [
"schemaVersion",
"type",
"name",
"version",
"status",
"title",
"urls"
],
"title": "ComponentMetadata",
"type": "object"
} | Apache-2.0 | en |
dapr/components-contrib | da50003dd4328e7f4e697f8aff888305ec78d545 | 2023-08-15T04:06:30 | component-metadata-schema.json | 530 | 2024-05-29T15:16:27.006394Z | {
"$defs": {
"AuthenticationProfile": {
"additionalProperties": false,
"description": "AuthenticationProfile is the type for an authentication profile.",
"properties": {
"description": {
"description": "Additional description for the authentication profile, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"title": {
"description": "Title of the authentication profile.",
"type": "string"
}
},
"required": [
"title",
"description"
],
"type": "object"
},
"Binding": {
"additionalProperties": false,
"description": "Binding represents properties that are specific to bindings",
"properties": {
"input": {
"description": "If \"true\", the binding can be used as input binding.",
"type": "boolean"
},
"operations": {
"description": "List of operations that the output binding support.\nRequired in output bindings, and not allowed in input-only bindings.",
"items": {
"$ref": "#/$defs/BindingOperation"
},
"type": "array"
},
"output": {
"description": "If \"true\", the binding can be used as output binding.",
"type": "boolean"
}
},
"required": [
"operations"
],
"type": "object"
},
"BindingOperation": {
"additionalProperties": false,
"description": "BindingOperation represents an operation offered by an output binding.",
"properties": {
"description": {
"description": "Descrption of the operation.",
"type": "string"
},
"name": {
"description": "Name of the operation, such as \"create\", \"post\", \"delete\", etc.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
},
"BuiltinAuthenticationProfile": {
"additionalProperties": false,
"description": "BuiltinAuthenticationProfile is a reference to a built-in authentication profile.",
"properties": {
"metadata": {
"description": "Additional metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the built-in authentication profile.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Metadata": {
"additionalProperties": false,
"description": "Metadata property.",
"properties": {
"allowedValues": {
"description": "If set, forces the value to be one of those specified in this allowlist.",
"items": {
"type": "string"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/MetadataBinding",
"description": "If set, specifies that the property is only applicable to bindings of the type specified below.\nAt least one of \"input\" and \"output\" must be \"true\"."
},
"default": {
"description": "Default value for the property.\nIf it's a string, don't forget to add quotes.",
"type": "string"
},
"deprecated": {
"description": "If set, specifies that the property is deprecated and should not be used in new configurations.",
"type": "boolean"
},
"description": {
"description": "Description of the property.",
"type": "string"
},
"example": {
"description": "Example value.",
"type": "string"
},
"name": {
"description": "Name of the metadata property.",
"type": "string"
},
"required": {
"description": "If \"true\", the property is required",
"type": "boolean"
},
"sensitive": {
"description": "If \"true\", the property represents a sensitive value such as a password.",
"type": "boolean"
},
"type": {
"description": "Type of the property.\nIf this is empty, it's interpreted as \"string\".",
"enum": [
"string",
"number",
"bool",
"duration",
"bytesize"
],
"type": "string"
},
"url": {
"$ref": "#/$defs/URL",
"description": "URL with additional information, such as docs."
}
},
"required": [
"name",
"description",
"example"
],
"type": "object"
},
"MetadataBinding": {
"additionalProperties": false,
"description": "MetadataBinding is the type for the \"binding\" property in the \"metadata\" object.",
"properties": {
"input": {
"description": "If \"true\", the property can be used with the binding as input binding only.",
"type": "boolean"
},
"output": {
"description": "If \"true\", the property can be used with the binding as output binding only.",
"type": "boolean"
}
},
"type": "object"
},
"URL": {
"additionalProperties": false,
"description": "URL represents one URL with additional resources.",
"properties": {
"title": {
"description": "Title of the URL.",
"type": "string"
},
"url": {
"description": "URL.",
"type": "string"
}
},
"required": [
"title",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/dapr/components-contrib/build-tools/pkg/metadataschema/component-metadata",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "ComponentMetadata is the schema for the metadata.yaml / metadata.json files.",
"properties": {
"authenticationProfiles": {
"description": "Authentication profiles for the component.",
"items": {
"$ref": "#/$defs/AuthenticationProfile"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/Binding",
"description": "Properties for bindings only.\nThis should not present unless \"type\" is \"bindings\"."
},
"builtinAuthenticationProfiles": {
"description": "Built-in authentication profiles to import.",
"items": {
"$ref": "#/$defs/BuiltinAuthenticationProfile"
},
"type": "array"
},
"capabilities": {
"description": "Component capabilities.\nFor state stores, the presence of \"actorStateStore\" implies that the metadata property \"actorStateStore\" can be set. In that case, do not manually specify \"actorStateStore\" as metadata option.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Additional description for the component, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options for the component.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the component (without the inital type, e.g. \"http\" instead of \"bindings.http\").",
"type": "string"
},
"schemaVersion": {
"description": "Version of the component metadata schema.",
"enum": [
"v1"
],
"type": "string"
},
"status": {
"description": "Component status.",
"enum": [
"stable",
"beta",
"alpha",
"development-only"
],
"type": "string"
},
"title": {
"description": "Title of the component, e.g. \"HTTP\".",
"type": "string"
},
"type": {
"description": "Component type, of one of the allowed values.",
"enum": [
"bindings",
"state",
"secretstores",
"pubsub",
"workflows",
"configuration",
"lock",
"middleware",
"crypto"
],
"type": "string"
},
"urls": {
"description": "URLs with additional resources for the component, such as docs.",
"items": {
"$ref": "#/$defs/URL"
},
"type": "array"
},
"version": {
"description": "Version of the component, with the leading \"v\", e.g. \"v1\".",
"type": "string"
}
},
"required": [
"schemaVersion",
"type",
"name",
"version",
"status",
"title",
"urls"
],
"title": "ComponentMetadata",
"type": "object"
} | Apache-2.0 | en |
dapr/components-contrib | ec05809ee63d5e7b1b695c47e91e2d860b52b86d | 2023-07-17T22:17:22 | component-metadata-schema.json | 530 | 2024-05-29T15:16:27.006394Z | {
"$defs": {
"AuthenticationProfile": {
"additionalProperties": false,
"description": "AuthenticationProfile is the type for an authentication profile.",
"properties": {
"description": {
"description": "Additional description for the authentication profile, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"title": {
"description": "Title of the authentication profile.",
"type": "string"
}
},
"required": [
"title",
"description"
],
"type": "object"
},
"Binding": {
"additionalProperties": false,
"description": "Binding represents properties that are specific to bindings",
"properties": {
"input": {
"description": "If \"true\", the binding can be used as input binding.",
"type": "boolean"
},
"operations": {
"description": "List of operations that the output binding support.\nRequired in output bindings, and not allowed in input-only bindings.",
"items": {
"$ref": "#/$defs/BindingOperation"
},
"type": "array"
},
"output": {
"description": "If \"true\", the binding can be used as output binding.",
"type": "boolean"
}
},
"required": [
"operations"
],
"type": "object"
},
"BindingOperation": {
"additionalProperties": false,
"description": "BindingOperation represents an operation offered by an output binding.",
"properties": {
"description": {
"description": "Descrption of the operation.",
"type": "string"
},
"name": {
"description": "Name of the operation, such as \"create\", \"post\", \"delete\", etc.",
"type": "string"
}
},
"required": [
"name",
"description"
],
"type": "object"
},
"BuiltinAuthenticationProfile": {
"additionalProperties": false,
"description": "BuiltinAuthenticationProfile is a reference to a built-in authentication profile.",
"properties": {
"metadata": {
"description": "Additional metadata options applicable when using this authentication profile.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the built-in authentication profile.",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Metadata": {
"additionalProperties": false,
"description": "Metadata property.",
"properties": {
"allowedValues": {
"description": "If set, forces the value to be one of those specified in this allowlist.",
"items": {
"type": "string"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/MetadataBinding",
"description": "If set, specifies that the property is only applicable to bindings of the type specified below.\nAt least one of \"input\" and \"output\" must be \"true\"."
},
"default": {
"description": "Default value for the property.\nIf it's a string, don't forget to add quotes.",
"type": "string"
},
"deprecated": {
"description": "If set, specifies that the property is deprecated and should not be used in new configurations.",
"type": "boolean"
},
"description": {
"description": "Description of the property.",
"type": "string"
},
"example": {
"description": "Example value.",
"type": "string"
},
"name": {
"description": "Name of the metadata property.",
"type": "string"
},
"required": {
"description": "If \"true\", the property is required",
"type": "boolean"
},
"sensitive": {
"description": "If \"true\", the property represents a sensitive value such as a password.",
"type": "boolean"
},
"type": {
"description": "Type of the property.\nIf this is empty, it's interpreted as \"string\".",
"enum": [
"string",
"number",
"bool",
"duration"
],
"type": "string"
},
"url": {
"$ref": "#/$defs/URL",
"description": "URL with additional information, such as docs."
}
},
"required": [
"name",
"description",
"example"
],
"type": "object"
},
"MetadataBinding": {
"additionalProperties": false,
"description": "MetadataBinding is the type for the \"binding\" property in the \"metadata\" object.",
"properties": {
"input": {
"description": "If \"true\", the property can be used with the binding as input binding only.",
"type": "boolean"
},
"output": {
"description": "If \"true\", the property can be used with the binding as output binding only.",
"type": "boolean"
}
},
"type": "object"
},
"URL": {
"additionalProperties": false,
"description": "URL represents one URL with additional resources.",
"properties": {
"title": {
"description": "Title of the URL.",
"type": "string"
},
"url": {
"description": "URL.",
"type": "string"
}
},
"required": [
"title",
"url"
],
"type": "object"
}
},
"$id": "https://github.com/dapr/components-contrib/build-tools/pkg/metadataschema/component-metadata",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"description": "ComponentMetadata is the schema for the metadata.yaml / metadata.json files.",
"properties": {
"authenticationProfiles": {
"description": "Authentication profiles for the component.",
"items": {
"$ref": "#/$defs/AuthenticationProfile"
},
"type": "array"
},
"binding": {
"$ref": "#/$defs/Binding",
"description": "Properties for bindings only.\nThis should not present unless \"type\" is \"bindings\"."
},
"builtinAuthenticationProfiles": {
"description": "Built-in authentication profiles to import.",
"items": {
"$ref": "#/$defs/BuiltinAuthenticationProfile"
},
"type": "array"
},
"capabilities": {
"description": "Component capabilities.\nFor state stores, the presence of \"actorStateStore\" implies that the metadata property \"actorStateStore\" can be set. In that case, do not manually specify \"actorStateStore\" as metadata option.",
"items": {
"type": "string"
},
"type": "array"
},
"description": {
"description": "Additional description for the component, optional.",
"type": "string"
},
"metadata": {
"description": "Metadata options for the component.",
"items": {
"$ref": "#/$defs/Metadata"
},
"type": "array"
},
"name": {
"description": "Name of the component (without the inital type, e.g. \"http\" instead of \"bindings.http\").",
"type": "string"
},
"schemaVersion": {
"description": "Version of the component metadata schema.",
"enum": [
"v1"
],
"type": "string"
},
"status": {
"description": "Component status.",
"enum": [
"stable",
"beta",
"alpha",
"development-only"
],
"type": "string"
},
"title": {
"description": "Title of the component, e.g. \"HTTP\".",
"type": "string"
},
"type": {
"description": "Component type, of one of the allowed values.",
"enum": [
"bindings",
"state",
"secretstores",
"pubsub",
"workflows",
"configuration",
"lock",
"middleware"
],
"type": "string"
},
"urls": {
"description": "URLs with additional resources for the component, such as docs.",
"items": {
"$ref": "#/$defs/URL"
},
"type": "array"
},
"version": {
"description": "Version of the component, with the leading \"v\", e.g. \"v1\".",
"type": "string"
}
},
"required": [
"schemaVersion",
"type",
"name",
"version",
"status",
"title",
"urls"
],
"title": "ComponentMetadata",
"type": "object"
} | Apache-2.0 | en |
ecsdeployer/ecsdeployer | 35a08fd6cbcc9e4e5ea0fc69fb34809c9e45d099 | 2023-04-09T22:39:30 | www/docs/static/schema.json | 7 | 2024-05-27T06:55:04.899506Z | {
"$defs": {
"Architecture": {
"default": "amd64",
"description": "Specify CPU Architecture",
"enum": [
"amd64",
"arm64",
"x86_64"
],
"type": "string"
},
"AwsLogConfig": {
"oneOf": [
{
"description": "Enable or disable logging to AWS using default values",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"retention": {
"$ref": "#/$defs/LogRetention"
}
},
"type": "object"
}
]
},
"CPUShares": {
"description": "Specify CPU Resources",
"oneOf": [
{
"description": "CPU Shares",
"minimum": 0,
"type": "integer"
},
{
"description": "CPU Shares or vCPUs",
"type": "string"
}
]
},
"ClusterRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"ConsoleTask": {
"oneOf": [
{
"description": "Enable or disable remote shell",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"enabled": {
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"path": {
"type": "string"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"type": "object"
}
]
},
"CronJob": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"bus": {
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"end_date": {
"format": "date-time",
"type": "string"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"schedule": {
"examples": [
"cron(0 9 * * ? *)",
"rate(1 hour)",
"rate(2 hours)"
],
"minLength": 5,
"type": "string"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"start_date": {
"format": "date-time",
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timezone": {
"type": "string"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"schedule",
"name"
],
"type": "object"
},
"CustomLogConfig": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
}
},
"type": "object"
},
"DependsOn": {
"oneOf": [
{
"properties": {
"condition": {
"default": "START",
"enum": [
"START",
"COMPLETE",
"SUCCESS",
"HEALTHY"
],
"type": "string"
},
"name": {
"minLength": 1,
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]+$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
{
"description": "'container:CONDITION' format",
"pattern": "^[-_a-zA-Z0-9]+(:[a-zA-Z]+)?$",
"type": "string"
}
]
},
"Duration": {
"oneOf": [
{
"description": "Seconds",
"minimum": 0,
"type": "integer"
},
{
"description": "Duration specified in shorthand",
"examples": [
"5m",
"4m2s",
"2h",
"2h10m5s"
],
"pattern": "^[+]?([0-9]*(\\.[0-9]*)?[a-z]+)+$",
"type": "string"
}
]
},
"EcsDeployerOptions": {
"additionalProperties": false,
"properties": {
"allowed_account_id": {
"description": "Restrict to a specific AWS account ID.",
"oneOf": [
{
"pattern": "^[0-9]{12}$",
"type": "string"
},
{
"type": "integer"
}
]
},
"required_version": {
"$comment": "https://semver.org",
"description": "Specify a constraint on a semantic version",
"type": "string"
}
},
"type": "object"
},
"EnvVar": {
"oneOf": [
{
"$comment": "Pull a secret from an SSM Parameter",
"additionalProperties": false,
"properties": {
"ssm": {
"minLength": 1,
"type": "string"
}
},
"required": [
"ssm"
],
"type": "object"
},
{
"$comment": "Construct value using a template",
"additionalProperties": false,
"properties": {
"template": {
"minLength": 1,
"type": "string"
}
},
"required": [
"template"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"additionalProperties": false,
"properties": {
"value": {
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"value"
],
"type": "object"
},
{
"$comment": "Unsets any value that was defined previously",
"additionalProperties": false,
"properties": {
"unset": {
"const": true,
"type": "boolean"
}
},
"required": [
"unset"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
}
]
},
"EnvVarMap": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][^=]*$": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"FirelensAwsLogGroup": {
"description": "Should logs for firelens be sent to a log group",
"oneOf": [
{
"const": false,
"description": "Do not log to AWSLogs",
"type": "boolean"
},
{
"description": "Send logs to this log group",
"minLength": 2,
"type": "string"
}
]
},
"FirelensConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"container_name": {
"default": "log_router",
"type": "string"
},
"credentials": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"inherit_env": {
"type": "boolean"
},
"log_to_awslogs": {
"$ref": "#/$defs/FirelensAwsLogGroup"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"router_options": {
"$ref": "#/$defs/EnvVarMap"
},
"type": {
"default": "fluentbit",
"enum": [
"fluentbit",
"fluentd"
],
"type": "string"
}
},
"type": "object"
}
]
},
"HealthCheck": {
"oneOf": [
{
"const": false,
"description": "Disable a healthcheck for a specific task",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"command": {
"$ref": "#/$defs/ShellCommand"
},
"disabled": {
"type": "boolean"
},
"interval": {
"$ref": "#/$defs/Duration"
},
"retries": {
"minimum": 1,
"type": "integer"
},
"start_period": {
"$ref": "#/$defs/Duration"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"type": "object"
}
]
},
"ImageUri": {
"oneOf": [
{
"additionalProperties": false,
"oneOf": [
{
"required": [
"ecr",
"tag"
]
},
{
"required": [
"ecr",
"digest"
]
},
{
"required": [
"docker",
"tag"
]
},
{
"required": [
"docker",
"digest"
]
}
],
"properties": {
"digest": {
"title": "Image digest",
"type": "string"
},
"docker": {
"title": "Dockerhub Repo URI",
"type": "string"
},
"ecr": {
"title": "Just the ECR Repository name",
"type": "string"
},
"tag": {
"title": "Image tag",
"type": "string"
}
},
"type": "object"
},
{
"examples": [
"myorg/myapp:latest",
"myorg/myapp@sha256:deadbeefdeadbeefdeadbeefdeadbeef",
"myorg/myapp:{{ .ImageTag }}"
],
"minLength": 2,
"title": "The full URI to your image",
"type": "string"
}
]
},
"KeepInSync": {
"oneOf": [
{
"description": "Set all fields on or off",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"cronjobs": {
"default": true,
"description": "Deletes cronjobs no longer referenced in stage file",
"type": "boolean"
},
"log_retention": {
"default": true,
"description": "Ensures that log groups have the correct retention period set",
"type": "boolean"
},
"services": {
"default": true,
"description": "Deletes services no longer referenced in stage file",
"type": "boolean"
},
"task_definitions": {
"default": true,
"description": "Deregisters old task definitions",
"type": "boolean"
}
},
"type": "object"
}
]
},
"LoadBalancer": {
"additionalProperties": false,
"properties": {
"grace": {
"$ref": "#/$defs/Duration"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"target_group": {
"$ref": "#/$defs/TargetGroupRef"
}
},
"required": [
"port",
"target_group"
],
"type": "object"
},
"LoadBalancers": {
"oneOf": [
{
"$ref": "#/$defs/LoadBalancer",
"description": "Default variant, just define a single load balancer mapping"
},
{
"description": "Define multiple load balancer mappings.",
"items": {
"$ref": "#/$defs/LoadBalancer"
},
"type": "array"
}
]
},
"LogRetention": {
"description": "How long to retain logs in CloudWatch logs",
"oneOf": [
{
"const": "forever",
"description": "Retain logs forever",
"type": "string"
},
{
"description": "The number of days to retain logs",
"pattern": "^[1-9][0-9]*$",
"type": "string"
},
{
"description": "The number of days to retain logs",
"minimum": 1,
"type": "integer"
}
]
},
"LoggingConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"awslogs": {
"$ref": "#/$defs/AwsLogConfig"
},
"custom": {
"$ref": "#/$defs/CustomLogConfig"
},
"disabled": {
"type": "boolean"
},
"firelens": {
"$ref": "#/$defs/FirelensConfig"
}
},
"type": "object"
}
]
},
"Memory": {
"oneOf": [
{
"description": "Absolute or multiple of CPU",
"examples": [
"2048",
"2x",
"2 GB",
"0.5gb",
"x2"
],
"type": "string"
},
{
"description": "Absolute value in Megabytes",
"type": "integer"
}
],
"title": "Memory requirements"
},
"Mount": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"readonly": {
"type": "boolean"
},
"source": {
"type": "string"
}
},
"required": [
"path",
"source"
],
"type": "object"
},
"NameTemplates": {
"additionalProperties": false,
"properties": {
"cron_group": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:cron:{{ .Name }}",
"type": "string"
},
"cron_rule": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-rule-{{ .Name }}",
"deprecated": true,
"minLength": 1,
"type": "string"
},
"cron_target": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"deprecated": true,
"minLength": 1,
"type": "string"
},
"log_group": {
"default": "/ecsdeployer/app/{{ .Project }}/{{ if .Stage }}{{ .Stage }}/{{end}}{{ .Name }}",
"minLength": 1,
"type": "string"
},
"log_stream_prefix": {
"default": "{{ .Container }}",
"minLength": 1,
"type": "string"
},
"marker_tag_key": {
"default": "ecsdeployer/project",
"minLength": 1,
"type": "string"
},
"marker_tag_value": {
"default": "{{ .Project }}{{ if .Stage }}/{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"predeploy_group": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:pd:{{ .Name }}",
"type": "string"
},
"predeploy_started_by": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:deployer",
"type": "string"
},
"schedule": {
"default": "ecsd-cron-{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"schedule_group": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"service_name": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"target_group": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"task_family": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"NameValuePair": {
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"description": "Any value that can be cast to a string of at least one character long",
"oneOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": [
"number",
"boolean"
]
}
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"public_ip": {
"default": false,
"description": "Should the task be given a Public IP address?",
"type": "boolean"
},
"security_groups": {
"description": "List of SecurityGroupIds or SecurityGroup Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
},
"subnets": {
"description": "List of SubnetIds or Subnet Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
}
},
"type": "object"
},
"NetworkFilter": {
"oneOf": [
{
"description": "Explicit ID",
"examples": [
"subnet-12345abcd",
"sg-12345abcd"
],
"pattern": "^[a-z]+-[a-f0-9]{3,}$",
"type": "string"
},
{
"description": "Filter shorthand",
"examples": [
"status=available",
"tag:key=value"
],
"pattern": "^([^=]+)=(([^,]+),?)+$",
"type": "string"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"values": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"values"
],
"type": "object"
}
]
},
"PortMapping": {
"description": "Port specifications",
"oneOf": [
{
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"default": "tcp",
"enum": [
"tcp",
"udp"
],
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
{
"description": "Docker style port mapping",
"pattern": "^[0-9]+(/(tcp|udp))?$",
"type": "string"
},
{
"description": "Simple TCP Port",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
]
},
"PreDeployTask": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"disabled": {
"default": false,
"description": "Do not run this task",
"type": "boolean"
},
"do_not_wait": {
"default": false,
"description": "Do not wait for this task to finish",
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"ignore_failure": {
"default": false,
"description": "Ignore runtime failures of this task",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timeout": {
"$ref": "#/$defs/Duration",
"description": "Abort task after specified time has elapsed"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ProxyConfig": {
"oneOf": [
{
"const": false,
"description": "Disable proxy configuration for a specific task",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"container": {
"default": "envoy",
"description": "Name of the sidecar that provides the proxy",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"properties": {
"$ref": "#/$defs/EnvVarMap"
},
"type": {
"default": "APPMESH",
"description": "Proxy type. You should omit this unless you know what you are doing.",
"examples": [
"APPMESH"
],
"type": "string"
}
},
"type": "object"
}
]
},
"RoleRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"RolloutConfig": {
"additionalProperties": false,
"properties": {
"max": {
"minimum": 0,
"type": "integer"
},
"min": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"SSMImport": {
"oneOf": [
{
"description": "if false, disable SSMImporting entirely. If true, use defaults",
"type": "boolean"
},
{
"description": "Enable SSM importing, with the value provided as the path to use.",
"pattern": "^\\/.+",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"path": {
"default": "/ecsdeployer/secrets/{{ .Project }}{{ if .Stage }}/{{ .Stage }}{{ end }}",
"description": "Path to the SSM parameter root for your project. A trailing slash will be added.",
"type": "string"
},
"recursive": {
"default": true,
"description": "Whether we should recurse into deeper parameter levels",
"type": "boolean"
}
},
"type": "object"
}
]
},
"Service": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"desired": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"load_balancer": {
"$ref": "#/$defs/LoadBalancers"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"rollout": {
"$ref": "#/$defs/RolloutConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"skip_wait_for_stable": {
"default": false,
"description": "Do not wait for service to become stable before marking it successful",
"type": "boolean"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"Settings": {
"additionalProperties": false,
"properties": {
"disable_marker_tag": {
"type": "boolean"
},
"keep_in_sync": {
"$ref": "#/$defs/KeepInSync"
},
"predeploy_timeout": {
"$ref": "#/$defs/Duration"
},
"skip_cron_env_vars": {
"type": "boolean"
},
"skip_deployment_env_vars": {
"type": "boolean"
},
"ssm_import": {
"$ref": "#/$defs/SSMImport"
},
"use_old_cron_eventbus": {
"type": "boolean"
},
"wait_for_stable": {
"$ref": "#/$defs/WaitForStable"
}
},
"type": "object"
},
"ShellCommand": {
"oneOf": [
{
"description": "Shell-style command",
"type": [
"number",
"string",
"boolean"
]
},
{
"description": "Command array. Preferred",
"items": {
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
},
"type": "array"
}
]
},
"Sidecar": {
"additionalProperties": false,
"properties": {
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"essential": {
"default": true,
"type": "boolean"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"inherit_env": {
"default": false,
"type": "boolean"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"memory_reservation": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"port_mappings": {
"items": {
"$ref": "#/$defs/PortMapping"
},
"type": "array"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"SpotOverrides": {
"description": "Spot Capacity Overrides",
"oneOf": [
{
"properties": {
"enabled": {
"default": false,
"description": "Enable spot containers",
"type": "boolean"
},
"minimum_ondemand": {
"type": "integer"
},
"minimum_ondemand_percent": {
"type": "integer"
}
},
"type": "object"
},
{
"type": "boolean"
}
]
},
"Storage": {
"default": 20,
"description": "Size in GB of storage to add",
"minimum": 20,
"type": "integer"
},
"TargetGroupRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"TaskDefaults": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"default": "amd64",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares",
"default": 1024
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"memory": {
"$ref": "#/$defs/Memory",
"default": "2x"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"oneOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"type": "object"
},
"TaskLoggingConfig": {
"oneOf": [
{
"const": false,
"description": "Disable logging",
"type": "boolean"
},
{
"description": "Inherit logging configuration",
"type": "null"
},
{
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
}
},
"type": "object"
}
]
},
"Ulimit": {
"description": "Ulimit overrides",
"oneOf": [
{
"additionalProperties": false,
"description": "Single value used for both hard and soft limits",
"properties": {
"limit": {
"type": "integer"
},
"name": {
"enum": [
"core",
"cpu",
"data",
"fsize",
"locks",
"memlock",
"msgqueue",
"nice",
"nofile",
"nproc",
"rss",
"rtprio",
"rttime",
"sigpending",
"stack"
],
"type": "string"
}
},
"required": [
"name",
"limit"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Define both hard and soft limit values",
"properties": {
"hard": {
"type": "integer"
},
"name": {
"enum": [
"core",
"cpu",
"data",
"fsize",
"locks",
"memlock",
"msgqueue",
"nice",
"nofile",
"nproc",
"rss",
"rtprio",
"rttime",
"sigpending",
"stack"
],
"type": "string"
},
"soft": {
"default": 0,
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"Volume": {
"oneOf": [
{
"description": "Shorthand to specify a default bind volume",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"efs": {
"$ref": "#/$defs/VolumeEFSConfig"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"VolumeEFSConfig": {
"additionalProperties": false,
"properties": {
"access_point_id": {
"type": "string"
},
"disable_encryption": {
"type": "boolean"
},
"disable_iam": {
"type": "boolean"
},
"file_system_id": {
"type": "string"
},
"root": {
"type": "string"
}
},
"required": [
"file_system_id"
],
"type": "object"
},
"VolumeFrom": {
"oneOf": [
{
"description": "Shorthand to specify a container name",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"readonly": {
"type": "boolean"
},
"source": {
"type": "string"
}
},
"required": [
"source"
],
"type": "object"
}
]
},
"VolumeList": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
},
"WaitForStable": {
"oneOf": [
{
"description": "Enable or disable waiting for stability entirely",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"default": false,
"type": "boolean"
},
"timeout": {
"$ref": "#/$defs/Duration",
"default": "1800"
}
},
"type": "object"
}
]
}
},
"$id": "https://ecsdeployer.com/ecsdeployer/pkg/config/project",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/$defs/ClusterRef"
},
"console": {
"$ref": "#/$defs/ConsoleTask"
},
"cron_launcher_role": {
"$ref": "#/$defs/RoleRef"
},
"cronjobs": {
"items": {
"$ref": "#/$defs/CronJob"
},
"type": "array"
},
"ecsdeployer": {
"$ref": "#/$defs/EcsDeployerOptions",
"description": "Add restrictions to ECSDeployer itself."
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"execution_role": {
"$ref": "#/$defs/RoleRef"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"logging": {
"$ref": "#/$defs/LoggingConfig"
},
"name_templates": {
"$ref": "#/$defs/NameTemplates"
},
"network": {
"$ref": "#/$defs/Network"
},
"predeploy": {
"items": {
"$ref": "#/$defs/PreDeployTask"
},
"type": "array"
},
"project": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Project Name",
"type": "string"
},
"role": {
"$ref": "#/$defs/RoleRef"
},
"service_role": {
"$ref": "#/$defs/RoleRef"
},
"services": {
"items": {
"$ref": "#/$defs/Service"
},
"type": "array"
},
"settings": {
"$ref": "#/$defs/Settings"
},
"stage": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Stage Name",
"type": "string"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"task_defaults": {
"$ref": "#/$defs/TaskDefaults"
}
},
"required": [
"project",
"cluster"
],
"title": "JSON Schema for ECS Deployer configuration file",
"type": "object"
} | MIT | en |
ecsdeployer/ecsdeployer | affdd7d87dd8e7c12c9d340eb62e2598900c3f73 | 2022-11-04T08:23:52 | www/docs/static/schema.json | 7 | 2024-05-27T06:55:04.899506Z | {
"$defs": {
"AwsLogConfig": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"retention": {
"$ref": "#/$defs/LogRetention"
}
},
"type": "object"
},
"CPUShares": {
"description": "Specify CPU Resources",
"oneOf": [
{
"description": "CPU Shares",
"minimum": 0,
"type": "integer"
},
{
"description": "CPU Shares or vCPUs",
"type": "string"
}
]
},
"ClusterRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"ConsoleTask": {
"oneOf": [
{
"description": "Enable or disable remote shell",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"enabled": {
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"path": {
"type": "string"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"type": "object"
}
]
},
"CronJob": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"bus": {
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"schedule": {
"examples": [
"cron(0 9 * * ? *)",
"rate(1 hour)",
"rate(2 hours)"
],
"minLength": 5,
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"required": [
"schedule",
"name"
],
"type": "object"
},
"DependsOn": {
"oneOf": [
{
"properties": {
"condition": {
"default": "START",
"enum": [
"START",
"COMPLETE",
"SUCCESS",
"HEALTHY"
],
"type": "string"
},
"name": {
"minLength": 1,
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]+$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
{
"description": "'container:CONDITION' format",
"pattern": "^[-_a-zA-Z0-9]+(:[a-zA-Z]+)?$",
"type": "string"
}
]
},
"Duration": {
"oneOf": [
{
"description": "Seconds",
"minimum": 0,
"type": "integer"
},
{
"description": "Duration specified in shorthand",
"examples": [
"5m",
"4m2s",
"2h",
"2h10m5s"
],
"pattern": "^[+]?([0-9]*(\\.[0-9]*)?[a-z]+)+$",
"type": "string"
}
]
},
"EcsDeployerOptions": {
"additionalProperties": false,
"properties": {
"allowed_account_id": {
"type": "string"
},
"required_version": {
"$ref": "#/$defs/VersionConstraint"
}
},
"type": "object"
},
"EnvVar": {
"oneOf": [
{
"$comment": "Pull a secret from an SSM Parameter",
"additionalProperties": false,
"properties": {
"ssm": {
"minLength": 1,
"type": "string"
}
},
"required": [
"ssm"
],
"type": "object"
},
{
"$comment": "Construct value using a template",
"additionalProperties": false,
"properties": {
"template": {
"minLength": 1,
"type": "string"
}
},
"required": [
"template"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"additionalProperties": false,
"properties": {
"value": {
"$ref": "#/$defs/StringLikeWithBlank"
}
},
"required": [
"value"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"$ref": "#/$defs/StringLikeWithBlank"
}
]
},
"EnvVarMap": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][^=]*$": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"FirelensAwsLogGroup": {
"description": "Should logs for firelens be sent to a log group",
"oneOf": [
{
"const": false,
"description": "Do not log to AWSLogs",
"type": "boolean"
},
{
"description": "Send logs to this log group",
"minLength": 2,
"type": "string"
}
]
},
"FirelensConfig": {
"additionalProperties": false,
"properties": {
"container_name": {
"default": "log_router",
"type": "string"
},
"credentials": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"inherit_env": {
"type": "boolean"
},
"log_to_awslogs": {
"$ref": "#/$defs/FirelensAwsLogGroup"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"type": {
"default": "fluentbit",
"enum": [
"fluentbit",
"fluentd"
],
"type": "string"
}
},
"type": "object"
},
"HealthCheck": {
"additionalProperties": false,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"interval": {
"$ref": "#/$defs/Duration"
},
"retries": {
"type": "integer"
},
"start_period": {
"$ref": "#/$defs/Duration"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"required": [
"command"
],
"type": "object"
},
"ImageUri": {
"oneOf": [
{
"oneOf": [
{
"required": [
"ecr",
"tag"
]
},
{
"required": [
"ecr",
"digest"
]
},
{
"required": [
"docker",
"tag"
]
},
{
"required": [
"docker",
"digest"
]
}
],
"properties": {
"digest": {
"title": "Image digest",
"type": "string"
},
"docker": {
"title": "Dockerhub Repo URI",
"type": "string"
},
"ecr": {
"title": "Just the ECR Repository name",
"type": "string"
},
"tag": {
"title": "Image tag",
"type": "string"
}
},
"type": "object"
},
{
"examples": [
"myorg/myapp:latest",
"myorg/myapp@sha256:deadbeefdeadbeefdeadbeefdeadbeef",
"myorg/myapp:{{ .ImageTag }}"
],
"minLength": 2,
"title": "The full URI to your image",
"type": "string"
}
]
},
"KeepInSync": {
"oneOf": [
{
"description": "Set all fields on or off",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"cronjobs": {
"default": true,
"description": "Deletes cronjobs no longer referenced in stage file",
"type": "boolean"
},
"log_retention": {
"default": true,
"description": "Ensures that log groups have the correct retention period set",
"type": "boolean"
},
"services": {
"default": true,
"description": "Deletes services no longer referenced in stage file",
"type": "boolean"
},
"task_definitions": {
"default": true,
"description": "Deregisters old task definitions",
"type": "boolean"
}
},
"type": "object"
}
]
},
"LoadBalancer": {
"additionalProperties": false,
"properties": {
"grace": {
"$ref": "#/$defs/Duration"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"target_group": {
"$ref": "#/$defs/TargetGroupRef"
}
},
"required": [
"port",
"target_group"
],
"type": "object"
},
"LoadBalancers": {
"oneOf": [
{
"$ref": "#/$defs/LoadBalancer",
"description": "Default variant, just define a single load balancer mapping"
},
{
"description": "Define multiple load balancer mappings.",
"items": {
"$ref": "#/$defs/LoadBalancer"
},
"type": "array"
}
]
},
"LogRetention": {
"description": "How long to retain logs in CloudWatch logs",
"oneOf": [
{
"const": "forever",
"description": "Retain logs forever",
"type": "string"
},
{
"description": "The number of days to retain logs",
"pattern": "^[1-9][0-9]*$",
"type": "string"
},
{
"description": "The number of days to retain logs",
"minimum": 1,
"type": "integer"
}
]
},
"LoggingConfig": {
"additionalProperties": false,
"properties": {
"awslogs": {
"$ref": "#/$defs/AwsLogConfig"
},
"disabled": {
"type": "boolean"
},
"firelens": {
"$ref": "#/$defs/FirelensConfig"
}
},
"type": "object"
},
"Memory": {
"oneOf": [
{
"description": "Absolute or multiple of CPU",
"examples": [
"2048",
"2x",
"2 GB",
"0.5gb",
"x2"
],
"type": "string"
},
{
"description": "Absolute value in Megabytes",
"type": "integer"
}
],
"title": "Memory requirements"
},
"NameTemplates": {
"additionalProperties": false,
"properties": {
"container": {
"default": "{{ .Name }}",
"minLength": 1,
"type": "string"
},
"cron_group": {
"default": "ecsd:{{ .ProjectName }}{{ if .Stage }}:{{ .Stage }}{{end}}:cron:{{ .Name }}",
"type": "string"
},
"cron_rule": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-rule-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"cron_target": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"log_group": {
"default": "/ecsdeployer/app/{{ .ProjectName }}/{{ if .Stage }}{{ .Stage }}/{{end}}{{ .Name }}",
"minLength": 1,
"type": "string"
},
"log_stream_prefix": {
"default": "{{ .Name }}",
"minLength": 1,
"type": "string"
},
"marker_tag_key": {
"default": "ecsdeployer/project",
"minLength": 1,
"type": "string"
},
"marker_tag_value": {
"default": "{{ .ProjectName }}{{ if .Stage }}/{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"predeploy_group": {
"default": "ecsd:{{ .ProjectName }}{{ if .Stage }}:{{ .Stage }}{{end}}:pd:{{ .Name }}",
"type": "string"
},
"predeploy_started_by": {
"default": "ecsd:{{ .ProjectName }}{{ if .Stage }}:{{ .Stage }}{{end}}:deployer",
"type": "string"
},
"service_name": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"target_group": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"task_family": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"NameValuePair": {
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"$ref": "#/$defs/StringLike"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"public_ip": {
"default": false,
"description": "Should the task be given a Public IP address?",
"type": "boolean"
},
"security_groups": {
"description": "List of SecurityGroupIds or SecurityGroup Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
},
"subnets": {
"description": "List of SubnetIds or Subnet Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
}
},
"type": "object"
},
"NetworkFilter": {
"oneOf": [
{
"description": "Explicit ID",
"examples": [
"subnet-12345abcd",
"sg-12345abcd"
],
"pattern": "^[a-z]+-[a-f0-9]{3,}$",
"type": "string"
},
{
"description": "Filter shorthand",
"examples": [
"status=available",
"tag:key=value"
],
"pattern": "^([^=]+)=(([^,]+),?)+$",
"type": "string"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"values": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"values"
],
"type": "object"
}
]
},
"PortMapping": {
"description": "Port specifications",
"oneOf": [
{
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"default": "tcp",
"enum": [
"tcp",
"udp"
],
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
{
"description": "Docker style port mapping",
"pattern": "^[0-9]+(/(tcp|udp))?$",
"type": "string"
},
{
"description": "Simple TCP Port",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
]
},
"PreDeployTask": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"disabled": {
"default": false,
"description": "Do not run this task",
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"ignore_failure": {
"default": false,
"description": "Ignore runtime failures of this task",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timeout": {
"$ref": "#/$defs/Duration",
"description": "Abort task after specified time has elapsed"
}
},
"required": [
"name"
],
"type": "object"
},
"RoleRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"RolloutConfig": {
"additionalProperties": false,
"properties": {
"max": {
"minimum": 0,
"type": "integer"
},
"min": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"SSMImport": {
"oneOf": [
{
"description": "if false, disable SSMImporting entirely. If true, use defaults",
"type": "boolean"
},
{
"description": "Enable SSM importing, with the value provided as the path to use.",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"path": {
"default": "/ecsdeployer/secrets/{{ .ProjectName }}{{ if .Stage }}/{{ .Stage }}{{ end }}",
"description": "Path to the SSM parameter root for your project. A trailing slash will be added.",
"type": "string"
},
"recursive": {
"default": true,
"description": "Whether we should recurse into deeper parameter levels",
"type": "boolean"
}
},
"type": "object"
}
]
},
"Service": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"desired": {
"type": "integer"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"load_balancer": {
"$ref": "#/$defs/LoadBalancers"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"rollout": {
"$ref": "#/$defs/RolloutConfig"
},
"skip_wait_for_stable": {
"default": false,
"description": "Do not wait for service to become stable before marking it successful",
"type": "boolean"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"required": [
"desired"
],
"type": "object"
},
"Settings": {
"additionalProperties": false,
"properties": {
"disable_marker_tag": {
"type": "boolean"
},
"keep_in_sync": {
"$ref": "#/$defs/KeepInSync"
},
"predeploy_parallel": {
"type": "boolean"
},
"predeploy_timeout": {
"$ref": "#/$defs/Duration"
},
"skip_deployment_env_vars": {
"type": "boolean"
},
"ssm_import": {
"$ref": "#/$defs/SSMImport"
},
"wait_for_stable": {
"$ref": "#/$defs/WaitForStable"
}
},
"type": "object"
},
"ShellCommand": {
"oneOf": [
{
"$ref": "#/$defs/StringLikeWithBlank",
"description": "Shell-style command"
},
{
"description": "Command array. Preferred",
"items": {
"$ref": "#/$defs/StringLikeWithBlank"
},
"type": "array"
}
]
},
"SpotOverrides": {
"description": "Spot Capacity Overrides",
"oneOf": [
{
"properties": {
"enabled": {
"default": false,
"description": "Enable spot containers",
"type": "boolean"
},
"minimum_ondemand": {
"type": "integer"
},
"minimum_ondemand_percent": {
"type": "integer"
}
},
"type": "object"
},
{
"type": "boolean"
}
]
},
"Storage": {
"default": 20,
"description": "Size in GB of storage to add",
"minimum": 20,
"type": "integer"
},
"StringLike": {
"description": "Any value that can be cast to a string of at least one character long",
"oneOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": [
"number",
"boolean"
]
}
]
},
"StringLikeWithBlank": {
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
},
"TargetGroupRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"TaskDefaults": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"type": "object"
},
"TaskLoggingConfig": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
}
},
"type": "object"
},
"VersionConstraint": {
"additionalProperties": false,
"properties": {},
"type": "object"
},
"WaitForStable": {
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"individually": {
"description": "Don't use this",
"type": "boolean"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"type": "object"
}
},
"$id": "https://ecsdeployer.com/ecsdeployer/pkg/config/project",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/$defs/ClusterRef"
},
"console": {
"$ref": "#/$defs/ConsoleTask"
},
"cron_launcher_role": {
"$ref": "#/$defs/RoleRef"
},
"cronjobs": {
"items": {
"$ref": "#/$defs/CronJob"
},
"type": "array"
},
"ecsdeployer": {
"$ref": "#/$defs/EcsDeployerOptions",
"description": "Add restrictions to ECSDeployer itself."
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"execution_role": {
"$ref": "#/$defs/RoleRef"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"logging": {
"$ref": "#/$defs/LoggingConfig"
},
"name_templates": {
"$ref": "#/$defs/NameTemplates"
},
"network": {
"$ref": "#/$defs/Network"
},
"predeploy": {
"items": {
"$ref": "#/$defs/PreDeployTask"
},
"type": "array"
},
"project": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Project Name",
"type": "string"
},
"role": {
"$ref": "#/$defs/RoleRef"
},
"services": {
"items": {
"$ref": "#/$defs/Service"
},
"type": "array"
},
"settings": {
"$ref": "#/$defs/Settings"
},
"stage": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Stage Name",
"type": "string"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"task_defaults": {
"$ref": "#/$defs/TaskDefaults"
}
},
"required": [
"project",
"cluster"
],
"title": "JSON Schema for ECS Deployer configuration file",
"type": "object"
} | MIT | en |
ecsdeployer/ecsdeployer | 510358a803b67dd6e404bb1e5c4c4212a2f61890 | 2023-03-10T02:40:40 | www/docs/static/schema.json | 7 | 2024-05-27T06:55:04.899506Z | {
"$defs": {
"Architecture": {
"default": "amd64",
"description": "Specify CPU Architecture",
"enum": [
"amd64",
"arm64",
"x86_64"
],
"type": "string"
},
"AwsLogConfig": {
"oneOf": [
{
"description": "Enable or disable logging to AWS using default values",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"retention": {
"$ref": "#/$defs/LogRetention"
}
},
"type": "object"
}
]
},
"CPUShares": {
"description": "Specify CPU Resources",
"oneOf": [
{
"description": "CPU Shares",
"minimum": 0,
"type": "integer"
},
{
"description": "CPU Shares or vCPUs",
"type": "string"
}
]
},
"ClusterRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"ConsoleTask": {
"oneOf": [
{
"description": "Enable or disable remote shell",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"enabled": {
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"path": {
"type": "string"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"type": "string"
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"type": "object"
}
]
},
"CronJob": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"bus": {
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"end_date": {
"format": "date-time",
"type": "string"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"schedule": {
"examples": [
"cron(0 9 * * ? *)",
"rate(1 hour)",
"rate(2 hours)"
],
"minLength": 5,
"type": "string"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"start_date": {
"format": "date-time",
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timezone": {
"type": "string"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"type": "string"
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"schedule",
"name"
],
"type": "object"
},
"CustomLogConfig": {
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
}
},
"type": "object"
},
"DependsOn": {
"oneOf": [
{
"properties": {
"condition": {
"default": "START",
"enum": [
"START",
"COMPLETE",
"SUCCESS",
"HEALTHY"
],
"type": "string"
},
"name": {
"minLength": 1,
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]+$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
{
"description": "'container:CONDITION' format",
"pattern": "^[-_a-zA-Z0-9]+(:[a-zA-Z]+)?$",
"type": "string"
}
]
},
"Duration": {
"oneOf": [
{
"description": "Seconds",
"minimum": 0,
"type": "integer"
},
{
"description": "Duration specified in shorthand",
"examples": [
"5m",
"4m2s",
"2h",
"2h10m5s"
],
"pattern": "^[+]?([0-9]*(\\.[0-9]*)?[a-z]+)+$",
"type": "string"
}
]
},
"EcsDeployerOptions": {
"additionalProperties": false,
"properties": {
"allowed_account_id": {
"description": "Restrict to a specific AWS account ID.",
"oneOf": [
{
"pattern": "^[0-9]{12,}$",
"type": "string"
},
{
"type": "integer"
}
]
},
"required_version": {
"$ref": "#/$defs/VersionConstraint",
"description": "Create a version constraint to prevent different versions of ECS Deployer from deploying this app."
}
},
"type": "object"
},
"EnvVar": {
"oneOf": [
{
"$comment": "Pull a secret from an SSM Parameter",
"additionalProperties": false,
"properties": {
"ssm": {
"minLength": 1,
"type": "string"
}
},
"required": [
"ssm"
],
"type": "object"
},
{
"$comment": "Construct value using a template",
"additionalProperties": false,
"properties": {
"template": {
"minLength": 1,
"type": "string"
}
},
"required": [
"template"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"additionalProperties": false,
"properties": {
"value": {
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
}
},
"required": [
"value"
],
"type": "object"
},
{
"$comment": "Unsets any value that was defined previously",
"additionalProperties": false,
"properties": {
"unset": {
"const": true,
"type": "boolean"
}
},
"required": [
"unset"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
}
]
},
"EnvVarMap": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][^=]*$": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"FirelensAwsLogGroup": {
"description": "Should logs for firelens be sent to a log group",
"oneOf": [
{
"const": false,
"description": "Do not log to AWSLogs",
"type": "boolean"
},
{
"description": "Send logs to this log group",
"minLength": 2,
"type": "string"
}
]
},
"FirelensConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"container_name": {
"default": "log_router",
"type": "string"
},
"credentials": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"inherit_env": {
"type": "boolean"
},
"log_to_awslogs": {
"$ref": "#/$defs/FirelensAwsLogGroup"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"router_options": {
"$ref": "#/$defs/EnvVarMap"
},
"type": {
"default": "fluentbit",
"enum": [
"fluentbit",
"fluentd"
],
"type": "string"
}
},
"type": "object"
}
]
},
"HealthCheck": {
"oneOf": [
{
"const": false,
"description": "Disable a healthcheck for a specific task",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"command": {
"$ref": "#/$defs/ShellCommand"
},
"disabled": {
"type": "boolean"
},
"interval": {
"$ref": "#/$defs/Duration"
},
"retries": {
"minimum": 1,
"type": "integer"
},
"start_period": {
"$ref": "#/$defs/Duration"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"type": "object"
}
]
},
"ImageUri": {
"oneOf": [
{
"additionalProperties": false,
"oneOf": [
{
"required": [
"ecr",
"tag"
]
},
{
"required": [
"ecr",
"digest"
]
},
{
"required": [
"docker",
"tag"
]
},
{
"required": [
"docker",
"digest"
]
}
],
"properties": {
"digest": {
"title": "Image digest",
"type": "string"
},
"docker": {
"title": "Dockerhub Repo URI",
"type": "string"
},
"ecr": {
"title": "Just the ECR Repository name",
"type": "string"
},
"tag": {
"title": "Image tag",
"type": "string"
}
},
"type": "object"
},
{
"examples": [
"myorg/myapp:latest",
"myorg/myapp@sha256:deadbeefdeadbeefdeadbeefdeadbeef",
"myorg/myapp:{{ .ImageTag }}"
],
"minLength": 2,
"title": "The full URI to your image",
"type": "string"
}
]
},
"KeepInSync": {
"oneOf": [
{
"description": "Set all fields on or off",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"cronjobs": {
"default": true,
"description": "Deletes cronjobs no longer referenced in stage file",
"type": "boolean"
},
"log_retention": {
"default": true,
"description": "Ensures that log groups have the correct retention period set",
"type": "boolean"
},
"services": {
"default": true,
"description": "Deletes services no longer referenced in stage file",
"type": "boolean"
},
"task_definitions": {
"default": true,
"description": "Deregisters old task definitions",
"type": "boolean"
}
},
"type": "object"
}
]
},
"LoadBalancer": {
"additionalProperties": false,
"properties": {
"grace": {
"$ref": "#/$defs/Duration"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"target_group": {
"$ref": "#/$defs/TargetGroupRef"
}
},
"required": [
"port",
"target_group"
],
"type": "object"
},
"LoadBalancers": {
"oneOf": [
{
"$ref": "#/$defs/LoadBalancer",
"description": "Default variant, just define a single load balancer mapping"
},
{
"description": "Define multiple load balancer mappings.",
"items": {
"$ref": "#/$defs/LoadBalancer"
},
"type": "array"
}
]
},
"LogRetention": {
"description": "How long to retain logs in CloudWatch logs",
"oneOf": [
{
"const": "forever",
"description": "Retain logs forever",
"type": "string"
},
{
"description": "The number of days to retain logs",
"pattern": "^[1-9][0-9]*$",
"type": "string"
},
{
"description": "The number of days to retain logs",
"minimum": 1,
"type": "integer"
}
]
},
"LoggingConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"awslogs": {
"$ref": "#/$defs/AwsLogConfig"
},
"custom": {
"$ref": "#/$defs/CustomLogConfig"
},
"disabled": {
"type": "boolean"
},
"firelens": {
"$ref": "#/$defs/FirelensConfig"
}
},
"type": "object"
}
]
},
"Memory": {
"oneOf": [
{
"description": "Absolute or multiple of CPU",
"examples": [
"2048",
"2x",
"2 GB",
"0.5gb",
"x2"
],
"type": "string"
},
{
"description": "Absolute value in Megabytes",
"type": "integer"
}
],
"title": "Memory requirements"
},
"Mount": {
"additionalProperties": false,
"properties": {
"path": {
"type": "string"
},
"readonly": {
"type": "boolean"
},
"source": {
"type": "string"
}
},
"required": [
"path",
"source"
],
"type": "object"
},
"NameTemplates": {
"additionalProperties": false,
"properties": {
"cron_group": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:cron:{{ .Name }}",
"type": "string"
},
"cron_rule": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-rule-{{ .Name }}",
"deprecated": true,
"minLength": 1,
"type": "string"
},
"cron_target": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"deprecated": true,
"minLength": 1,
"type": "string"
},
"log_group": {
"default": "/ecsdeployer/app/{{ .Project }}/{{ if .Stage }}{{ .Stage }}/{{end}}{{ .Name }}",
"minLength": 1,
"type": "string"
},
"log_stream_prefix": {
"default": "{{ .Container }}",
"minLength": 1,
"type": "string"
},
"marker_tag_key": {
"default": "ecsdeployer/project",
"minLength": 1,
"type": "string"
},
"marker_tag_value": {
"default": "{{ .Project }}{{ if .Stage }}/{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"predeploy_group": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:pd:{{ .Name }}",
"type": "string"
},
"predeploy_started_by": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:deployer",
"type": "string"
},
"schedule": {
"default": "ecsd-cron-{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"schedule_group": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"service_name": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"target_group": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"task_family": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"NameValuePair": {
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"description": "Any value that can be cast to a string of at least one character long",
"oneOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": [
"number",
"boolean"
]
}
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"public_ip": {
"default": false,
"description": "Should the task be given a Public IP address?",
"type": "boolean"
},
"security_groups": {
"description": "List of SecurityGroupIds or SecurityGroup Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
},
"subnets": {
"description": "List of SubnetIds or Subnet Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
}
},
"type": "object"
},
"NetworkFilter": {
"oneOf": [
{
"description": "Explicit ID",
"examples": [
"subnet-12345abcd",
"sg-12345abcd"
],
"pattern": "^[a-z]+-[a-f0-9]{3,}$",
"type": "string"
},
{
"description": "Filter shorthand",
"examples": [
"status=available",
"tag:key=value"
],
"pattern": "^([^=]+)=(([^,]+),?)+$",
"type": "string"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"values": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"values"
],
"type": "object"
}
]
},
"PortMapping": {
"description": "Port specifications",
"oneOf": [
{
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"default": "tcp",
"enum": [
"tcp",
"udp"
],
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
{
"description": "Docker style port mapping",
"pattern": "^[0-9]+(/(tcp|udp))?$",
"type": "string"
},
{
"description": "Simple TCP Port",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
]
},
"PreDeployTask": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"disabled": {
"default": false,
"description": "Do not run this task",
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"ignore_failure": {
"default": false,
"description": "Ignore runtime failures of this task",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timeout": {
"$ref": "#/$defs/Duration",
"description": "Abort task after specified time has elapsed"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"type": "string"
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"ProxyConfig": {
"oneOf": [
{
"const": false,
"description": "Disable proxy configuration for a specific task",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"container": {
"default": "envoy",
"description": "Name of the sidecar that provides the proxy",
"type": "string"
},
"disabled": {
"type": "boolean"
},
"properties": {
"$ref": "#/$defs/EnvVarMap"
},
"type": {
"default": "APPMESH",
"description": "Proxy type. You should omit this unless you know what you are doing.",
"examples": [
"APPMESH"
],
"type": "string"
}
},
"type": "object"
}
]
},
"RoleRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"RolloutConfig": {
"additionalProperties": false,
"properties": {
"max": {
"minimum": 0,
"type": "integer"
},
"min": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"SSMImport": {
"oneOf": [
{
"description": "if false, disable SSMImporting entirely. If true, use defaults",
"type": "boolean"
},
{
"description": "Enable SSM importing, with the value provided as the path to use.",
"pattern": "^\\/.+",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"path": {
"default": "/ecsdeployer/secrets/{{ .Project }}{{ if .Stage }}/{{ .Stage }}{{ end }}",
"description": "Path to the SSM parameter root for your project. A trailing slash will be added.",
"type": "string"
},
"recursive": {
"default": true,
"description": "Whether we should recurse into deeper parameter levels",
"type": "boolean"
}
},
"type": "object"
}
]
},
"Service": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"desired": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"load_balancer": {
"$ref": "#/$defs/LoadBalancers"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"rollout": {
"$ref": "#/$defs/RolloutConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"skip_wait_for_stable": {
"default": false,
"description": "Do not wait for service to become stable before marking it successful",
"type": "boolean"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"type": "string"
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"desired",
"name"
],
"type": "object"
},
"Settings": {
"additionalProperties": false,
"properties": {
"disable_marker_tag": {
"type": "boolean"
},
"keep_in_sync": {
"$ref": "#/$defs/KeepInSync"
},
"predeploy_parallel": {
"type": "boolean"
},
"predeploy_timeout": {
"$ref": "#/$defs/Duration"
},
"skip_cron_env_vars": {
"type": "boolean"
},
"skip_deployment_env_vars": {
"type": "boolean"
},
"ssm_import": {
"$ref": "#/$defs/SSMImport"
},
"use_old_cron_eventbus": {
"type": "boolean"
},
"wait_for_stable": {
"$ref": "#/$defs/WaitForStable"
}
},
"type": "object"
},
"ShellCommand": {
"oneOf": [
{
"description": "Shell-style command",
"type": [
"number",
"string",
"boolean"
]
},
{
"description": "Command array. Preferred",
"items": {
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
},
"type": "array"
}
]
},
"Sidecar": {
"additionalProperties": false,
"properties": {
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"essential": {
"default": true,
"type": "boolean"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"inherit_env": {
"default": false,
"type": "boolean"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"memory_reservation": {
"$ref": "#/$defs/Memory"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"port_mappings": {
"items": {
"$ref": "#/$defs/PortMapping"
},
"type": "array"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"type": "string"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"SpotOverrides": {
"description": "Spot Capacity Overrides",
"oneOf": [
{
"properties": {
"enabled": {
"default": false,
"description": "Enable spot containers",
"type": "boolean"
},
"minimum_ondemand": {
"type": "integer"
},
"minimum_ondemand_percent": {
"type": "integer"
}
},
"type": "object"
},
{
"type": "boolean"
}
]
},
"Storage": {
"default": 20,
"description": "Size in GB of storage to add",
"minimum": 20,
"type": "integer"
},
"TargetGroupRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"TaskDefaults": {
"additionalProperties": false,
"properties": {
"arch": {
"$ref": "#/$defs/Architecture",
"default": "amd64",
"description": "Task CPU Architecture"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares",
"default": 1024
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"memory": {
"$ref": "#/$defs/Memory",
"default": "2x"
},
"mounts": {
"items": {
"$ref": "#/$defs/Mount"
},
"type": "array"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"proxy": {
"$ref": "#/$defs/ProxyConfig"
},
"sidecars": {
"items": {
"$ref": "#/$defs/Sidecar"
},
"type": "array"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"ulimits": {
"items": {
"$ref": "#/$defs/Ulimit"
},
"type": "array"
},
"user": {
"type": "string"
},
"volumes": {
"$ref": "#/$defs/VolumeList"
},
"volumes_from": {
"items": {
"$ref": "#/$defs/VolumeFrom"
},
"type": "array"
},
"workdir": {
"type": "string"
}
},
"type": "object"
},
"TaskLoggingConfig": {
"oneOf": [
{
"const": false,
"description": "Disable logging",
"type": "boolean"
},
{
"description": "Inherit logging configuration",
"type": "null"
},
{
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
}
},
"type": "object"
}
]
},
"Ulimit": {
"description": "Ulimit overrides",
"oneOf": [
{
"additionalProperties": false,
"description": "Single value used for both hard and soft limits",
"properties": {
"limit": {
"type": "integer"
},
"name": {
"enum": [
"core",
"cpu",
"data",
"fsize",
"locks",
"memlock",
"msgqueue",
"nice",
"nofile",
"nproc",
"rss",
"rtprio",
"rttime",
"sigpending",
"stack"
],
"type": "string"
}
},
"required": [
"name",
"limit"
],
"type": "object"
},
{
"additionalProperties": false,
"description": "Define both hard and soft limit values",
"properties": {
"hard": {
"type": "integer"
},
"name": {
"enum": [
"core",
"cpu",
"data",
"fsize",
"locks",
"memlock",
"msgqueue",
"nice",
"nofile",
"nproc",
"rss",
"rtprio",
"rttime",
"sigpending",
"stack"
],
"type": "string"
},
"soft": {
"default": 0,
"type": "integer"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"VersionConstraint": {
"$comment": "https://pkg.go.dev/github.com/Masterminds/semver/v3#readme-checking-version-constraints",
"description": "Specify a constraint on a semantic version",
"type": "string"
},
"Volume": {
"oneOf": [
{
"description": "Shorthand to specify a default bind volume",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"efs": {
"$ref": "#/$defs/VolumeEFSConfig"
},
"name": {
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
}
]
},
"VolumeEFSConfig": {
"additionalProperties": false,
"properties": {
"access_point_id": {
"type": "string"
},
"disable_encryption": {
"type": "boolean"
},
"disable_iam": {
"type": "boolean"
},
"file_system_id": {
"type": "string"
},
"root": {
"type": "string"
}
},
"required": [
"file_system_id"
],
"type": "object"
},
"VolumeFrom": {
"oneOf": [
{
"description": "Shorthand to specify a container name",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"readonly": {
"type": "boolean"
},
"source": {
"type": "string"
}
},
"required": [
"source"
],
"type": "object"
}
]
},
"VolumeList": {
"items": {
"$ref": "#/$defs/Volume"
},
"type": "array"
},
"WaitForStable": {
"oneOf": [
{
"description": "Enable or disable waiting for stability entirely",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"individually": {
"description": "Don't use this",
"type": "boolean"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"type": "object"
}
]
}
},
"$id": "https://ecsdeployer.com/ecsdeployer/pkg/config/project",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/$defs/ClusterRef"
},
"console": {
"$ref": "#/$defs/ConsoleTask"
},
"cron_launcher_role": {
"$ref": "#/$defs/RoleRef"
},
"cronjobs": {
"items": {
"$ref": "#/$defs/CronJob"
},
"type": "array"
},
"ecsdeployer": {
"$ref": "#/$defs/EcsDeployerOptions",
"description": "Add restrictions to ECSDeployer itself."
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"execution_role": {
"$ref": "#/$defs/RoleRef"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"logging": {
"$ref": "#/$defs/LoggingConfig"
},
"name_templates": {
"$ref": "#/$defs/NameTemplates"
},
"network": {
"$ref": "#/$defs/Network"
},
"predeploy": {
"items": {
"$ref": "#/$defs/PreDeployTask"
},
"type": "array"
},
"project": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Project Name",
"type": "string"
},
"role": {
"$ref": "#/$defs/RoleRef"
},
"service_role": {
"$ref": "#/$defs/RoleRef"
},
"services": {
"items": {
"$ref": "#/$defs/Service"
},
"type": "array"
},
"settings": {
"$ref": "#/$defs/Settings"
},
"stage": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Stage Name",
"type": "string"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"task_defaults": {
"$ref": "#/$defs/TaskDefaults"
}
},
"required": [
"project",
"cluster"
],
"title": "JSON Schema for ECS Deployer configuration file",
"type": "object"
} | MIT | en |
ecsdeployer/ecsdeployer | 70fd715d2315b27daa6aa0f0c2c4e84cebbd51fc | 2023-02-12T21:19:40 | www/docs/static/schema.json | 7 | 2024-05-27T06:55:04.899506Z | {
"$defs": {
"AwsLogConfig": {
"oneOf": [
{
"description": "Enable or disable logging to AWS using default values",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"retention": {
"$ref": "#/$defs/LogRetention"
}
},
"type": "object"
}
]
},
"CPUShares": {
"description": "Specify CPU Resources",
"oneOf": [
{
"description": "CPU Shares",
"minimum": 0,
"type": "integer"
},
{
"description": "CPU Shares or vCPUs",
"type": "string"
}
]
},
"ClusterRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"ConsoleTask": {
"oneOf": [
{
"description": "Enable or disable remote shell",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"enabled": {
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"path": {
"type": "string"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"type": "object"
}
]
},
"CronJob": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"bus": {
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"end_date": {
"format": "date-time",
"type": "string"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"schedule": {
"examples": [
"cron(0 9 * * ? *)",
"rate(1 hour)",
"rate(2 hours)"
],
"minLength": 5,
"type": "string"
},
"start_date": {
"format": "date-time",
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timezone": {
"type": "string"
}
},
"required": [
"schedule",
"name"
],
"type": "object"
},
"DependsOn": {
"oneOf": [
{
"properties": {
"condition": {
"default": "START",
"enum": [
"START",
"COMPLETE",
"SUCCESS",
"HEALTHY"
],
"type": "string"
},
"name": {
"minLength": 1,
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]+$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
{
"description": "'container:CONDITION' format",
"pattern": "^[-_a-zA-Z0-9]+(:[a-zA-Z]+)?$",
"type": "string"
}
]
},
"Duration": {
"oneOf": [
{
"description": "Seconds",
"minimum": 0,
"type": "integer"
},
{
"description": "Duration specified in shorthand",
"examples": [
"5m",
"4m2s",
"2h",
"2h10m5s"
],
"pattern": "^[+]?([0-9]*(\\.[0-9]*)?[a-z]+)+$",
"type": "string"
}
]
},
"EcsDeployerOptions": {
"additionalProperties": false,
"properties": {
"allowed_account_id": {
"description": "Restrict to a specific AWS account ID.",
"oneOf": [
{
"pattern": "^[0-9]{12,}$",
"type": "string"
},
{
"type": "integer"
}
]
},
"required_version": {
"$ref": "#/$defs/VersionConstraint",
"description": "Create a version constraint to prevent different versions of ECS Deployer from deploying this app."
}
},
"type": "object"
},
"EnvVar": {
"oneOf": [
{
"$comment": "Pull a secret from an SSM Parameter",
"additionalProperties": false,
"properties": {
"ssm": {
"minLength": 1,
"type": "string"
}
},
"required": [
"ssm"
],
"type": "object"
},
{
"$comment": "Construct value using a template",
"additionalProperties": false,
"properties": {
"template": {
"minLength": 1,
"type": "string"
}
},
"required": [
"template"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"additionalProperties": false,
"properties": {
"value": {
"$ref": "#/$defs/StringLikeWithBlank"
}
},
"required": [
"value"
],
"type": "object"
},
{
"$comment": "Unsets any value that was defined previously",
"additionalProperties": false,
"properties": {
"unset": {
"const": true,
"type": "boolean"
}
},
"required": [
"unset"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"$ref": "#/$defs/StringLikeWithBlank"
}
]
},
"EnvVarMap": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][^=]*$": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"FirelensAwsLogGroup": {
"description": "Should logs for firelens be sent to a log group",
"oneOf": [
{
"const": false,
"description": "Do not log to AWSLogs",
"type": "boolean"
},
{
"description": "Send logs to this log group",
"minLength": 2,
"type": "string"
}
]
},
"FirelensConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"container_name": {
"default": "log_router",
"type": "string"
},
"credentials": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"inherit_env": {
"type": "boolean"
},
"log_to_awslogs": {
"$ref": "#/$defs/FirelensAwsLogGroup"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"type": {
"default": "fluentbit",
"enum": [
"fluentbit",
"fluentd"
],
"type": "string"
}
},
"type": "object"
}
]
},
"HealthCheck": {
"additionalProperties": false,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"interval": {
"$ref": "#/$defs/Duration"
},
"retries": {
"type": "integer"
},
"start_period": {
"$ref": "#/$defs/Duration"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"required": [
"command"
],
"type": "object"
},
"ImageUri": {
"oneOf": [
{
"additionalProperties": false,
"oneOf": [
{
"required": [
"ecr",
"tag"
]
},
{
"required": [
"ecr",
"digest"
]
},
{
"required": [
"docker",
"tag"
]
},
{
"required": [
"docker",
"digest"
]
}
],
"properties": {
"digest": {
"title": "Image digest",
"type": "string"
},
"docker": {
"title": "Dockerhub Repo URI",
"type": "string"
},
"ecr": {
"title": "Just the ECR Repository name",
"type": "string"
},
"tag": {
"title": "Image tag",
"type": "string"
}
},
"type": "object"
},
{
"examples": [
"myorg/myapp:latest",
"myorg/myapp@sha256:deadbeefdeadbeefdeadbeefdeadbeef",
"myorg/myapp:{{ .ImageTag }}"
],
"minLength": 2,
"title": "The full URI to your image",
"type": "string"
}
]
},
"KeepInSync": {
"oneOf": [
{
"description": "Set all fields on or off",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"cronjobs": {
"default": true,
"description": "Deletes cronjobs no longer referenced in stage file",
"type": "boolean"
},
"log_retention": {
"default": true,
"description": "Ensures that log groups have the correct retention period set",
"type": "boolean"
},
"services": {
"default": true,
"description": "Deletes services no longer referenced in stage file",
"type": "boolean"
},
"task_definitions": {
"default": true,
"description": "Deregisters old task definitions",
"type": "boolean"
}
},
"type": "object"
}
]
},
"LoadBalancer": {
"additionalProperties": false,
"properties": {
"grace": {
"$ref": "#/$defs/Duration"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"target_group": {
"$ref": "#/$defs/TargetGroupRef"
}
},
"required": [
"port",
"target_group"
],
"type": "object"
},
"LoadBalancers": {
"oneOf": [
{
"$ref": "#/$defs/LoadBalancer",
"description": "Default variant, just define a single load balancer mapping"
},
{
"description": "Define multiple load balancer mappings.",
"items": {
"$ref": "#/$defs/LoadBalancer"
},
"type": "array"
}
]
},
"LogRetention": {
"description": "How long to retain logs in CloudWatch logs",
"oneOf": [
{
"const": "forever",
"description": "Retain logs forever",
"type": "string"
},
{
"description": "The number of days to retain logs",
"pattern": "^[1-9][0-9]*$",
"type": "string"
},
{
"description": "The number of days to retain logs",
"minimum": 1,
"type": "integer"
}
]
},
"LoggingConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"awslogs": {
"$ref": "#/$defs/AwsLogConfig"
},
"disabled": {
"type": "boolean"
},
"firelens": {
"$ref": "#/$defs/FirelensConfig"
}
},
"type": "object"
}
]
},
"Memory": {
"oneOf": [
{
"description": "Absolute or multiple of CPU",
"examples": [
"2048",
"2x",
"2 GB",
"0.5gb",
"x2"
],
"type": "string"
},
{
"description": "Absolute value in Megabytes",
"type": "integer"
}
],
"title": "Memory requirements"
},
"NameTemplates": {
"additionalProperties": false,
"properties": {
"container": {
"default": "{{ .Name }}",
"minLength": 1,
"type": "string"
},
"cron_group": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:cron:{{ .Name }}",
"type": "string"
},
"cron_rule": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-rule-{{ .Name }}",
"deprecated": true,
"minLength": 1,
"type": "string"
},
"cron_target": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"deprecated": true,
"minLength": 1,
"type": "string"
},
"log_group": {
"default": "/ecsdeployer/app/{{ .Project }}/{{ if .Stage }}{{ .Stage }}/{{end}}{{ .Name }}",
"minLength": 1,
"type": "string"
},
"log_stream_prefix": {
"default": "{{ .Name }}",
"minLength": 1,
"type": "string"
},
"marker_tag_key": {
"default": "ecsdeployer/project",
"minLength": 1,
"type": "string"
},
"marker_tag_value": {
"default": "{{ .Project }}{{ if .Stage }}/{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"predeploy_group": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:pd:{{ .Name }}",
"type": "string"
},
"predeploy_started_by": {
"default": "ecsd:{{ .Project }}{{ if .Stage }}:{{ .Stage }}{{end}}:deployer",
"type": "string"
},
"schedule": {
"default": "ecsd-cron-{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"schedule_group": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"service_name": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"target_group": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"task_family": {
"default": "{{ .Project }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"NameValuePair": {
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"$ref": "#/$defs/StringLike"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"public_ip": {
"default": false,
"description": "Should the task be given a Public IP address?",
"type": "boolean"
},
"security_groups": {
"description": "List of SecurityGroupIds or SecurityGroup Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
},
"subnets": {
"description": "List of SubnetIds or Subnet Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
}
},
"type": "object"
},
"NetworkFilter": {
"oneOf": [
{
"description": "Explicit ID",
"examples": [
"subnet-12345abcd",
"sg-12345abcd"
],
"pattern": "^[a-z]+-[a-f0-9]{3,}$",
"type": "string"
},
{
"description": "Filter shorthand",
"examples": [
"status=available",
"tag:key=value"
],
"pattern": "^([^=]+)=(([^,]+),?)+$",
"type": "string"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"values": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"values"
],
"type": "object"
}
]
},
"PortMapping": {
"description": "Port specifications",
"oneOf": [
{
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"default": "tcp",
"enum": [
"tcp",
"udp"
],
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
{
"description": "Docker style port mapping",
"pattern": "^[0-9]+(/(tcp|udp))?$",
"type": "string"
},
{
"description": "Simple TCP Port",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
]
},
"PreDeployTask": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"disabled": {
"default": false,
"description": "Do not run this task",
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"ignore_failure": {
"default": false,
"description": "Ignore runtime failures of this task",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timeout": {
"$ref": "#/$defs/Duration",
"description": "Abort task after specified time has elapsed"
}
},
"required": [
"name"
],
"type": "object"
},
"RoleRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"RolloutConfig": {
"additionalProperties": false,
"properties": {
"max": {
"minimum": 0,
"type": "integer"
},
"min": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"SSMImport": {
"oneOf": [
{
"description": "if false, disable SSMImporting entirely. If true, use defaults",
"type": "boolean"
},
{
"description": "Enable SSM importing, with the value provided as the path to use.",
"pattern": "^\\/.+",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"path": {
"default": "/ecsdeployer/secrets/{{ .Project }}{{ if .Stage }}/{{ .Stage }}{{ end }}",
"description": "Path to the SSM parameter root for your project. A trailing slash will be added.",
"type": "string"
},
"recursive": {
"default": true,
"description": "Whether we should recurse into deeper parameter levels",
"type": "boolean"
}
},
"type": "object"
}
]
},
"Service": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"desired": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"load_balancer": {
"$ref": "#/$defs/LoadBalancers"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"rollout": {
"$ref": "#/$defs/RolloutConfig"
},
"skip_wait_for_stable": {
"default": false,
"description": "Do not wait for service to become stable before marking it successful",
"type": "boolean"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"required": [
"desired",
"name"
],
"type": "object"
},
"Settings": {
"additionalProperties": false,
"properties": {
"disable_marker_tag": {
"type": "boolean"
},
"keep_in_sync": {
"$ref": "#/$defs/KeepInSync"
},
"predeploy_parallel": {
"type": "boolean"
},
"predeploy_timeout": {
"$ref": "#/$defs/Duration"
},
"skip_cron_env_vars": {
"type": "boolean"
},
"skip_deployment_env_vars": {
"type": "boolean"
},
"ssm_import": {
"$ref": "#/$defs/SSMImport"
},
"use_old_cron_eventbus": {
"type": "boolean"
},
"wait_for_stable": {
"$ref": "#/$defs/WaitForStable"
}
},
"type": "object"
},
"ShellCommand": {
"oneOf": [
{
"$ref": "#/$defs/StringLikeWithBlank",
"description": "Shell-style command"
},
{
"description": "Command array. Preferred",
"items": {
"$ref": "#/$defs/StringLikeWithBlank"
},
"type": "array"
}
]
},
"SpotOverrides": {
"description": "Spot Capacity Overrides",
"oneOf": [
{
"properties": {
"enabled": {
"default": false,
"description": "Enable spot containers",
"type": "boolean"
},
"minimum_ondemand": {
"type": "integer"
},
"minimum_ondemand_percent": {
"type": "integer"
}
},
"type": "object"
},
{
"type": "boolean"
}
]
},
"Storage": {
"default": 20,
"description": "Size in GB of storage to add",
"minimum": 20,
"type": "integer"
},
"StringLike": {
"description": "Any value that can be cast to a string of at least one character long",
"oneOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": [
"number",
"boolean"
]
}
]
},
"StringLikeWithBlank": {
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
},
"TargetGroupRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"TaskDefaults": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"type": "object"
},
"TaskLoggingConfig": {
"oneOf": [
{
"const": false,
"description": "Disable logging",
"type": "boolean"
},
{
"description": "Inherit logging configuration",
"type": "null"
},
{
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
}
},
"type": "object"
}
]
},
"VersionConstraint": {
"$comment": "https://pkg.go.dev/github.com/Masterminds/semver/v3#readme-checking-version-constraints",
"description": "Specify a constraint on a semantic version",
"type": "string"
},
"WaitForStable": {
"oneOf": [
{
"description": "Enable or disable waiting for stability entirely",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"individually": {
"description": "Don't use this",
"type": "boolean"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"type": "object"
}
]
}
},
"$id": "https://ecsdeployer.com/ecsdeployer/pkg/config/project",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/$defs/ClusterRef"
},
"console": {
"$ref": "#/$defs/ConsoleTask"
},
"cron_launcher_role": {
"$ref": "#/$defs/RoleRef"
},
"cronjobs": {
"items": {
"$ref": "#/$defs/CronJob"
},
"type": "array"
},
"ecsdeployer": {
"$ref": "#/$defs/EcsDeployerOptions",
"description": "Add restrictions to ECSDeployer itself."
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"execution_role": {
"$ref": "#/$defs/RoleRef"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"logging": {
"$ref": "#/$defs/LoggingConfig"
},
"name_templates": {
"$ref": "#/$defs/NameTemplates"
},
"network": {
"$ref": "#/$defs/Network"
},
"predeploy": {
"items": {
"$ref": "#/$defs/PreDeployTask"
},
"type": "array"
},
"project": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Project Name",
"type": "string"
},
"role": {
"$ref": "#/$defs/RoleRef"
},
"services": {
"items": {
"$ref": "#/$defs/Service"
},
"type": "array"
},
"settings": {
"$ref": "#/$defs/Settings"
},
"stage": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Stage Name",
"type": "string"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"task_defaults": {
"$ref": "#/$defs/TaskDefaults"
}
},
"required": [
"project",
"cluster"
],
"title": "JSON Schema for ECS Deployer configuration file",
"type": "object"
} | MIT | en |
ecsdeployer/ecsdeployer | ce3c1a7bc218e7fdcef52961592cc7d03ac9ebb7 | 2023-01-16T04:30:07 | www/docs/static/schema.json | 7 | 2024-05-27T06:55:04.899506Z | {
"$defs": {
"AwsLogConfig": {
"oneOf": [
{
"description": "Enable or disable logging to AWS using default values",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"retention": {
"$ref": "#/$defs/LogRetention"
}
},
"type": "object"
}
]
},
"CPUShares": {
"description": "Specify CPU Resources",
"oneOf": [
{
"description": "CPU Shares",
"minimum": 0,
"type": "integer"
},
{
"description": "CPU Shares or vCPUs",
"type": "string"
}
]
},
"ClusterRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"ConsoleTask": {
"oneOf": [
{
"description": "Enable or disable remote shell",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"enabled": {
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"path": {
"type": "string"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"type": "object"
}
]
},
"CronJob": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"bus": {
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"description": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"schedule": {
"examples": [
"cron(0 9 * * ? *)",
"rate(1 hour)",
"rate(2 hours)"
],
"minLength": 5,
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"required": [
"schedule",
"name"
],
"type": "object"
},
"DependsOn": {
"oneOf": [
{
"properties": {
"condition": {
"default": "START",
"enum": [
"START",
"COMPLETE",
"SUCCESS",
"HEALTHY"
],
"type": "string"
},
"name": {
"minLength": 1,
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]+$",
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
{
"description": "'container:CONDITION' format",
"pattern": "^[-_a-zA-Z0-9]+(:[a-zA-Z]+)?$",
"type": "string"
}
]
},
"Duration": {
"oneOf": [
{
"description": "Seconds",
"minimum": 0,
"type": "integer"
},
{
"description": "Duration specified in shorthand",
"examples": [
"5m",
"4m2s",
"2h",
"2h10m5s"
],
"pattern": "^[+]?([0-9]*(\\.[0-9]*)?[a-z]+)+$",
"type": "string"
}
]
},
"EcsDeployerOptions": {
"additionalProperties": false,
"properties": {
"allowed_account_id": {
"description": "Restrict to a specific AWS account ID.",
"oneOf": [
{
"pattern": "^[0-9]{12,}$",
"type": "string"
},
{
"type": "integer"
}
]
},
"required_version": {
"$ref": "#/$defs/VersionConstraint",
"description": "Create a version constraint to prevent different versions of ECS Deployer from deploying this app."
}
},
"type": "object"
},
"EnvVar": {
"oneOf": [
{
"$comment": "Pull a secret from an SSM Parameter",
"additionalProperties": false,
"properties": {
"ssm": {
"minLength": 1,
"type": "string"
}
},
"required": [
"ssm"
],
"type": "object"
},
{
"$comment": "Construct value using a template",
"additionalProperties": false,
"properties": {
"template": {
"minLength": 1,
"type": "string"
}
},
"required": [
"template"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"additionalProperties": false,
"properties": {
"value": {
"$ref": "#/$defs/StringLikeWithBlank"
}
},
"required": [
"value"
],
"type": "object"
},
{
"$comment": "Unsets any value that was defined previously",
"additionalProperties": false,
"properties": {
"unset": {
"const": true,
"type": "boolean"
}
},
"required": [
"unset"
],
"type": "object"
},
{
"$comment": "Use a value verbatim",
"$ref": "#/$defs/StringLikeWithBlank"
}
]
},
"EnvVarMap": {
"additionalProperties": false,
"patternProperties": {
"^[a-zA-Z_][^=]*$": {
"$ref": "#/$defs/EnvVar"
}
},
"type": "object"
},
"FirelensAwsLogGroup": {
"description": "Should logs for firelens be sent to a log group",
"oneOf": [
{
"const": false,
"description": "Do not log to AWSLogs",
"type": "boolean"
},
{
"description": "Send logs to this log group",
"minLength": 2,
"type": "string"
}
]
},
"FirelensConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"container_name": {
"default": "log_router",
"type": "string"
},
"credentials": {
"type": "string"
},
"disabled": {
"type": "boolean"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"inherit_env": {
"type": "boolean"
},
"log_to_awslogs": {
"$ref": "#/$defs/FirelensAwsLogGroup"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
},
"type": {
"default": "fluentbit",
"enum": [
"fluentbit",
"fluentd"
],
"type": "string"
}
},
"type": "object"
}
]
},
"HealthCheck": {
"additionalProperties": false,
"properties": {
"command": {
"items": {
"type": "string"
},
"type": "array"
},
"interval": {
"$ref": "#/$defs/Duration"
},
"retries": {
"type": "integer"
},
"start_period": {
"$ref": "#/$defs/Duration"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"required": [
"command"
],
"type": "object"
},
"ImageUri": {
"oneOf": [
{
"additionalProperties": false,
"oneOf": [
{
"required": [
"ecr",
"tag"
]
},
{
"required": [
"ecr",
"digest"
]
},
{
"required": [
"docker",
"tag"
]
},
{
"required": [
"docker",
"digest"
]
}
],
"properties": {
"digest": {
"title": "Image digest",
"type": "string"
},
"docker": {
"title": "Dockerhub Repo URI",
"type": "string"
},
"ecr": {
"title": "Just the ECR Repository name",
"type": "string"
},
"tag": {
"title": "Image tag",
"type": "string"
}
},
"type": "object"
},
{
"examples": [
"myorg/myapp:latest",
"myorg/myapp@sha256:deadbeefdeadbeefdeadbeefdeadbeef",
"myorg/myapp:{{ .ImageTag }}"
],
"minLength": 2,
"title": "The full URI to your image",
"type": "string"
}
]
},
"KeepInSync": {
"oneOf": [
{
"description": "Set all fields on or off",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"cronjobs": {
"default": true,
"description": "Deletes cronjobs no longer referenced in stage file",
"type": "boolean"
},
"log_retention": {
"default": true,
"description": "Ensures that log groups have the correct retention period set",
"type": "boolean"
},
"services": {
"default": true,
"description": "Deletes services no longer referenced in stage file",
"type": "boolean"
},
"task_definitions": {
"default": true,
"description": "Deregisters old task definitions",
"type": "boolean"
}
},
"type": "object"
}
]
},
"LoadBalancer": {
"additionalProperties": false,
"properties": {
"grace": {
"$ref": "#/$defs/Duration"
},
"port": {
"$ref": "#/$defs/PortMapping"
},
"target_group": {
"$ref": "#/$defs/TargetGroupRef"
}
},
"required": [
"port",
"target_group"
],
"type": "object"
},
"LoadBalancers": {
"oneOf": [
{
"$ref": "#/$defs/LoadBalancer",
"description": "Default variant, just define a single load balancer mapping"
},
{
"description": "Define multiple load balancer mappings.",
"items": {
"$ref": "#/$defs/LoadBalancer"
},
"type": "array"
}
]
},
"LogRetention": {
"description": "How long to retain logs in CloudWatch logs",
"oneOf": [
{
"const": "forever",
"description": "Retain logs forever",
"type": "string"
},
{
"description": "The number of days to retain logs",
"pattern": "^[1-9][0-9]*$",
"type": "string"
},
{
"description": "The number of days to retain logs",
"minimum": 1,
"type": "integer"
}
]
},
"LoggingConfig": {
"oneOf": [
{
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"awslogs": {
"$ref": "#/$defs/AwsLogConfig"
},
"disabled": {
"type": "boolean"
},
"firelens": {
"$ref": "#/$defs/FirelensConfig"
}
},
"type": "object"
}
]
},
"Memory": {
"oneOf": [
{
"description": "Absolute or multiple of CPU",
"examples": [
"2048",
"2x",
"2 GB",
"0.5gb",
"x2"
],
"type": "string"
},
{
"description": "Absolute value in Megabytes",
"type": "integer"
}
],
"title": "Memory requirements"
},
"NameTemplates": {
"additionalProperties": false,
"properties": {
"container": {
"default": "{{ .Name }}",
"minLength": 1,
"type": "string"
},
"cron_group": {
"default": "ecsd:{{ .ProjectName }}{{ if .Stage }}:{{ .Stage }}{{end}}:cron:{{ .Name }}",
"type": "string"
},
"cron_rule": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-rule-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"cron_target": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"log_group": {
"default": "/ecsdeployer/app/{{ .ProjectName }}/{{ if .Stage }}{{ .Stage }}/{{end}}{{ .Name }}",
"minLength": 1,
"type": "string"
},
"log_stream_prefix": {
"default": "{{ .Name }}",
"minLength": 1,
"type": "string"
},
"marker_tag_key": {
"default": "ecsdeployer/project",
"minLength": 1,
"type": "string"
},
"marker_tag_value": {
"default": "{{ .ProjectName }}{{ if .Stage }}/{{ .Stage }}{{end}}",
"minLength": 1,
"type": "string"
},
"predeploy_group": {
"default": "ecsd:{{ .ProjectName }}{{ if .Stage }}:{{ .Stage }}{{end}}:pd:{{ .Name }}",
"type": "string"
},
"predeploy_started_by": {
"default": "ecsd:{{ .ProjectName }}{{ if .Stage }}:{{ .Stage }}{{end}}:deployer",
"type": "string"
},
"service_name": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"target_group": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-target-{{ .Name }}",
"minLength": 1,
"type": "string"
},
"task_family": {
"default": "{{ .ProjectName }}{{ if .Stage }}-{{ .Stage }}{{end}}-{{ .Name }}",
"minLength": 1,
"type": "string"
}
},
"type": "object"
},
"NameValuePair": {
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"$ref": "#/$defs/StringLike"
}
},
"required": [
"name",
"value"
],
"type": "object"
},
"Network": {
"additionalProperties": false,
"properties": {
"public_ip": {
"default": false,
"description": "Should the task be given a Public IP address?",
"type": "boolean"
},
"security_groups": {
"description": "List of SecurityGroupIds or SecurityGroup Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
},
"subnets": {
"description": "List of SubnetIds or Subnet Filters",
"items": {
"$ref": "#/$defs/NetworkFilter"
},
"type": "array"
}
},
"type": "object"
},
"NetworkFilter": {
"oneOf": [
{
"description": "Explicit ID",
"examples": [
"subnet-12345abcd",
"sg-12345abcd"
],
"pattern": "^[a-z]+-[a-f0-9]{3,}$",
"type": "string"
},
{
"description": "Filter shorthand",
"examples": [
"status=available",
"tag:key=value"
],
"pattern": "^([^=]+)=(([^,]+),?)+$",
"type": "string"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"value": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"value"
],
"type": "object"
},
{
"properties": {
"name": {
"minLength": 1,
"type": "string"
},
"values": {
"description": "String or array of strings",
"oneOf": [
{
"items": {
"type": "string"
},
"minItems": 1,
"type": "array"
},
{
"type": "string"
}
]
}
},
"required": [
"name",
"values"
],
"type": "object"
}
]
},
"PortMapping": {
"description": "Port specifications",
"oneOf": [
{
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"type": "integer"
},
"protocol": {
"default": "tcp",
"enum": [
"tcp",
"udp"
],
"type": "string"
}
},
"required": [
"port"
],
"type": "object"
},
{
"description": "Docker style port mapping",
"pattern": "^[0-9]+(/(tcp|udp))?$",
"type": "string"
},
{
"description": "Simple TCP Port",
"maximum": 65535,
"minimum": 1,
"type": "integer"
}
]
},
"PreDeployTask": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"disabled": {
"default": false,
"description": "Do not run this task",
"type": "boolean"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"ignore_failure": {
"default": false,
"description": "Ignore runtime failures of this task",
"type": "boolean"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"timeout": {
"$ref": "#/$defs/Duration",
"description": "Abort task after specified time has elapsed"
}
},
"required": [
"name"
],
"type": "object"
},
"RoleRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"RolloutConfig": {
"additionalProperties": false,
"properties": {
"max": {
"minimum": 0,
"type": "integer"
},
"min": {
"minimum": 0,
"type": "integer"
}
},
"required": [
"min",
"max"
],
"type": "object"
},
"SSMImport": {
"oneOf": [
{
"description": "if false, disable SSMImporting entirely. If true, use defaults",
"type": "boolean"
},
{
"description": "Enable SSM importing, with the value provided as the path to use.",
"pattern": "^\\/.+",
"type": "string"
},
{
"additionalProperties": false,
"properties": {
"enabled": {
"type": "boolean"
},
"path": {
"default": "/ecsdeployer/secrets/{{ .ProjectName }}{{ if .Stage }}/{{ .Stage }}{{ end }}",
"description": "Path to the SSM parameter root for your project. A trailing slash will be added.",
"type": "string"
},
"recursive": {
"default": true,
"description": "Whether we should recurse into deeper parameter levels",
"type": "boolean"
}
},
"type": "object"
}
]
},
"Service": {
"additionalProperties": false,
"properties": {
"arch": {
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"desired": {
"default": 0,
"minimum": 0,
"type": "integer"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"load_balancer": {
"$ref": "#/$defs/LoadBalancers"
},
"logging": {
"$ref": "#/$defs/TaskLoggingConfig"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"name": {
"pattern": "^[a-zA-Z][-_a-zA-Z0-9]*$",
"type": "string"
},
"network": {
"$ref": "#/$defs/Network"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"rollout": {
"$ref": "#/$defs/RolloutConfig"
},
"skip_wait_for_stable": {
"default": false,
"description": "Do not wait for service to become stable before marking it successful",
"type": "boolean"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"required": [
"desired",
"name"
],
"type": "object"
},
"Settings": {
"additionalProperties": false,
"properties": {
"disable_marker_tag": {
"type": "boolean"
},
"keep_in_sync": {
"$ref": "#/$defs/KeepInSync"
},
"predeploy_parallel": {
"type": "boolean"
},
"predeploy_timeout": {
"$ref": "#/$defs/Duration"
},
"skip_deployment_env_vars": {
"type": "boolean"
},
"ssm_import": {
"$ref": "#/$defs/SSMImport"
},
"wait_for_stable": {
"$ref": "#/$defs/WaitForStable"
}
},
"type": "object"
},
"ShellCommand": {
"oneOf": [
{
"$ref": "#/$defs/StringLikeWithBlank",
"description": "Shell-style command"
},
{
"description": "Command array. Preferred",
"items": {
"$ref": "#/$defs/StringLikeWithBlank"
},
"type": "array"
}
]
},
"SpotOverrides": {
"description": "Spot Capacity Overrides",
"oneOf": [
{
"properties": {
"enabled": {
"default": false,
"description": "Enable spot containers",
"type": "boolean"
},
"minimum_ondemand": {
"type": "integer"
},
"minimum_ondemand_percent": {
"type": "integer"
}
},
"type": "object"
},
{
"type": "boolean"
}
]
},
"Storage": {
"default": 20,
"description": "Size in GB of storage to add",
"minimum": 20,
"type": "integer"
},
"StringLike": {
"description": "Any value that can be cast to a string of at least one character long",
"oneOf": [
{
"minLength": 1,
"type": "string"
},
{
"type": [
"number",
"boolean"
]
}
]
},
"StringLikeWithBlank": {
"description": "Any value that can be cast to a string, or blank",
"type": [
"number",
"string",
"boolean"
]
},
"TargetGroupRef": {
"description": "ARN or Name",
"minLength": 1,
"type": "string"
},
"TaskDefaults": {
"additionalProperties": false,
"properties": {
"arch": {
"default": "amd64",
"description": "Task CPU Architecture",
"enum": [
"arm64",
"amd64"
],
"type": "string"
},
"command": {
"$ref": "#/$defs/ShellCommand"
},
"cpu": {
"$ref": "#/$defs/CPUShares"
},
"credentials": {
"type": "string"
},
"depends_on": {
"items": {
"$ref": "#/$defs/DependsOn"
},
"type": "array"
},
"entrypoint": {
"$ref": "#/$defs/ShellCommand"
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"healthcheck": {
"$ref": "#/$defs/HealthCheck"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"labels": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"memory": {
"$ref": "#/$defs/Memory"
},
"platform_version": {
"default": "LATEST",
"description": "Fargate Platform Version",
"type": "string"
},
"spot": {
"$ref": "#/$defs/SpotOverrides"
},
"start_timeout": {
"$ref": "#/$defs/Duration"
},
"stop_timeout": {
"$ref": "#/$defs/Duration"
},
"storage": {
"$ref": "#/$defs/Storage"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
}
},
"type": "object"
},
"TaskLoggingConfig": {
"oneOf": [
{
"const": false,
"description": "Disable logging",
"type": "boolean"
},
{
"description": "Inherit logging configuration",
"type": "null"
},
{
"additionalProperties": false,
"properties": {
"driver": {
"type": "string"
},
"options": {
"$ref": "#/$defs/EnvVarMap"
}
},
"type": "object"
}
]
},
"VersionConstraint": {
"$comment": "https://pkg.go.dev/github.com/Masterminds/semver/v3#readme-checking-version-constraints",
"description": "Specify a constraint on a semantic version",
"type": "string"
},
"WaitForStable": {
"oneOf": [
{
"description": "Enable or disable waiting for stability entirely",
"type": "boolean"
},
{
"additionalProperties": false,
"properties": {
"disabled": {
"type": "boolean"
},
"individually": {
"description": "Don't use this",
"type": "boolean"
},
"timeout": {
"$ref": "#/$defs/Duration"
}
},
"type": "object"
}
]
}
},
"$id": "https://ecsdeployer.com/ecsdeployer/pkg/config/project",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": false,
"properties": {
"cluster": {
"$ref": "#/$defs/ClusterRef"
},
"console": {
"$ref": "#/$defs/ConsoleTask"
},
"cron_launcher_role": {
"$ref": "#/$defs/RoleRef"
},
"cronjobs": {
"items": {
"$ref": "#/$defs/CronJob"
},
"type": "array"
},
"ecsdeployer": {
"$ref": "#/$defs/EcsDeployerOptions",
"description": "Add restrictions to ECSDeployer itself."
},
"environment": {
"$ref": "#/$defs/EnvVarMap"
},
"execution_role": {
"$ref": "#/$defs/RoleRef"
},
"image": {
"$ref": "#/$defs/ImageUri"
},
"logging": {
"$ref": "#/$defs/LoggingConfig"
},
"name_templates": {
"$ref": "#/$defs/NameTemplates"
},
"network": {
"$ref": "#/$defs/Network"
},
"predeploy": {
"items": {
"$ref": "#/$defs/PreDeployTask"
},
"type": "array"
},
"project": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Project Name",
"type": "string"
},
"role": {
"$ref": "#/$defs/RoleRef"
},
"services": {
"items": {
"$ref": "#/$defs/Service"
},
"type": "array"
},
"settings": {
"$ref": "#/$defs/Settings"
},
"stage": {
"pattern": "^[a-z][-a-z0-9]*$",
"title": "Stage Name",
"type": "string"
},
"tags": {
"items": {
"$ref": "#/$defs/NameValuePair"
},
"type": "array"
},
"task_defaults": {
"$ref": "#/$defs/TaskDefaults"
}
},
"required": [
"project",
"cluster"
],
"title": "JSON Schema for ECS Deployer configuration file",
"type": "object"
} | MIT | en |
trellisorg/platform | 467e16454cf394801cb51350fc523c80123ff64d | 2024-05-20T05:20:21 | packages/nx-ai-readme/src/executors/ai-readme/schema.json | 69 | 2024-05-28T05:37:19.215332Z | {
"$schema": "https://json-schema.org/schema",
"description": "",
"properties": {
"example": {
"description": "A link to an example README.md that should be used as additional context for the model to know what a good readme is to follow the format of, or a template you have hosted publicly. This should be a link to the raw text so an HTTP GET will return the raw markdown. Defaults to: https://raw.githubusercontent.com/othneildrew/Best-README-Template/master/BLANK_README.md",
"type": "string"
},
"include": {
"default": [],
"description": "Additional files to include as context to the readme generation, these could be files displaying usage of the library in a demo app, documentation files or other relevant files.",
"items": {
"type": "string"
},
"type": "array"
},
"instructions": {
"description": "Instructions to send along with the generation to ensure the model acts appropriately or includes additional context you want it to. This can be a link to a file or raw text. Will attempt to find a file (from workspace root) first, if it does not exist then the value will be used as the instructions. The file this points to should be raw text.",
"type": "string"
},
"pathToReadme": {
"default": "README.md",
"description": "The path to the readme file that will be written to when the generation is completed, this defaults to `{projectRoot}/package.json`",
"type": "string"
},
"projectFiles": {
"default": [
"**/*.ts",
"package.json"
],
"description": "An array of globs defining what files (relative to the project root) to include as part of the context for the project generation. This will default to: `['**/*.ts', 'package.json']`",
"type": "array"
}
},
"required": [],
"title": "AiReadme executor",
"type": "object",
"version": 2
} | MIT | en |
eclipse-tractusx/portal-backend | 83cd14feb81fa82b7baaf8ecf916b196507fb861 | 2024-03-11T10:19:13 | src/externalsystems/Dim.Library/Schemas/DidDocument.schema.json | 7 | 2024-05-27T05:30:44.263543Z | {
"$id": "https://eclipse-tractusx.github.io/DidDocument.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"properties": {
"@context": {
"const": [
"https://www.w3.org/ns/did/v1",
"https://w3id.org/security/suites/ed25519-2020/v1"
],
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"services": {
"additionalProperties": true,
"items": {
"properties": {
"id": {
"items": {
"type": "string"
},
"type": "array"
},
"serviceEndpoint": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"verificationMethod": {
"items": {
"additionalProperties": true,
"properties": {
"id": {
"items": {
"type": "string"
},
"type": "array"
},
"publicKeyJwk": {
"additionalProperties": true,
"properties": {
"crv": {
"type": "string"
},
"kty": {
"type": "string"
},
"x": {
"type": "string"
}
},
"required": [
"kty",
"crv",
"x"
],
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type",
"publicKeyJwk"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"@context",
"verificationMethod",
"services"
],
"type": "object"
} | Apache-2.0 | en |
eclipse-tractusx/portal-backend | 4589b9f9e3faec646d3e912294498b02f9ea9162 | 2024-04-19T13:46:35 | src/externalsystems/Dim.Library/Schemas/DidDocument.schema.json | 7 | 2024-05-27T05:30:44.263543Z | {
"$id": "https://eclipse-tractusx.github.io/DidDocument.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"additionalProperties": true,
"properties": {
"@context": {
"const": [
"https://www.w3.org/ns/did/v1"
],
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"services": {
"additionalProperties": true,
"items": {
"properties": {
"id": {
"type": "string"
},
"serviceEndpoint": {
"type": "string"
},
"type": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"verificationMethod": {
"items": {
"additionalProperties": true,
"properties": {
"id": {
"type": "string"
},
"publicKeyJwk": {
"additionalProperties": true,
"properties": {
"crv": {
"type": "string"
},
"kty": {
"type": "string"
},
"x": {
"type": "string"
},
"y": {
"type": "string"
}
},
"required": [
"kty",
"crv",
"x",
"y"
],
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type",
"publicKeyJwk"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"id",
"@context",
"verificationMethod",
"services"
],
"type": "object"
} | Apache-2.0 | en |
eclipse-tractusx/portal-backend | b47524284863ffad40c6eec7570003b6773201cf | 2024-04-22T06:10:40 | src/externalsystems/Dim.Library/Schemas/DidDocument.schema.json | 7 | 2024-05-27T05:30:44.263543Z | {
"$id": "https://eclipse-tractusx.github.io/DidDocument.schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"@context": {
"const": [
"https://www.w3.org/ns/did/v1"
],
"items": {
"type": "string"
},
"type": "array"
},
"assertionMethod": {
"items": {
"type": "string"
},
"type": "array"
},
"authentication": {
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"type": "string"
},
"keyAgreement": {
"items": {
"type": "string"
},
"type": "array"
},
"service": {
"items": {
"properties": {
"id": {
"type": "string"
},
"serviceEndpoint": {
"type": "string"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type"
],
"type": "object"
},
"type": "array"
},
"verificationMethod": {
"items": {
"properties": {
"controller": {
"type": "string"
},
"id": {
"type": "string"
},
"publicKeyJwk": {
"properties": {
"crv": {
"type": "string"
},
"kty": {
"type": "string"
},
"x": {
"type": "string"
},
"y": {
"type": "string"
}
},
"required": [
"kty",
"crv",
"x",
"y"
],
"type": "object"
},
"type": {
"type": "string"
}
},
"required": [
"id",
"type",
"publicKeyJwk"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"@context",
"id",
"service",
"verificationMethod"
],
"type": "object"
} | Apache-2.0 | en |
sugyan/shogi-kifu-converter | 1d9e39b44adc66e66deb2ba815c7318f1f1c044f | 2022-07-23T06:39:57 | data/specification/json-kifu-format.schema.json | 7 | 2024-05-27T06:39:14.073823Z | {
"$defs": {
"board": {
"items": {
"$ref": "#/$defs/column"
},
"title": "\u76e4",
"type": "array"
},
"capturablekind": {
"description": "kind\u306e\u90e8\u5206\u96c6\u5408\u3067\u3042\u308b\u3002",
"enum": [
"FU",
"KY",
"KE",
"GI",
"KI",
"KA",
"HI",
"TO",
"NY",
"NK",
"NG",
"UM",
"RY"
],
"title": "\u6301\u99d2\u306b\u52a0\u3048\u308b\u3053\u3068\u304c\u3067\u304d\u308b\u99d2\u306e\u7a2e\u985e"
},
"color": {
"description": "\u5148\u624b\uff1a0\u3001\u5f8c\u624b\uff1a1",
"enum": [
0,
1
],
"title": "\u9663\u55b6"
},
"column": {
"items": {
"$ref": "#/$defs/square"
},
"title": "\u76e4\u306e\u5217",
"type": "array"
},
"comments": {
"oneOf": [
{
"type": "null"
},
{
"items": {
"type": "string"
},
"type": "array"
}
],
"title": "\u30b3\u30e1\u30f3\u30c8"
},
"consumption": {
"additionalProperties": false,
"properties": {
"now": {
"$ref": "#/$defs/time",
"description": "1\u624b"
},
"total": {
"$ref": "#/$defs/time",
"description": "\u5408\u8a08"
}
},
"required": [
"now",
"total"
],
"title": "\u6d88\u8cbb\u6642\u9593",
"type": [
"object",
"null"
]
},
"fork": {
"items": {
"$ref": "#/$defs/moveWithForksAndInfo"
},
"title": "\u5206\u5c90",
"type": "array"
},
"forks": {
"items": {
"$ref": "#/$defs/fork"
},
"title": "\u5206\u5c90\u7fa4",
"type": [
"array",
"null"
]
},
"hand": {
"additionalProperties": false,
"properties": {
"FU": {
"type": "integer"
},
"GI": {
"type": "integer"
},
"HI": {
"type": "integer"
},
"KA": {
"type": "integer"
},
"KE": {
"type": "integer"
},
"KI": {
"type": "integer"
},
"KY": {
"type": "integer"
},
"NG": {
"type": "integer"
},
"NK": {
"type": "integer"
},
"NY": {
"type": "integer"
},
"OU": {
"type": "integer"
},
"RY": {
"type": "integer"
},
"TO": {
"type": "integer"
},
"UM": {
"type": "integer"
}
},
"title": "\u6301\u99d2",
"type": "object"
},
"hands": {
"items": {
"$ref": "#/$defs/hand",
"description": "\u99d2\u7a2e\u304ckey, \u679a\u6570\u304cvalue\u306e\u9023\u60f3\u914d\u5217"
},
"maxItems": 2,
"minItems": 2,
"title": "\u5148\u5f8c\u53cc\u65b9\u306e\u6301\u99d2",
"type": "array"
},
"header": {
"additionalProperties": {
"type": "string"
},
"title": "\u30d8\u30c3\u30c0\u60c5\u5831",
"type": "object"
},
"initial": {
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/$defs/initialData",
"description": "\u521d\u671f\u5c40\u9762\u30c7\u30fc\u30bf\u3002\u624b\u5408\u540d\u304cOTHER\u306e\u6642\u306b\u4f7f\u7528\u3059\u308b"
},
"preset": {
"$ref": "#/$defs/preset",
"description": "\u624b\u5408\u540d"
}
},
"required": [
"preset"
],
"title": "\u521d\u671f\u72b6\u614b",
"type": [
"object",
"null"
]
},
"initialBoard": {
"oneOf": [
{
"additionalProperties": false,
"description": "\u99d2\u304c\u306a\u3044\u5834\u5408",
"type": "object"
},
{
"$ref": "#/$defs/board",
"description": "\u76e4\u4e0a\u306e\u99d2\u3002board[x-1][y-1]\u306b(x,y)\u306e\u99d2\u60c5\u5831"
}
],
"title": "\u521d\u671f\u72b6\u614b\u306e\u76e4\u9762"
},
"initialComment": {
"properties": {
"comment": {
"type": "string"
}
},
"title": "\u521d\u671f\u5c40\u9762\u306e\u30b3\u30e1\u30f3\u30c8",
"type": "object"
},
"initialData": {
"properties": {
"board": {
"$ref": "#/$defs/initialBoard",
"description": "\u76e4\u4e0a\u306e\u99d2\u306e\u914d\u7f6e"
},
"color": {
"$ref": "#/$defs/color",
"description": "\u521d\u624b\u306e\u624b\u756a"
},
"hands": {
"$ref": "#/$defs/hands",
"description": "0\u756a\u76ee\u304c\u5148\u624b\uff0c1\u756a\u76ee\u304c\u5f8c\u624b\u306e\u6301\u99d2"
}
},
"required": [
"color",
"board",
"hands"
],
"title": "\u521d\u671f\u5c40\u9762\u306e\u30c7\u30fc\u30bf",
"type": [
"object",
"null"
]
},
"kind": {
"description": "CSA\u6a19\u6e96\u68cb\u8b5c\u30d5\u30a1\u30a4\u30eb\u5f62\u5f0f (V2.2) \u306e\u8868\u8a18\u3092\u4f7f\u7528\u3057\u3066\u3044\u308b\u3002",
"enum": [
"FU",
"KY",
"KE",
"GI",
"KI",
"KA",
"HI",
"OU",
"TO",
"NY",
"NK",
"NG",
"UM",
"RY"
],
"title": "\u99d2\u306e\u7a2e\u985e"
},
"move": {
"additionalProperties": false,
"properties": {
"capture": {
"description": "\u53d6\u3063\u305f\u99d2\u306e\u7a2e\u985e",
"oneOf": [
{
"$ref": "#/$defs/capturablekind"
},
{
"type": "null"
}
]
},
"color": {
"$ref": "#/$defs/color",
"description": "\u5148\u624b/\u5f8c\u624b"
},
"from": {
"description": "\u79fb\u52d5\u5143\u3002\u6253\u3063\u305f\u5834\u5408\u306f\u306a\u3057",
"oneOf": [
{
"$ref": "#/$defs/placeFormat"
},
{
"type": "null"
}
]
},
"piece": {
"$ref": "#/$defs/kind",
"description": "\u99d2\u306e\u7a2e\u985e"
},
"promote": {
"description": "\u6210\u308b\u304b\u3069\u3046\u304b\u3002true:\u6210, false:\u4e0d\u6210, \u7121\u3044\u304bnull:\u3069\u3061\u3089\u3067\u3082\u306a\u3044",
"type": [
"boolean",
"null"
]
},
"relative": {
"description": "\u76f8\u5bfe\u60c5\u5831",
"oneOf": [
{
"$ref": "#/$defs/relative"
},
{
"type": "null"
}
]
},
"same": {
"description": "\u76f4\u524d\u3068\u540c\u3058\u5834\u5408",
"type": [
"boolean",
"null"
]
},
"to": {
"$ref": "#/$defs/placeFormat",
"description": "\u79fb\u52d5\u5148"
}
},
"required": [
"color",
"to",
"piece"
],
"title": "\u6307\u3057\u624b",
"type": [
"object",
"null"
]
},
"moveWithForksAndInfo": {
"additionalProperties": false,
"properties": {
"comments": {
"$ref": "#/$defs/comments",
"description": "\u30b3\u30e1\u30f3\u30c8"
},
"forks": {
"$ref": "#/$defs/forks",
"description": "\u5206\u5c90\u3002\u4efb\u610f\u306e\u9577\u3055\u306e\u5206\u5c90\u3092\u4efb\u610f\u500b\u683c\u7d0d\u3059\u308b\uff0e\u5206\u5c90\u306e\u521d\u624b\u306f\u3053\u306eforks\u3092\u6301\u3064\u68cb\u8b5c\u306e\u4ee3\u66ff\u306e\u624b\u3068\u3059\u308b(\u6b21\u306e\u624b\u3067\u306f\u306a\u304f)"
},
"move": {
"$ref": "#/$defs/move",
"description": "\u99d2\u306e\u52d5\u304d"
},
"special": {
"$ref": "#/$defs/special",
"description": "\u7279\u6b8a\u68cb\u8b5c\u3002\u305d\u308c\u305e\u308c\u306e\u610f\u5473\u306fCSA\u6a19\u6e96\u68cb\u8b5c\u30d5\u30a1\u30a4\u30eb\u5f62\u5f0f (V2.2) \u306b\u6e96\u62e0\u3059\u308b\u3002"
},
"time": {
"$ref": "#/$defs/consumption",
"description": "\u6d88\u8cbb\u6642\u9593"
}
},
"title": "\u6307\u3057\u624b",
"type": "object"
},
"moves": {
"items": {
"$ref": "#/$defs/moveWithForksAndInfo"
},
"prefixItems": [
{
"$ref": "#/$defs/initialComment"
}
],
"title": "\u6307\u3057\u624b\u306e\u30ea\u30b9\u30c8",
"type": "array"
},
"placeFormat": {
"additionalProperties": false,
"properties": {
"x": {
"description": "1\u304b\u30899",
"type": "integer"
},
"y": {
"description": "\u4e00\u304b\u3089\u4e5d",
"type": "integer"
}
},
"required": [
"x",
"y"
],
"title": "\u5ea7\u6a19",
"type": "object"
},
"preset": {
"description": "KIF\u3067\u30b5\u30dd\u30fc\u30c8\u3055\u308c\u3066\u3044\u308b\u624b\u5408\u60c5\u5831\u3002\u9806\u306b\u3001\u5e73\u624b\u3001\u9999\u843d\u3061\u3001\u53f3\u9999\u843d\u3061\u3001\u89d2\u843d\u3061\u3001\u98db\u8eca\u843d\u3061\u3001\u98db\u9999\u843d\u3061\u3001\u4e8c\u679a\u843d\u3061\u3001\u4e09\u679a\u843d\u3061\u3001\u56db\u679a\u843d\u3061\u3001\u4e94\u679a\u843d\u3061\u3001\u5de6\u4e94\u679a\u843d\u3061\u3001\u516d\u679a\u843d\u3061\u3001\u5de6\u4e03\u679a\u843d\u3061\u3001\u53f3\u4e03\u679a\u843d\u3061\u3001\u516b\u679a\u843d\u3061\u3001\u5341\u679a\u843d\u3061\u3001\u305d\u306e\u4ed6\u3001\u3092\u8868\u3059\u3002",
"enum": [
"HIRATE",
"KY",
"KY_R",
"KA",
"HI",
"HIKY",
"2",
"3",
"4",
"5",
"5_L",
"6",
"7_L",
"7_R",
"8",
"10",
"OTHER"
],
"title": "\u624b\u5408\u60c5\u5831"
},
"record": {
"additionalProperties": false,
"properties": {
"header": {
"$ref": "#/$defs/header",
"description": "\u30d8\u30c3\u30c0\u60c5\u5831\u3002\u30ad\u30fc\u306fKI2\uff0cKIF\u7b49\u306e\u65e5\u672c\u8a9e\u306e\u3082\u306e\u306b\u6e96\u305a\u308b\uff0e(\u4f8b: \"\u5834\u6240\", \"\u5148\u624b\")"
},
"initial": {
"$ref": "#/$defs/initial",
"description": "\u521d\u671f\u5c40\u9762\u3002null\u306e\u5834\u5408\u306f\u5e73\u624b\u3092\u8868\u3059"
},
"moves": {
"$ref": "#/$defs/moves",
"description": "n\u756a\u76ee\u306fn\u624b\u76ee\u306e\u68cb\u8b5c(0\u756a\u76ee\u306f\u521d\u671f\u5c40\u9762\u306e\u30b3\u30e1\u30f3\u30c8\u7528)\u3002"
}
},
"required": [
"header",
"moves"
],
"title": "json-kifu-format",
"type": "object"
},
"relative": {
"pattern": "[LCR]|[UMD]|[LCR][UD]|[LR]M|H",
"title": "\u76f8\u5bfe\u60c5\u5831",
"type": "string"
},
"special": {
"enum": [
"TORYO",
"CHUDAN",
"SENNICHITE",
"TIME_UP",
"ILLEGAL_MOVE",
"+ILLEGAL_ACTION",
"-ILLEGAL_ACTION",
"JISHOGI",
"KACHI",
"HIKIWAKE",
"MATTA",
"TSUMI",
"FUZUMI",
"ERROR",
null
],
"title": "\u7279\u6b8a\u68cb\u8b5c"
},
"square": {
"additionalProperties": false,
"properties": {
"color": {
"description": "\u5148\u624b/\u5f8c\u624b",
"oneOf": [
{
"$ref": "#/$defs/color"
},
{
"type": "null"
}
]
},
"kind": {
"description": "\u99d2\u306e\u7a2e\u985e",
"oneOf": [
{
"$ref": "#/$defs/kind"
},
{
"type": "null"
}
]
}
},
"title": "\u76e4\u306e\u5347",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"h": {
"description": "\u6642",
"type": [
"integer",
"null"
]
},
"m": {
"description": "\u5206",
"type": "integer"
},
"s": {
"description": "\u79d2",
"type": "integer"
}
},
"required": [
"m",
"s"
],
"title": "\u6642\u9593",
"type": "object"
}
},
"$id": "https://github.com/na2hiro/json-kifu-format",
"$ref": "#/$defs/record",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | MIT | ja |
appgate/sdp-operator | 674880ff2ac7dd60ec6470845ea345d993657993 | 2024-04-02T20:07:55 | k8s/crd/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17",
"v18",
"v19",
"v20"
],
"type": "string"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | c45cadd56944bb69eb8f5a9f6d37050b3ee8de36 | 2022-12-19T08:06:12 | k8s/crd/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17",
"v18"
],
"type": "string"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | 77339e8fba7f32bf43abf6302011d2678b821be8 | 2023-02-09T19:45:40 | k8s/operator/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"sdp": {
"properties": {
"operator": {
"properties": {
"builtinTags": {
"items": {
"type": "string"
},
"type": "array"
},
"caCert": {
"type": "string"
},
"configMapMt": {
"type": "string"
},
"deviceId": {
"type": "string"
},
"excludeTags": {
"items": {
"type": "string"
},
"type": "array"
},
"fernetKey": {
"type": "string"
},
"gitSync": {
"properties": {
"git": {
"properties": {
"baseBranch": {
"type": "string"
},
"repositoryUrl": {
"type": "string"
},
"secret": {
"type": "string"
},
"vendor": {
"enum": [
"github"
],
"type": "string"
}
},
"type": "object"
},
"github": {
"properties": {
"repository": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"host": {
"type": "string"
},
"logLevel": {
"enum": [
"info",
"debug",
"trace"
],
"type": "string"
},
"mode": {
"enum": [
"run",
"git-sync"
],
"type": "string"
},
"run": {
"properties": {
"cleanup": {
"type": "boolean"
},
"dryRun": {
"type": "boolean"
},
"twoWaySync": {
"type": "boolean"
}
},
"type": "object"
},
"sslNoVerify": {
"type": "boolean"
},
"targetTags": {
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"type": "number"
},
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17",
"v18"
],
"type": "string"
}
},
"required": [
"deviceId",
"host",
"version",
"mode"
],
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | 95047508a297d6457279e64d8052a952711aaa85 | 2023-08-02T14:22:06 | k8s/crd/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17",
"v18",
"v19"
],
"type": "string"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | 4a6d4f78da953d0d9e593e9b6dd068afba4e87ac | 2023-02-09T19:46:03 | k8s/operator/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"sdp": {
"properties": {},
"type": "object"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | c45cadd56944bb69eb8f5a9f6d37050b3ee8de36 | 2022-12-19T08:06:12 | k8s/operator/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"sdp": {
"properties": {
"operator": {
"properties": {
"builtinTags": {
"items": {
"type": "string"
},
"type": "array"
},
"caCert": {
"type": "string"
},
"cleanup": {
"type": "boolean"
},
"configMapMt": {
"type": "string"
},
"deviceId": {
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"excludeTags": {
"items": {
"type": "string"
},
"type": "array"
},
"fernetKey": {
"type": "string"
},
"host": {
"type": "string"
},
"logLevel": {
"enum": [
"info",
"debug",
"trace"
],
"type": "string"
},
"sslNoVerify": {
"type": "boolean"
},
"targetTags": {
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"type": "number"
},
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17",
"v18"
],
"type": "string"
}
},
"required": [
"deviceId",
"host",
"version"
],
"type": "object"
},
"rbac": {
"properties": {
"create": {
"type": "boolean"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | 543a8f62b4715bf5b3775f13344dcf0ee3c3c41f | 2022-07-18T14:11:22 | k8s/operator/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"sdp": {
"properties": {
"operator": {
"properties": {
"builtinTags": {
"type": "string"
},
"caCert": {
"type": "string"
},
"cleanup": {
"type": "boolean"
},
"configMapMt": {
"type": "string"
},
"deviceId": {
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"excludeTags": {
"type": "string"
},
"fernetKey": {
"type": "string"
},
"host": {
"type": "string"
},
"logLevel": {
"enum": [
"info",
"debug",
"trace"
],
"type": "string"
},
"sslNoVerify": {
"type": "boolean"
},
"targetTags": {
"type": "string"
},
"timeout": {
"type": "number"
},
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17"
],
"type": "string"
}
},
"required": [
"deviceId",
"host",
"version"
],
"type": "object"
},
"rbac": {
"properties": {
"create": {
"type": "boolean"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | c57bccf140a36ad540e9b5b41a88403ba21035b0 | 2022-07-01T13:44:38 | k8s/crd/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17"
],
"type": "string"
}
},
"type": "object"
} | MIT | en |
appgate/sdp-operator | 99d6ad7f121d23c74475fc6482c010149e6bdbcd | 2022-07-20T13:44:00 | k8s/operator/values.schema.json | 10 | 2024-05-28T05:54:05.944702Z | {
"$schema": "https://json-schema.org/draft/2019-09/schema",
"properties": {
"sdp": {
"properties": {
"operator": {
"properties": {
"builtinTags": {
"items": {
"type": "string"
},
"type": "array"
},
"caCert": {
"type": "string"
},
"cleanup": {
"type": "boolean"
},
"configMapMt": {
"type": "string"
},
"deviceId": {
"type": "string"
},
"dryRun": {
"type": "boolean"
},
"excludeTags": {
"items": {
"type": "string"
},
"type": "array"
},
"fernetKey": {
"type": "string"
},
"host": {
"type": "string"
},
"logLevel": {
"enum": [
"info",
"debug",
"trace"
],
"type": "string"
},
"sslNoVerify": {
"type": "boolean"
},
"targetTags": {
"items": {
"type": "string"
},
"type": "array"
},
"timeout": {
"type": "number"
},
"version": {
"enum": [
"v14",
"v15",
"v16",
"v17"
],
"type": "string"
}
},
"required": [
"deviceId",
"host",
"version"
],
"type": "object"
},
"rbac": {
"properties": {
"create": {
"type": "boolean"
}
},
"type": "object"
},
"serviceAccount": {
"properties": {
"create": {
"type": "boolean"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
heinemannj/home-assistant-config | 76ee64b6d9f540c6815cd13b0f059905613667ba | 2023-05-09T04:01:31 | custom_components/powercalc/data/model_schema.json | 14 | 2024-05-27T05:28:11.755098Z | {
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "model.json describes a number of devices, typically lights, for use within the HomeAssistant Powercalc extension.",
"properties": {
"aliases": {
"description": "Aliases for this model",
"items": {
"type": "string"
},
"type": "array"
},
"calculation_enabled_condition": {
"description": "Template which can be evaluated.",
"type": "string"
},
"calculation_strategy": {
"description": "Supported calculation modes",
"enum": [
"lut",
"linear",
"fixed"
],
"type": "string"
},
"config_flow_discovery_remarks": {
"description": "Some remarks to show in the GUI config flow on first step of discovery",
"type": "string"
},
"device_type": {
"description": "Type of device",
"enum": [
"light",
"smart_switch",
"smart_speaker"
],
"type": "string"
},
"fixed_config": {
"description": "Configuration for fixed calculation mode",
"properties": {
"power": {
"type": "number"
},
"states_power": {
"additionalProperties": {
"type": [
"number",
"string"
]
},
"description": "A dict of state attributes and the power. See https://github.com/bramstroker/homeassistant-powercalc#power-per-state.",
"properties": {
"idle": {
"type": [
"number",
"string"
]
},
"off": {
"type": [
"number",
"string"
]
},
"paused": {
"type": [
"number",
"string"
]
},
"playing": {
"type": [
"number",
"string"
]
},
"unavailable": {
"type": [
"number",
"string"
]
}
},
"type": "object"
}
},
"type": "object"
},
"linear_config": {
"description": "Configuration for linear calculation mode",
"properties": {
"calibrate": {
"items": {
"type": "string"
},
"type": "array"
},
"max_power": {
"type": "number"
},
"min_power": {
"type": "number"
}
},
"type": "object"
},
"linked_lut": {
"description": "Use LUT data files from another model",
"type": "string"
},
"measure_description": {
"description": "Add more information about how you measured the device or any remarks",
"type": "string"
},
"measure_device": {
"description": "Device which was used to measure",
"type": "string"
},
"measure_method": {
"description": "How the device was measured",
"enum": [
"manual",
"script"
],
"type": "string"
},
"measure_settings": {
"description": "Settings used for measure script",
"type": "object"
},
"name": {
"description": "The full name",
"type": "string"
},
"sensor_config": {
"description": "Sensor configuration options. See the README",
"type": "object"
},
"standby_power": {
"description": "Power draw when the device is turned off. When you are not able to measure set to 0.4 for lights",
"minimum": 0.05,
"type": "number"
},
"standby_power_on": {
"description": "Power draw when the device is turned on.",
"minimum": 0.05,
"type": "number"
},
"sub_profile_select": {
"description": "Configuration to automatically select a sub profile",
"properties": {
"default": {
"description": "Default profile to select when non of the matchers apply",
"type": "string"
},
"matchers": {
"description": "List of matchers which will be checked",
"items": {
"properties": {
"attribute": {
"type": "string"
},
"map": {
"type": "object"
},
"pattern": {
"type": "string"
},
"profile": {
"type": "string"
},
"type": {
"enum": [
"attribute",
"entity_id",
"entity_state"
]
}
},
"required": [
"type"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"default",
"matchers"
],
"type": "object"
}
},
"required": [
"name",
"standby_power",
"measure_method",
"measure_device",
"calculation_strategy"
],
"type": "object"
} | MIT | en |
MovieLabs/OMC | 412b578a8008506f6edf3f4f4ee89c86061ae2fd | 2023-12-04T21:29:30 | OMC-JSON/OMC-JSON-v2.0.schema.json | 6 | 2024-05-27T04:54:55.691858Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Asset": {
"additionalProperties": false,
"properties": {
"Asset": {
"additionalProperties": false,
"description": "A physical or digital object or collection of objects specific to the creation of the Creative Work.",
"properties": {
"Asset": {
"description": "The set of Assets that make up an an asset group and has a structuralType of 'assetGroup'",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"title": "Asset Group",
"type": [
"array",
"null"
]
},
"AssetSC": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
],
"title": "Structural Characteristics"
},
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"assetFC": {
"$ref": "#/$defs/Asset/properties/assetFC",
"title": "Asset Functional Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Asset",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"Alternative": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"Derivation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Asset Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset",
"type": [
"object"
]
},
"AssetSC": {
"$defs": {
"assetGroup": {
"additionalProperties": false,
"description": "Structural properties of an Asset Group",
"properties": {
"isOrdered": {
"type": [
"boolean",
"null"
]
}
},
"title": "Asset Group",
"type": "object"
},
"dimensions": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/dimensions"
},
"fileDetails": {
"additionalProperties": false,
"description": "Where opaque identifiers are used it can be useful to express naming for use in traditional file systems",
"properties": {
"fileExtension": {
"type": [
"string",
"null"
]
},
"fileName": {
"type": [
"string",
"null"
]
},
"filePath": {
"type": [
"string",
"null"
]
},
"mediaType": {
"type": [
"string",
"null"
]
}
},
"title": "File Details",
"type": "object"
},
"linkset": {
"additionalProperties": false,
"description": "When used with resolution system returning a linkset additional information can help disambiguate multiple linksets in the response.",
"properties": {
"mediaType": {
"type": [
"string",
"null"
]
},
"recordType": {
"type": [
"string",
"null"
]
}
},
"title": "Linkset",
"type": "object"
}
},
"additionalProperties": false,
"description": "Describes the form of an Asset along with the attributes specific to that asset\u2019s form",
"properties": {
"Carrier": {
"description": "For describing the physical storage device on which the digital assence is stored",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
}
],
"title": "Carrier"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the participant",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "AssetSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"isAnalog": {
"description": "True if the Asset is an Analog Asset.",
"title": "Is Analog",
"type": [
"boolean",
"null"
]
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": false,
"description": "A set of properties that describe the asset in this form",
"properties": {
"assetGroup": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/assetGroup"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"dimensions": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/dimensions"
},
"fileDetails": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/fileDetails"
},
"linkset": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/linkset"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Deriviation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"Representation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RepresentationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Asset Structural Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset Structural Characteristics",
"type": "object"
},
"assetFC": {
"$defs": {
"empty": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"type": "object"
},
"generic": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"functionalType": {
"not": {
"enum": [
"scd"
]
},
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
},
"scd": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": false,
"properties": {
"component": {
"items": {
"properties": {
"Shot": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"type": "object"
},
"duration": {
"type": [
"string",
"null"
]
},
"recordEnd": {
"type": [
"string",
"null"
]
},
"recordStart": {
"type": [
"string",
"null"
]
},
"sourceEnd": {
"type": [
"string",
"null"
]
},
"sourceStart": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"functionalType": {
"const": "scd",
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
}
},
"description": "Describes the use or purpose of an Asset within the production process",
"oneOf": [
{
"description": "Allow for null",
"type": "null"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/empty",
"title": "Allow for empty object, no functional characteristics"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/generic",
"title": "A generic schema allowing any functional type and properties"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/scd",
"title": "Functional characteristics for a Sequence Chronology Descriptor"
}
],
"title": "Asset Functional Characteristics"
}
},
"title": "Asset Definitions",
"type": "object"
},
"Infrastructure": {
"additionalProperties": false,
"properties": {
"Infrastructure": {
"additionalProperties": true,
"description": "The underlying systems and framework required for the production of the Creative Work; it is generally not specific to a particular Creative Work.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"InfrastructureSC": {
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Infrastructure",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"infrastructureFC": {
"$ref": "#/$defs/Infrastructure/properties/infrastructureFC",
"title": "Functional Characteristics"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure",
"type": "object"
},
"InfrastructureSC": {
"additionalProperties": false,
"description": "Describes the form of the Infrastructure along with the attributes specific to that infrastructure's form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityType": {
"const": "InfrastructureSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the infrastructure in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure Structural Characteristics",
"type": "object"
},
"infrastructureFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Infrastructure within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Infrastructure Functional Characteristics",
"type": "object"
}
},
"title": "Infrastructure Definitions",
"type": "object"
},
"MediaCreationContext": {
"additionalProperties": false,
"properties": {
"Character": {
"additionalProperties": false,
"description": "A sentient entity (usually a person but not always) in the script whose specific identity is consequential to the narrative. A Character is generally identified by a specific name.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"characterName": {
"$ref": "#/$defs/Utility/properties/completeName",
"title": "Character Name"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the character",
"title": "Character Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Character",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "The primary name used for the character",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"profile": {
"additionalProperties": false,
"properties": {
"background": {
"additionalProperties": true,
"title": "background",
"type": "object"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"physicalCharacteristics": {
"additionalProperties": true,
"description": "Allows for the the description of certain physical characteristics on a character, things that might be useful to an art department, wardrobe or casting for example.",
"properties": {
"eyeColor": {
"description": "The color of the characters eyes",
"title": "Eye Color",
"type": "string"
},
"hairColor": {
"description": "The hair color of the character",
"examples": [
"Brown",
"Pink",
"Blonde",
""
],
"title": "Hair Color",
"type": "string"
},
"hairLength": {
"description": "The length of hair of the character",
"title": "Hair Length",
"type": "string"
},
"height": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/linearDistance",
"title": "height"
},
"species": {
"description": "A species to which this character belongs",
"examples": [
"Human",
"Borg",
"Goblin",
"Frog"
],
"title": "Species",
"type": "string"
},
"weight": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/weight",
"title": "weight"
}
},
"title": "Physical Characteristics",
"type": "object"
}
},
"title": "Profile",
"type": "object"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Character",
"type": "object"
},
"Context": {
"additionalProperties": true,
"description": "Informs scope within the construction process of a Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"type": "object"
}
]
},
"type": [
"array",
"null"
]
},
"For": {
"description": "The entities for which this Context applies to",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
}
]
},
"title": "Context For",
"type": [
"array",
"null"
]
},
"contextType": {
"description": "A classifiaction of the type of context represented",
"examples": [
"narrative",
"production"
],
"title": "Context Type",
"type": [
"string",
"null"
]
},
"contributesTo": {
"properties": {
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"contributor": {
"properties": {
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the context",
"title": "Description",
"type": "object"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Context",
"title": "Entity Type",
"type": "string"
},
"features": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"featuresIn": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"for": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"has": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the Context",
"title": "Context name",
"type": [
"string",
"null"
]
},
"neededBy": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"needs": {
"properties": {
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"releated": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"representedBy": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"represents": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"usedIn": {
"properties": {
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"uses": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Context",
"type": "object"
},
"CreativeWork": {
"additionalProperties": false,
"description": "A uniquely identified production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"approximateLength": {
"$ref": "#/$defs/Utility/properties/time/properties/periodInTime/properties/durationTime",
"title": "Approximate Length"
},
"countryOfOrigin": {
"items": {
"$ref": "#/$defs/Utility/properties/country"
},
"title": "Country Of Origin",
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the creative work",
"title": "Creative Work Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "CreativeWork",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "The primary name used for the creative work",
"title": "Creative Work name",
"type": [
"string",
"null"
]
},
"originalLanguage": {
"items": {
"$ref": "#/$defs/Utility/properties/language"
},
"title": "Original Languages",
"type": [
"array",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"title": {
"additionalProperties": true,
"properties": {
"internalTitle": {
"description": "The internal title of the work",
"title": "Creative Work Internal Title",
"type": [
"string",
"null"
]
},
"officialTitle": {
"description": "The official title of the work",
"title": "Creative Work Official Title",
"type": [
"string",
"null"
]
},
"workingTitle": {
"description": "The working title of the work",
"title": "Creative Work Working Title",
"type": [
"string",
"null"
]
}
},
"title": "Creative Work Title",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Creative Work",
"type": "object"
},
"Depiction": {
"additionalProperties": false,
"description": "The representation of something from a narrative entity by a production entity in the Creative Work, specified or implied by the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depictor": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
],
"type": "object"
},
"Depicts": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
}
],
"type": "object"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"depictionType": {
"description": "A categorization of the type of depiction",
"enum": [
"depiction",
"portrayal"
],
"title": "Object type",
"type": "string"
},
"description": {
"description": "A brief description of the depiction or portrayal",
"title": "Depiction Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Depiction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Depiction Styling Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Depiction",
"type": "object"
},
"Effect": {
"additionalProperties": false,
"description": "An on screen visual effect considered essential to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative effect",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"effectType": {
"description": "A categorization of the type of effect.",
"enum": [
"effect",
"specialEffect",
"visualEffect"
],
"title": "Object type",
"type": "string"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Effect",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the effect",
"title": "Narrative Effect Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Effect",
"type": "object"
},
"NarrativeAudio": {
"additionalProperties": false,
"description": "A named piece of audio significant to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative audio",
"title": "Narrative Audio Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAudio",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the audio clip",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type of audio.",
"enum": [
"audio",
"soundEffect",
"music"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Audio",
"type": "object"
},
"NarrativeLocation": {
"additionalProperties": false,
"description": "A location specified or implied by the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative location",
"title": "Narrative Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Narrative Location Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Location",
"type": "object"
},
"NarrativeObject": {
"additionalProperties": false,
"description": "A named object related to or interacting with characters that is implied or understood to be necessary for the narrative. Includes items like props, wardrobe, set dressing and vehicles.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative object",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeObject",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the object",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A departmental categorization for the object.",
"enum": [
"narrativeObject",
"narrativeProp",
"narrativeGreenery",
"narrativeVehicle",
"narrativeSetDressing"
],
"title": "Object type",
"type": "string"
},
"quantity": {
"title": "Quantity",
"type": [
"string",
"number"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"size": {
"title": "Size",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Object",
"type": "object"
},
"NarrativeScene": {
"additionalProperties": false,
"description": "Taken from the narrative itself and traditionally defined by creative intent and typically a unity of time, place, action, or theme.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative scene",
"title": "Narrative Scene Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the scene",
"title": "Scene Name",
"type": "string"
},
"sceneName": {
"additionalProperties": true,
"description": "A human readable name for the scene",
"properties": {
"altName": {
"description": "An alternate, often shorter, name used in applications to identify the scenes",
"title": "Scene alternate name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A full descriptive name for the scene",
"title": "Scene full name",
"type": [
"string",
"null"
]
}
},
"title": "Narrative Scene Name",
"type": "object"
},
"sceneNumber": {
"description": "A number used in the script to refer to the scene",
"title": "Scene Number",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
},
"slugline": {
"items": {
"additionalProperties": false,
"description": "An arbitrary note or comment pertaining to the entity",
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": [
"string",
"null"
]
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": [
"string",
"null"
]
}
},
"title": "Slugline",
"type": "object"
},
"title": "Slugline",
"type": "array"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Scene",
"type": "object"
},
"NarrativeStyling": {
"additionalProperties": false,
"description": "Styling required to prepare an actor for their role",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative styling",
"title": "Narrative Styling Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeStyling",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type styling.",
"enum": [
"narrativeStyling",
"narrativeHair",
"narrativeMakeup",
"narrativeProsthetics"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Styling",
"type": "object"
},
"NarrativeWardrobe": {
"additionalProperties": false,
"description": "The clothing for a Character in the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative wardrobe",
"title": "Narrative Wardrobe Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeWardrobe",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type wardrobe",
"enum": [
"narrativeWardrobe"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Wardrobe",
"type": "object"
},
"ProductionLocation": {
"additionalProperties": false,
"description": "A real place that is used to depict the Narrative Location or used for creating the production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the production location",
"title": "Production Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"locationType": {
"default": "production",
"description": "Describes whether this is production location or more specifically a shooting location",
"enum": [
"production",
"shooting"
],
"type": "string"
},
"name": {
"description": "A human readable name for the location",
"title": "Production Location Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Location",
"type": "object"
},
"ProductionScene": {
"additionalProperties": false,
"description": "Defined either by explicit divisions in the structure of the Script, e.g., by a Slugline, or by additional capture for use in the Creative Work that is not tied to any particular Scene in the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the production scene",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the production scene",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"sceneDescriptor": {
"description": "An alphanumeric reference to a Production Scene",
"title": "Scene Descriptor",
"type": [
"string",
"null"
]
},
"sceneHeader": {
"description": "Used when referring to the Production Scene. It is generally synonymous with Slugline and is used to divide a Script into scenes.",
"title": "Scene Header",
"type": [
"string",
"null"
]
},
"sceneName": {
"$ref": "#/$defs/Utility/properties/basicName",
"title": "Scene Name"
},
"sceneNumber": {
"description": "A number tied to a Slugline when a Script is locked",
"title": "Scene Number",
"type": [
"null",
"string"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Scene",
"type": "object"
},
"Sequence": {
"additionalProperties": false,
"description": "A sequence of shots linked to creative intent.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"SCD": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"title": "Sequence Chronology Descriptor"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the sequence",
"title": "Sequence description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Sequence",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the editorial sequence",
"title": "Sequence Name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"sequenceType": {
"enum": [
"vfx",
"editorial",
"image",
"animation",
"color"
],
"title": "Sequence Type",
"type": "string"
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"Alternative": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Sequence Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Sequence",
"type": "object"
},
"Slate": {
"additionalProperties": false,
"description": "Used to capture key identifying information about what is being recorded on any given setup and take.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
}
]
},
"Director": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Director",
"type": [
"array",
"null"
]
},
"cameraLabel": {
"description": "Label for the Camera responsible for the Capture, usually related to the role and responsibility of the group operating it and usually a single upper-case letter starting with A.",
"title": "Camera Label",
"type": [
"string",
"null"
]
},
"cameraRoll": {
"description": "Identifier for a group of events captured together on the same camera on the same media.",
"title": "Camera Roll",
"type": [
"string",
"null"
]
},
"cameraUnit": {
"description": "A group of Participants responsible for shooting some element of a Scene, e.g., a Main Unit or Second Unit.",
"title": "Camera Unit",
"type": [
"string",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the slate",
"title": "Slate description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Slate",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the Slate",
"title": "Slate Name",
"type": [
"string",
"null"
]
},
"recordingFPS": {
"description": "Frames per second recorded by the camera.",
"title": "Recording FPS",
"type": [
"number",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"shootDate": {
"$ref": "#/$defs/Utility/properties/time/properties/date",
"description": "The date of capture or creation",
"title": "Shoot Date"
},
"shootDay": {
"description": "The number of the day on the shooting schedule.",
"title": "Shoot Day",
"type": [
"number",
"string",
"null"
]
},
"slateUID": {
"description": "Slate Unique Identifier",
"title": "Slate UID",
"type": "string"
},
"soundRoll": {
"description": "Identifier for a group of audio events captured together on the same recording device and same media.",
"title": "Sound Roll",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Slate",
"type": "object"
},
"SpecialAction": {
"additionalProperties": false,
"description": "An action or set of actions that are performed and require additional choreography or supervision.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"actionType": {
"description": "A categorization of the type action.",
"enum": [
"action",
"stunt",
"choreography",
"fight",
"motionCapture",
"marine",
"aerial"
],
"title": "Object type",
"type": "string"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative action",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the action",
"title": "Narrative Action Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Special Action",
"type": "object"
}
},
"title": "Media Creation Context Definitions",
"type": "object"
},
"Participant": {
"additionalProperties": false,
"properties": {
"Department": {
"additionalProperties": false,
"description": "Part of a larger Organization with a particular set of responsibilities on the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"departmentName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"description": {
"description": "A brief description of the department",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Department",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the department, primarily for use as a label",
"title": "Department name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "department",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Department",
"type": "object"
},
"Organization": {
"additionalProperties": false,
"description": "A legal entity or groups of people associated with the production.. with a particular purpose relative to the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the organization",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Organization",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the organization, primarily for use as a label",
"title": "Organization name",
"type": [
"string",
"null"
]
},
"organizationName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "organization",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Organization",
"type": "object"
},
"Participant": {
"additionalProperties": false,
"description": "The entities (people, organizations, and services) that are responsible for the production of the Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"description": "Any Participants that are members of this Participant group",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Participant",
"type": "array"
},
"ParticipantSC": {
"description": "Describes the form of a Participant along with the attributes specific to that Participant\u2019s form.",
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
}
],
"title": "Participant Structural Characteristics",
"type": "object"
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Participant",
"title": "Participant Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the participant",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Participant",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"participantFC": {
"additionalProperties": true,
"description": "The use or purpose of a Participant within the production process",
"properties": {
"Role": {
"description": "",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"type": "array"
},
"functionalType": {
"title": "Functional Type",
"type": [
"string",
"null"
]
},
"jobTitle": {
"description": "A formal name for the position a Person holds in relation to the production, usually associated with a specific set of responsibilities.",
"title": "Job Title",
"type": [
"string",
"null"
]
}
},
"title": "Participant Functional Characteristics",
"type": "object"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Participant",
"type": "object"
},
"Person": {
"additionalProperties": false,
"description": "People are the individuals that are associated with the production",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Person",
"title": "Person Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the person",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Person",
"title": "Entity Type",
"type": "string"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"title": "Identifier",
"type": "array"
},
"jobTitle": {
"description": "A persons job title (as distinct from a specific role)",
"title": "Job Title",
"type": [
"string",
"null"
]
},
"name": {
"description": "A human readable name for the person, convenient for use in UI's etc.",
"title": "Person name",
"type": [
"string",
"null"
]
},
"personName": {
"$ref": "#/$defs/Utility/properties/completeName",
"description": "The canonical name or set of names and titles for the Person",
"title": "Person Name"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "person",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Person",
"type": "object"
},
"Role": {
"additionalProperties": false,
"description": "A set of properties that define the role of a participant within the production",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"title": "Role Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Role",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"examples": [
"Director",
"Producer",
"Composer",
"Art Department"
],
"title": "Role Name",
"type": [
"string",
"null"
]
},
"roleType": {
"description": "The specific role, typically used in authorization systems",
"title": "Role Type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Role",
"type": "object"
},
"Service": {
"additionalProperties": false,
"description": "A computer driven agent that can perform tasks given the proper context and structured data.",
"properties": {
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the service",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Service",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the service, primarily for use as a label",
"title": "Service name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"serviceName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"structuralType": {
"const": "service",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Service",
"type": "object"
}
},
"title": "Participant Definitions",
"type": "object"
},
"Task": {
"additionalProperties": false,
"properties": {
"Task": {
"additionalProperties": true,
"description": "A piece of work to be done and completed as a step in the production process.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"TaskSC": {
"$ref": "#/$defs/Task/properties/TaskSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Task",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"taskFC": {
"$ref": "#/$defs/Task/properties/taskFC",
"title": "Functional Characteristics"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task",
"type": "object"
},
"TaskSC": {
"additionalProperties": true,
"description": "Describes the form of Task along with the attributes specific to that task\u2019s form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "TaskSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the asset in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task Structural Characteristics",
"type": "object"
},
"taskFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Asset within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Task Functional Characteristics",
"type": "object"
}
},
"title": "Task Definitions",
"type": "object"
},
"Utility": {
"additionalProperties": false,
"description": "Common data models and data structures used in multiple places and in multiple ways in a larger system.",
"properties": {
"Location": {
"additionalProperties": false,
"description": "A particular place or position either in either the real world or the narrative world.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": "array"
},
"address": {
"$ref": "#/$defs/Utility/properties/address",
"title": "Address"
},
"coordinates": {
"$ref": "#/$defs/Utility/properties/coordinates",
"title": "Coordinates"
},
"description": {
"description": "A brief description of the location",
"title": "Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Location",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Location name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Location",
"type": "object"
},
"address": {
"additionalProperties": false,
"description": "A postal address or identifiable location of a place or building",
"properties": {
"country": {
"$ref": "#/$defs/Utility/properties/country",
"title": "Country"
},
"locality": {
"description": "The locality in which the street address is, and which is in the region.",
"examples": [
"Mountain View"
],
"title": "Address locality",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "A zip or postal code",
"examples": [
"94534"
],
"title": "Zip or Postal Code",
"type": [
"string",
"null"
]
},
"region": {
"description": "The region in which the locality is, and which is in the country",
"examples": [
"California"
],
"title": "Address region",
"type": [
"string",
"null"
]
},
"street": {
"description": "The street address",
"examples": [
"1600 Amphitheater Parkway"
],
"title": "Street Address",
"type": [
"string",
"null"
]
}
},
"title": "Address",
"type": [
"object",
"null"
]
},
"basicName": {
"additionalProperties": false,
"description": "A description of things name and an alternative name",
"properties": {
"altName": {
"description": "An alternate, often shortened name for the entity",
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full an complete name of the entity",
"title": "Full Name",
"type": [
"string",
"null"
]
}
},
"title": "Basic Name",
"type": [
"object",
"null"
]
},
"completeName": {
"additionalProperties": false,
"description": "A detailed description of a person, or others, name and variants of their name.",
"properties": {
"alias": {
"description": "An alias being used by a person often used to disguise someones real identity, sometimes used when booking hotel rooms or restaurants ",
"title": "Alias",
"type": [
"string",
"null"
]
},
"altName": {
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"birthName": {
"description": "A persons name at birth, also referred to as maiden name",
"title": "Birth Name",
"type": [
"string",
"null"
]
},
"contractualName": {
"title": "Contractual Name",
"type": [
"string",
"null"
]
},
"displayName": {
"title": "Display Name",
"type": [
"string",
"null"
]
},
"familyName": {
"description": "A persons family name, also referred to as surname",
"title": "Family Name",
"type": [
"string",
"null"
]
},
"firstGivenName": {
"description": "A person's first name, also referred to as given name",
"title": "First Given Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A complete name, typically a conjunction of familyName, firstGivenName and possibly other fields.",
"title": "Full Name",
"type": [
"string",
"null"
]
},
"moniker": {
"title": "Moniker",
"type": [
"string",
"null"
]
},
"nickname": {
"title": "Nickname",
"type": [
"string",
"null"
]
},
"prefix": {
"description": "A prefix that can indicate a persons gender or title",
"examples": [
"Mrs",
"Mr",
"Dr",
"General"
],
"title": "Prefix",
"type": [
"string",
"null"
]
},
"primaryName": {
"description": "A persons primary name, one they typically use, also often a combination of first, second and family name",
"title": "Primary Name",
"type": [
"string",
"null"
]
},
"pseudonym": {
"title": "Pseudonym",
"type": [
"string",
"null"
]
},
"scriptName": {
"title": "Script Name",
"type": [
"string",
"null"
]
},
"secondGivenName": {
"description": "A persons second given name, also referred to as middle name",
"title": "Second Given Name",
"type": [
"string",
"null"
]
},
"sortName": {
"title": "Sort Name",
"type": [
"string",
"null"
]
},
"suffix": {
"description": "A suffix, often used to indicate a title or classification",
"examples": [
"MBE",
"MD",
"RN",
"II",
"IV"
],
"title": "Suffix",
"type": [
"string",
"null"
]
},
"translatedName": {
"title": "Translated Name",
"type": [
"string",
"null"
]
}
},
"title": "Complete Name",
"type": "object"
},
"contact": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/Utility/properties/email",
"title": "Email"
},
"telephone": {
"$ref": "#/$defs/Utility/properties/telephone",
"title": "Telephone"
}
},
"title": "Contact",
"type": "object"
},
"coordinates": {
"additionalProperties": false,
"description": "A global positioning coordinate in compliance with WGS 84",
"properties": {
"latitude": {
"maximum": 90,
"minimum": -90,
"title": "latitude",
"type": "number"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"title": "longitude",
"type": "number"
}
},
"title": "Coordinates",
"type": [
"object",
"null"
]
},
"country": {
"description": "The country, as an ISO 3166-1 alpha-2 country code",
"examples": [
"US"
],
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": [
"string",
"null"
]
},
"email": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Email",
"type": "object"
},
"gender": {
"additionalProperties": false,
"description": "A person, or others, expressed or prefered gender and pronoun",
"properties": {
"gender": {
"description": "The gender by which an individual identifies",
"enum": [
"male",
"female",
"other",
"unknown",
null
],
"title": "Identifies as gender",
"type": [
"string",
"null"
]
},
"genderPronoun": {
"description": "An individuals pronoun of choice",
"enum": [
"he/him",
"she/her",
"ze/hir",
"they/their",
null
],
"title": "Preferred pronoun",
"type": [
"string",
"null"
]
}
},
"title": "Gender",
"type": [
"object",
"null"
]
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"combinedForm": {
"description": "A combination of the Identifier Scope and Value that is useful for utilizing the identifier in a system, for example a URN (URN:ID:IdentifierScope:IdentifierValue).",
"title": "Identifier Combined Form",
"type": "string"
},
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
},
"url": {
"description": "A URL or IRI that can be used for resolving the Identifier Value within the Identifier Scope.",
"title": "URL",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"minItems": 1,
"title": "Identifier",
"type": "array"
},
"language": {
"description": "An IETF BCP 47 language code",
"title": "Language",
"type": [
"string",
"null"
]
},
"note": {
"additionalProperties": false,
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": "string"
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": "string"
}
},
"title": "Note",
"type": [
"object",
"null"
]
},
"provenance": {
"additionalProperties": false,
"description": "A record of when something was changed and by whom.",
"properties": {
"CreatedBy": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"Origin": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Role": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"createdOn": {
"$ref": "#/$defs/Utility/properties/time/properties/dateTime"
},
"note": {
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"reason": {
"type": "string"
}
},
"title": "Provenance",
"type": "object"
},
"telephone": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Telephone",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2020-11-21"
],
"pattern": "\\d{4}-[01]\\d-[0-3]\\d",
"title": "Date",
"type": [
"string",
"null"
]
},
"dateTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2023-08-24T20:51:15Z\n2023-08-24T20:51:15.56Z\n2023-08-24T20:51:15+08:00\n2023-08-24T20:51:15.23-04:00"
],
"pattern": "^(?:19|20)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:|\\.\\d\\d)(?:Z|-0[1-9]|-1\\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\\d)|\\+[01]\\d|\\+2[0-3])(?:|:?[0-5]\\d)$",
"title": "Date & Time",
"type": [
"string",
"null"
]
},
"descriptiveTime": {
"additionalProperties": false,
"properties": {
"eventInTime": {
"description": "Describes a specific event that occurred",
"examples": [
"Hindenburg disaster",
"World Trade Center attack",
"Queen Elizabeth coronation"
],
"title": "Event in Time",
"type": "string"
},
"periodInDay": {
"examples": [
"Morning",
"Noon",
"Midnight",
"Afternoon",
"Night"
],
"title": "Period in Day",
"type": "string"
},
"periodInTime": {
"examples": [
"Ming dynasty",
"World War II",
"Jurassic period",
"20th century"
],
"title": "Period in Time",
"type": "string"
},
"relativeTime": {
"examples": [
"Later",
"Continuous",
"6 months earlier",
"A long time ago"
],
"title": "Relative Time",
"type": "string"
}
},
"title": "Descriptive Time",
"type": "object"
},
"durationTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"P2Y12M3D"
],
"pattern": "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$",
"title": "Duration of Time",
"type": [
"string",
"null"
]
},
"periodInTime": {
"additionalProperties": false,
"properties": {
"durationTime": {
"title": "Duration of Time",
"type": "string"
},
"endTime": {
"title": "End Time",
"type": "string"
},
"startTime": {
"title": "Start Time",
"type": "string"
}
},
"required": [
"startTime"
],
"title": "Period in Time",
"type": "object"
},
"timecode": {
"description": "SMPTE timecode",
"examples": [
"00:03:43:12"
],
"pattern": "^(?:(?:[0-1][0-9]|[0-2][0-3]):)(?:[0-5][0-9]:){2}(?:[0-2][0-9])$",
"title": "SMPTE Timcode in the format HH:MM:SS:FF. \nAssumes the frame rate is 23.98, 24, 25, 29.97 NDF, or 30",
"type": [
"string",
"null"
]
},
"timestamp": {
"title": "Timestamp",
"type": [
"number",
"null"
]
}
},
"title": "Time",
"type": "object"
},
"unitOfMeasurement": {
"additionalProperties": false,
"properties": {
"dimensions": {
"description": "Encode a set of measurements to describe a 2 or 3 dimensional object (metric, imperial or pixels)",
"properties": {
"depth": {
"description": "The depth or Z axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"height": {
"description": "The height or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"width": {
"description": "The width or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
}
},
"title": "dimensions",
"type": "object"
},
"linearDistance": {
"description": "Encode a measurement of distance using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
}
],
"title": "Linear Distance"
},
"weight": {
"description": "Encode a measurement of weight using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode weight using the metric system of measurement (kilogram, gram)",
"examples": [
"3kg7g"
],
"pattern": "^(\\d+kg)?(\\d+g)?$",
"type": "string"
},
{
"description": "Encode weight using the imperial system of measurement (pounds, ounces)",
"examples": [
"12lb14oz"
],
"pattern": "^(\\d+lb)?(\\d+oz)?$",
"type": "string"
}
],
"title": "weight"
}
},
"type": "object"
},
"versionNumber": {
"description": "A designation indicating a place in a sequence of versions",
"title": "Version Number",
"type": [
"string",
"number",
"null"
]
}
},
"title": "Utility Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
MovieLabs/OMC | 633188bc4e1b9cdcbc588e6c03fea6ec1c2bf492 | 2023-10-19T16:59:06 | OMC-JSON/OMC-JSON-v2.0.schema.json | 6 | 2024-05-27T04:54:55.691858Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Asset": {
"additionalProperties": false,
"properties": {
"Asset": {
"additionalProperties": false,
"description": "A physical or digital object or collection of objects specific to the creation of the Creative Work.",
"properties": {
"Asset": {
"description": "The set of Assets that make up an an asset group and has a structuralType of 'assetGroup'",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"title": "Asset Group",
"type": [
"array",
"null"
]
},
"AssetSC": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
],
"title": "Structural Characteristics"
},
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"assetFC": {
"$ref": "#/$defs/Asset/properties/assetFC",
"title": "Asset Functional Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Asset",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"Alternative": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"Derivation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Asset Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset",
"type": [
"object"
]
},
"AssetSC": {
"$defs": {
"assetGroup": {
"additionalProperties": false,
"description": "Structural properties of an Asset Group",
"properties": {
"isOrdered": {
"type": [
"boolean",
"null"
]
}
},
"title": "Asset Group",
"type": "object"
},
"dimensions": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/dimensions"
},
"fileDetails": {
"additionalProperties": false,
"description": "Where opaque identifiers are used it can be useful to express naming for use in traditional file systems",
"properties": {
"fileExtension": {
"type": [
"string",
"null"
]
},
"fileName": {
"type": [
"string",
"null"
]
},
"filePath": {
"type": [
"string",
"null"
]
},
"mediaType": {
"type": [
"string",
"null"
]
}
},
"title": "File Details",
"type": "object"
},
"linkset": {
"additionalProperties": false,
"description": "When used with resolution system returning a linkset additional information can help disambiguate multiple linksets in the response.",
"properties": {
"mediaType": {
"type": [
"string",
"null"
]
},
"recordType": {
"type": [
"string",
"null"
]
}
},
"title": "Linkset",
"type": "object"
}
},
"additionalProperties": false,
"description": "Describes the form of an Asset along with the attributes specific to that asset\u2019s form",
"properties": {
"Carrier": {
"description": "For describing the physical storage device on which the digital assence is stored",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
}
],
"title": "Carrier"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the participant",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "AssetSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"isAnalog": {
"description": "True if the Asset is an Analog Asset.",
"title": "Is Analog",
"type": [
"boolean",
"null"
]
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": false,
"description": "A set of properties that describe the asset in this form",
"properties": {
"assetGroup": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/assetGroup"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"dimensions": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/dimensions"
},
"fileDetails": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/fileDetails"
},
"linkset": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/linkset"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Deriviation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"Representation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RepresentationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Asset Structural Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset Structural Characteristics",
"type": "object"
},
"assetFC": {
"$defs": {
"empty": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"type": "object"
},
"generic": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"functionalType": {
"not": {
"enum": [
"scd"
]
},
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
},
"scd": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": false,
"properties": {
"component": {
"items": {
"properties": {
"Shot": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"type": "object"
},
"duration": {
"type": [
"string",
"null"
]
},
"recordEnd": {
"type": [
"string",
"null"
]
},
"recordStart": {
"type": [
"string",
"null"
]
},
"sourceEnd": {
"type": [
"string",
"null"
]
},
"sourceStart": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"functionalType": {
"const": "scd",
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
}
},
"description": "Describes the use or purpose of an Asset within the production process",
"oneOf": [
{
"description": "Allow for null",
"type": "null"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/empty",
"title": "Allow for empty object, no functional characteristics"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/generic",
"title": "A generic schema allowing any functional type and properties"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/scd",
"title": "Functional characteristics for a Sequence Chronology Descriptor"
}
],
"title": "Asset Functional Characteristics"
}
},
"title": "Asset Definitions",
"type": "object"
},
"Infrastructure": {
"additionalProperties": false,
"properties": {
"Infrastructure": {
"additionalProperties": true,
"description": "The underlying systems and framework required for the production of the Creative Work; it is generally not specific to a particular Creative Work.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"InfrastructureSC": {
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Infrastructure",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"infrastructureFC": {
"$ref": "#/$defs/Infrastructure/properties/infrastructureFC",
"title": "Functional Characteristics"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure",
"type": "object"
},
"InfrastructureSC": {
"additionalProperties": false,
"description": "Describes the form of the Infrastructure along with the attributes specific to that infrastructure's form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityType": {
"const": "InfrastructureSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the infrastructure in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure Structural Characteristics",
"type": "object"
},
"infrastructureFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Infrastructure within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Infrastructure Functional Characteristics",
"type": "object"
}
},
"title": "Infrastructure Definitions",
"type": "object"
},
"MediaCreationContext": {
"additionalProperties": false,
"properties": {
"Character": {
"additionalProperties": false,
"description": "A sentient entity (usually a person but not always) in the script whose specific identity is consequential to the narrative. A Character is generally identified by a specific name.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"characterName": {
"$ref": "#/$defs/Utility/properties/completeName",
"title": "Character Name"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the character",
"title": "Character Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Character",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "The primary name used for the character",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"profile": {
"additionalProperties": false,
"properties": {
"background": {
"additionalProperties": true,
"title": "background",
"type": "object"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"physicalCharacteristics": {
"additionalProperties": true,
"description": "Allows for the the description of certain physical characteristics on a character, things that might be useful to an art department, wardrobe or casting for example.",
"properties": {
"eyeColor": {
"description": "The color of the characters eyes",
"title": "Eye Color",
"type": "string"
},
"hairColor": {
"description": "The hair color of the character",
"examples": [
"Brown",
"Pink",
"Blonde",
""
],
"title": "Hair Color",
"type": "string"
},
"hairLength": {
"description": "The length of hair of the character",
"title": "Hair Length",
"type": "string"
},
"height": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/linearDistance",
"title": "height"
},
"species": {
"description": "A species to which this character belongs",
"examples": [
"Human",
"Borg",
"Goblin",
"Frog"
],
"title": "Species",
"type": "string"
},
"weight": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/weight",
"title": "weight"
}
},
"title": "Physical Characteristics",
"type": "object"
}
},
"title": "Profile",
"type": "object"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Character",
"type": "object"
},
"Context": {
"additionalProperties": true,
"description": "Informs scope within the construction process of a Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"type": "object"
}
]
},
"type": [
"array",
"null"
]
},
"For": {
"description": "The entities for which this Context applies to",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
}
]
},
"title": "Context For",
"type": [
"array",
"null"
]
},
"contextType": {
"description": "A classifiaction of the type of context represented",
"examples": [
"narrative",
"production"
],
"title": "Context Type",
"type": [
"string",
"null"
]
},
"contributesTo": {
"properties": {
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"contributor": {
"properties": {
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the context",
"title": "Description",
"type": "object"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Context",
"title": "Entity Type",
"type": "string"
},
"features": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"featuresIn": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"for": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"has": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the Context",
"title": "Context name",
"type": [
"string",
"null"
]
},
"neededBy": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"needs": {
"properties": {
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"releated": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"representedBy": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"represents": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"usedIn": {
"properties": {
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"uses": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Context",
"type": "object"
},
"CreativeWork": {
"additionalProperties": false,
"description": "A uniquely identified production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"approximateLength": {
"$ref": "#/$defs/Utility/properties/time/properties/periodInTime/properties/durationTime",
"title": "Approximate Length"
},
"countryOfOrigin": {
"items": {
"$ref": "#/$defs/Utility/properties/country"
},
"title": "Country Of Origin",
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the creative work",
"title": "Creative Work Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "CreativeWork",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"originalLanguage": {
"items": {
"$ref": "#/$defs/Utility/properties/language"
},
"title": "Original Languages",
"type": [
"array",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"title": {
"additionalProperties": true,
"properties": {
"internalTitle": {
"description": "The internal title of the work",
"title": "Creative Work Internal Title",
"type": [
"string",
"null"
]
},
"officialTitle": {
"description": "The official title of the work",
"title": "Creative Work Official Title",
"type": [
"string",
"null"
]
},
"workingTitle": {
"description": "The working title of the work",
"title": "Creative Work Working Title",
"type": [
"string",
"null"
]
}
},
"title": "Creative Work Title",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Creative Work",
"type": "object"
},
"Depiction": {
"additionalProperties": false,
"description": "The representation of something from a narrative entity by a production entity in the Creative Work, specified or implied by the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depictor": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
],
"type": "object"
},
"Depicts": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
}
],
"type": "object"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"depictionType": {
"description": "A categorization of the type of depiction",
"enum": [
"depiction",
"portrayal"
],
"title": "Object type",
"type": "string"
},
"description": {
"description": "A brief description of the depiction or portrayal",
"title": "Depiction Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Depiction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Depiction Styling Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Depiction",
"type": "object"
},
"Effect": {
"additionalProperties": false,
"description": "An on screen visual effect considered essential to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative effect",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"effectType": {
"description": "A categorization of the type of effect.",
"enum": [
"effect",
"specialEffect",
"visualEffect"
],
"title": "Object type",
"type": "string"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Effect",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the effect",
"title": "Narrative Effect Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Effect",
"type": "object"
},
"NarrativeAudio": {
"additionalProperties": false,
"description": "A named piece of audio significant to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative audio",
"title": "Narrative Audio Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAudio",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the audio clip",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type of audio.",
"enum": [
"audio",
"soundEffect",
"music"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Audio",
"type": "object"
},
"NarrativeLocation": {
"additionalProperties": false,
"description": "A location specified or implied by the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative location",
"title": "Narrative Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Narrative Location Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Location",
"type": "object"
},
"NarrativeObject": {
"additionalProperties": false,
"description": "A named object related to or interacting with characters that is implied or understood to be necessary for the narrative. Includes items like props, wardrobe, set dressing and vehicles.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative object",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeObject",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the object",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A departmental categorization for the object.",
"enum": [
"narrativeObject",
"narrativeProp",
"narrativeGreenery",
"narrativeVehicle",
"narrativeSetDressing"
],
"title": "Object type",
"type": "string"
},
"quantity": {
"title": "Quantity",
"type": [
"string",
"number"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"size": {
"title": "Size",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Object",
"type": "object"
},
"NarrativeScene": {
"additionalProperties": false,
"description": "Taken from the narrative itself and traditionally defined by creative intent and typically a unity of time, place, action, or theme.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative scene",
"title": "Narrative Scene Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the scene",
"title": "Scene Name",
"type": "string"
},
"sceneName": {
"additionalProperties": true,
"description": "A human readable name for the scene",
"properties": {
"altName": {
"description": "An alternate, often shorter, name used in applications to identify the scenes",
"title": "Scene alternate name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A full descriptive name for the scene",
"title": "Scene full name",
"type": [
"string",
"null"
]
}
},
"title": "Narrative Scene Name",
"type": "object"
},
"sceneNumber": {
"description": "A number used in the script to refer to the scene",
"title": "Scene Number",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
},
"slugline": {
"items": {
"additionalProperties": false,
"description": "An arbitrary note or comment pertaining to the entity",
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": [
"string",
"null"
]
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": [
"string",
"null"
]
}
},
"title": "Slugline",
"type": "object"
},
"title": "Slugline",
"type": "array"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Scene",
"type": "object"
},
"NarrativeStyling": {
"additionalProperties": false,
"description": "Styling required to prepare an actor for their role",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative styling",
"title": "Narrative Styling Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeStyling",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type styling.",
"enum": [
"narrativeStyling",
"narrativeHair",
"narrativeMakeup",
"narrativeProsthetics"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Styling",
"type": "object"
},
"NarrativeWardrobe": {
"additionalProperties": false,
"description": "The clothing for a Character in the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative wardrobe",
"title": "Narrative Wardrobe Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeWardrobe",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type wardrobe",
"enum": [
"narrativeWardrobe"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Wardrobe",
"type": "object"
},
"ProductionLocation": {
"additionalProperties": false,
"description": "A real place that is used to depict the Narrative Location or used for creating the production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the production location",
"title": "Production Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"locationType": {
"default": "production",
"description": "Describes whether this is production location or more specifically a shooting location",
"enum": [
"production",
"shooting"
],
"type": "string"
},
"name": {
"description": "A human readable name for the location",
"title": "Production Location Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Location",
"type": "object"
},
"ProductionScene": {
"additionalProperties": false,
"description": "Defined either by explicit divisions in the structure of the Script, e.g., by a Slugline, or by additional capture for use in the Creative Work that is not tied to any particular Scene in the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the production scene",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the production scene",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"sceneDescriptor": {
"description": "An alphanumeric reference to a Production Scene",
"title": "Scene Descriptor",
"type": [
"string",
"null"
]
},
"sceneHeader": {
"description": "Used when referring to the Production Scene. It is generally synonymous with Slugline and is used to divide a Script into scenes.",
"title": "Scene Header",
"type": [
"string",
"null"
]
},
"sceneName": {
"$ref": "#/$defs/Utility/properties/basicName",
"title": "Scene Name"
},
"sceneNumber": {
"description": "A number tied to a Slugline when a Script is locked",
"title": "Scene Number",
"type": [
"null",
"string"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Scene",
"type": "object"
},
"Sequence": {
"additionalProperties": false,
"description": "A sequence of shots linked to creative intent.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"SCD": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"title": "Sequence Chronology Descriptor"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the sequence",
"title": "Sequence description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Sequence",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the editorial sequence",
"title": "Sequence Name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"sequenceType": {
"enum": [
"vfx",
"editorial",
"image",
"animation",
"color"
],
"title": "Sequence Type",
"type": "string"
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"Alternative": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Sequence Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Sequence",
"type": "object"
},
"Slate": {
"additionalProperties": false,
"description": "Used to capture key identifying information about what is being recorded on any given setup and take.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
}
]
},
"Director": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Director",
"type": [
"array",
"null"
]
},
"cameraLabel": {
"description": "Label for the Camera responsible for the Capture, usually related to the role and responsibility of the group operating it and usually a single upper-case letter starting with A.",
"title": "Camera Label",
"type": [
"string",
"null"
]
},
"cameraRoll": {
"description": "Identifier for a group of events captured together on the same camera on the same media.",
"title": "Camera Roll",
"type": [
"string",
"null"
]
},
"cameraUnit": {
"description": "A group of Participants responsible for shooting some element of a Scene, e.g., a Main Unit or Second Unit.",
"title": "Camera Unit",
"type": [
"string",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Slate",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"recordingFPS": {
"description": "Frames per second recorded by the camera.",
"title": "Recording FPS",
"type": [
"number",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"shootDate": {
"$ref": "#/$defs/Utility/properties/time/properties/date",
"description": "The date of capture or creation",
"title": "Shoot Date"
},
"shootDay": {
"description": "The number of the day on the shooting schedule.",
"title": "Shoot Day",
"type": [
"number",
"string",
"null"
]
},
"slateUID": {
"description": "Slate Unique Identifier",
"title": "Slate UID",
"type": "string"
},
"soundRoll": {
"description": "Identifier for a group of audio events captured together on the same recording device and same media.",
"title": "Sound Roll",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Slate",
"type": "object"
},
"SpecialAction": {
"additionalProperties": false,
"description": "An action or set of actions that are performed and require additional choreography or supervision.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"actionType": {
"description": "A categorization of the type action.",
"enum": [
"action",
"stunt",
"choreography",
"fight",
"motionCapture",
"marine",
"aerial"
],
"title": "Object type",
"type": "string"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative action",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the action",
"title": "Narrative Action Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Special Action",
"type": "object"
}
},
"title": "Media Creation Context Definitions",
"type": "object"
},
"Participant": {
"additionalProperties": false,
"properties": {
"Department": {
"additionalProperties": false,
"description": "Part of a larger Organization with a particular set of responsibilities on the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"departmentName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"description": {
"description": "A brief description of the department",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Department",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the department, primarily for use as a label",
"title": "Department name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "department",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Department",
"type": "object"
},
"Organization": {
"additionalProperties": false,
"description": "A legal entity or groups of people associated with the production.. with a particular purpose relative to the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the organization",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Organization",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the organization, primarily for use as a label",
"title": "Organization name",
"type": [
"string",
"null"
]
},
"organizationName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "organization",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Organization",
"type": "object"
},
"Participant": {
"additionalProperties": false,
"description": "The entities (people, organizations, and services) that are responsible for the production of the Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"description": "Any Participants that are members of this Participant group",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Participant",
"type": "array"
},
"ParticipantSC": {
"description": "Describes the form of a Participant along with the attributes specific to that Participant\u2019s form.",
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
}
],
"title": "Participant Structural Characteristics",
"type": "object"
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Participant",
"title": "Participant Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the participant",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Participant",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"participantFC": {
"additionalProperties": true,
"description": "The use or purpose of a Participant within the production process",
"properties": {
"Role": {
"description": "",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"type": "array"
},
"functionalType": {
"title": "Functional Type",
"type": [
"string",
"null"
]
},
"jobTitle": {
"description": "A formal name for the position a Person holds in relation to the production, usually associated with a specific set of responsibilities.",
"title": "Job Title",
"type": [
"string",
"null"
]
}
},
"title": "Participant Functional Characteristics",
"type": "object"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Participant",
"type": "object"
},
"Person": {
"additionalProperties": false,
"description": "People are the individuals that are associated with the production",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Person",
"title": "Person Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the person",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Person",
"title": "Entity Type",
"type": "string"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"title": "Identifier",
"type": "array"
},
"jobTitle": {
"description": "A persons job title (as distinct from a specific role)",
"title": "Job Title",
"type": [
"string",
"null"
]
},
"name": {
"description": "A human readable name for the person, convenient for use in UI's etc.",
"title": "Person name",
"type": [
"string",
"null"
]
},
"personName": {
"$ref": "#/$defs/Utility/properties/completeName",
"description": "The canonical name or set of names and titles for the Person",
"title": "Person Name"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "person",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Person",
"type": "object"
},
"Role": {
"additionalProperties": false,
"description": "A set of properties that define the role of a participant within the production",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"title": "Role Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Role",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"examples": [
"Director",
"Producer",
"Composer",
"Art Department"
],
"title": "Role Name",
"type": [
"string",
"null"
]
},
"roleType": {
"description": "The specific role, typically used in authorization systems",
"title": "Role Type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Role",
"type": "object"
},
"Service": {
"additionalProperties": false,
"description": "A computer driven agent that can perform tasks given the proper context and structured data.",
"properties": {
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the service",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Service",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the service, primarily for use as a label",
"title": "Service name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"serviceName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"structuralType": {
"const": "service",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Service",
"type": "object"
}
},
"title": "Participant Definitions",
"type": "object"
},
"Task": {
"additionalProperties": false,
"properties": {
"Task": {
"additionalProperties": true,
"description": "A piece of work to be done and completed as a step in the production process.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"TaskSC": {
"$ref": "#/$defs/Task/properties/TaskSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Task",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"taskFC": {
"$ref": "#/$defs/Task/properties/taskFC",
"title": "Functional Characteristics"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task",
"type": "object"
},
"TaskSC": {
"additionalProperties": true,
"description": "Describes the form of Task along with the attributes specific to that task\u2019s form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "TaskSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the asset in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task Structural Characteristics",
"type": "object"
},
"taskFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Asset within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Task Functional Characteristics",
"type": "object"
}
},
"title": "Task Definitions",
"type": "object"
},
"Utility": {
"additionalProperties": false,
"description": "Common data models and data structures used in multiple places and in multiple ways in a larger system.",
"properties": {
"Location": {
"additionalProperties": false,
"description": "A particular place or position either in either the real world or the narrative world.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": "array"
},
"address": {
"$ref": "#/$defs/Utility/properties/address",
"title": "Address"
},
"coordinates": {
"$ref": "#/$defs/Utility/properties/coordinates",
"title": "Coordinates"
},
"description": {
"description": "A brief description of the location",
"title": "Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Location",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Location name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Location",
"type": "object"
},
"address": {
"additionalProperties": false,
"description": "A postal address or identifiable location of a place or building",
"properties": {
"country": {
"$ref": "#/$defs/Utility/properties/country",
"title": "Country"
},
"locality": {
"description": "The locality in which the street address is, and which is in the region.",
"examples": [
"Mountain View"
],
"title": "Address locality",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "A zip or postal code",
"examples": [
"94534"
],
"title": "Zip or Postal Code",
"type": [
"string",
"null"
]
},
"region": {
"description": "The region in which the locality is, and which is in the country",
"examples": [
"California"
],
"title": "Address region",
"type": [
"string",
"null"
]
},
"street": {
"description": "The street address",
"examples": [
"1600 Amphitheater Parkway"
],
"title": "Street Address",
"type": [
"string",
"null"
]
}
},
"title": "Address",
"type": [
"object",
"null"
]
},
"basicName": {
"additionalProperties": false,
"description": "A description of things name and an alternative name",
"properties": {
"altName": {
"description": "An alternate, often shortened name for the entity",
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full an complete name of the entity",
"title": "Full Name",
"type": [
"string",
"null"
]
}
},
"title": "Basic Name",
"type": [
"object",
"null"
]
},
"completeName": {
"additionalProperties": false,
"description": "A detailed description of a person, or others, name and variants of their name.",
"properties": {
"alias": {
"description": "An alias being used by a person often used to disguise someones real identity, sometimes used when booking hotel rooms or restaurants ",
"title": "Alias",
"type": [
"string",
"null"
]
},
"altName": {
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"birthName": {
"description": "A persons name at birth, also referred to as maiden name",
"title": "Birth Name",
"type": [
"string",
"null"
]
},
"contractualName": {
"title": "Contractual Name",
"type": [
"string",
"null"
]
},
"displayName": {
"title": "Display Name",
"type": [
"string",
"null"
]
},
"familyName": {
"description": "A persons family name, also referred to as surname",
"title": "Family Name",
"type": [
"string",
"null"
]
},
"firstGivenName": {
"description": "A person's first name, also referred to as given name",
"title": "First Given Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A complete name, typically a conjunction of familyName, firstGivenName and possibly other fields.",
"title": "Full Name",
"type": [
"string",
"null"
]
},
"moniker": {
"title": "Moniker",
"type": [
"string",
"null"
]
},
"nickname": {
"title": "Nickname",
"type": [
"string",
"null"
]
},
"prefix": {
"description": "A prefix that can indicate a persons gender or title",
"examples": [
"Mrs",
"Mr",
"Dr",
"General"
],
"title": "Prefix",
"type": [
"string",
"null"
]
},
"primaryName": {
"description": "A persons primary name, one they typically use, also often a combination of first, second and family name",
"title": "Primary Name",
"type": [
"string",
"null"
]
},
"pseudonym": {
"title": "Pseudonym",
"type": [
"string",
"null"
]
},
"scriptName": {
"title": "Script Name",
"type": [
"string",
"null"
]
},
"secondGivenName": {
"description": "A persons second given name, also referred to as middle name",
"title": "Second Given Name",
"type": [
"string",
"null"
]
},
"sortName": {
"title": "Sort Name",
"type": [
"string",
"null"
]
},
"suffix": {
"description": "A suffix, often used to indicate a title or classification",
"examples": [
"MBE",
"MD",
"RN",
"II",
"IV"
],
"title": "Suffix",
"type": [
"string",
"null"
]
},
"translatedName": {
"title": "Translated Name",
"type": [
"string",
"null"
]
}
},
"title": "Complete Name",
"type": "object"
},
"contact": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/Utility/properties/email",
"title": "Email"
},
"telephone": {
"$ref": "#/$defs/Utility/properties/telephone",
"title": "Telephone"
}
},
"title": "Contact",
"type": "object"
},
"coordinates": {
"additionalProperties": false,
"description": "A global positioning coordinate in compliance with WGS 84",
"properties": {
"latitude": {
"maximum": 90,
"minimum": -90,
"title": "latitude",
"type": "number"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"title": "longitude",
"type": "number"
}
},
"title": "Coordinates",
"type": [
"object",
"null"
]
},
"country": {
"description": "The country, as an ISO 3166-1 alpha-2 country code",
"examples": [
"US"
],
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": [
"string",
"null"
]
},
"email": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Email",
"type": "object"
},
"gender": {
"additionalProperties": false,
"description": "A person, or others, expressed or prefered gender and pronoun",
"properties": {
"gender": {
"description": "The gender by which an individual identifies",
"enum": [
"male",
"female",
"other",
"unknown",
null
],
"title": "Identifies as gender",
"type": [
"string",
"null"
]
},
"genderPronoun": {
"description": "An individuals pronoun of choice",
"enum": [
"he/him",
"she/her",
"ze/hir",
"they/their",
null
],
"title": "Preferred pronoun",
"type": [
"string",
"null"
]
}
},
"title": "Gender",
"type": [
"object",
"null"
]
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"minItems": 1,
"title": "Identifier",
"type": "array"
},
"language": {
"description": "An IETF BCP 47 language code",
"title": "Language",
"type": [
"string",
"null"
]
},
"note": {
"additionalProperties": false,
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": "string"
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": "string"
}
},
"title": "Note",
"type": [
"object",
"null"
]
},
"provenance": {
"additionalProperties": false,
"description": "A record of when something was changed and by whom.",
"properties": {
"CreatedBy": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"Origin": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Role": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"createdOn": {
"$ref": "#/$defs/Utility/properties/time/properties/dateTime"
},
"note": {
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"reason": {
"type": "string"
}
},
"title": "Provenance",
"type": "object"
},
"telephone": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Telephone",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2020-11-21"
],
"pattern": "\\d{4}-[01]\\d-[0-3]\\d",
"title": "Date",
"type": [
"string",
"null"
]
},
"dateTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2023-08-24T20:51:15Z\n2023-08-24T20:51:15.56Z\n2023-08-24T20:51:15+08:00\n2023-08-24T20:51:15.23-04:00"
],
"pattern": "^(?:19|20)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:|\\.\\d\\d)(?:Z|-0[1-9]|-1\\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\\d)|\\+[01]\\d|\\+2[0-3])(?:|:?[0-5]\\d)$",
"title": "Date & Time",
"type": [
"string",
"null"
]
},
"descriptiveTime": {
"additionalProperties": false,
"properties": {
"eventInTime": {
"description": "Describes a specific event that occurred",
"examples": [
"Hindenburg disaster",
"World Trade Center attack",
"Queen Elizabeth coronation"
],
"title": "Event in Time",
"type": "string"
},
"periodInDay": {
"examples": [
"Morning",
"Noon",
"Midnight",
"Afternoon",
"Night"
],
"title": "Period in Day",
"type": "string"
},
"periodInTime": {
"examples": [
"Ming dynasty",
"World War II",
"Jurassic period",
"20th century"
],
"title": "Period in Time",
"type": "string"
},
"relativeTime": {
"examples": [
"Later",
"Continuous",
"6 months earlier",
"A long time ago"
],
"title": "Relative Time",
"type": "string"
}
},
"title": "Descriptive Time",
"type": "object"
},
"durationTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"P2Y12M3D"
],
"pattern": "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$",
"title": "Duration of Time",
"type": [
"string",
"null"
]
},
"periodInTime": {
"additionalProperties": false,
"properties": {
"durationTime": {
"title": "Duration of Time",
"type": "string"
},
"endTime": {
"title": "End Time",
"type": "string"
},
"startTime": {
"title": "Start Time",
"type": "string"
}
},
"required": [
"startTime"
],
"title": "Period in Time",
"type": "object"
},
"timecode": {
"description": "SMPTE timecode",
"examples": [
"00:03:43:12"
],
"pattern": "^(?:(?:[0-1][0-9]|[0-2][0-3]):)(?:[0-5][0-9]:){2}(?:[0-2][0-9])$",
"title": "SMPTE Timcode in the format HH:MM:SS:FF. \nAssumes the frame rate is 23.98, 24, 25, 29.97 NDF, or 30",
"type": [
"string",
"null"
]
},
"timestamp": {
"title": "Timestamp",
"type": [
"number",
"null"
]
}
},
"title": "Time",
"type": "object"
},
"unitOfMeasurement": {
"additionalProperties": false,
"properties": {
"dimensions": {
"description": "Encode a set of measurements to describe a 2 or 3 dimensional object (metric, imperial or pixels)",
"properties": {
"depth": {
"description": "The depth or Z axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"height": {
"description": "The height or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"width": {
"description": "The width or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
}
},
"title": "dimensions",
"type": "object"
},
"linearDistance": {
"description": "Encode a measurement of distance using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
}
],
"title": "Linear Distance"
},
"weight": {
"description": "Encode a measurement of weight using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode weight using the metric system of measurement (kilogram, gram)",
"examples": [
"3kg7g"
],
"pattern": "^(\\d+kg)?(\\d+g)?$",
"type": "string"
},
{
"description": "Encode weight using the imperial system of measurement (pounds, ounces)",
"examples": [
"12lb14oz"
],
"pattern": "^(\\d+lb)?(\\d+oz)?$",
"type": "string"
}
],
"title": "weight"
}
},
"type": "object"
},
"versionNumber": {
"description": "A designation indicating a place in a sequence of versions",
"title": "Version Number",
"type": [
"string",
"number",
"null"
]
}
},
"title": "Utility Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
MovieLabs/OMC | cd414328a52bf5ed303bc9d941ee3e792e3539cc | 2024-05-24T03:07:54 | OMC-JSON/OMC-JSON-v2.0.schema.json | 6 | 2024-05-27T04:54:55.691858Z | {
"$comment": "Copyright 2021-2023 Motion Picture Laboratories, Inc.\nSPDX-License-Identifier: APACHE-2.0",
"$defs": {
"Asset": {
"additionalProperties": false,
"properties": {
"Asset": {
"additionalProperties": false,
"description": "A physical or digital object or collection of objects specific to the creation of the Creative Work.",
"properties": {
"Asset": {
"description": "The set of Assets that make up an an asset group and has a structuralType of 'assetGroup'",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"title": "Asset Group",
"type": [
"array",
"null"
]
},
"AssetSC": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
],
"title": "Structural Characteristics"
},
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"assetFC": {
"$ref": "#/$defs/Asset/properties/assetFC",
"title": "Asset Functional Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Asset",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"Alternative": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"Derivation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Asset Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset",
"type": [
"object"
]
},
"AssetSC": {
"$defs": {
"assetGroup": {
"additionalProperties": false,
"description": "Structural properties of an Asset Group",
"properties": {
"isOrdered": {
"type": [
"boolean",
"null"
]
}
},
"title": "Asset Group",
"type": "object"
},
"dimensions": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/dimensions"
},
"fileDetails": {
"additionalProperties": false,
"description": "Where opaque identifiers are used it can be useful to express naming for use in traditional file systems",
"properties": {
"fileExtension": {
"type": [
"string",
"null"
]
},
"fileName": {
"type": [
"string",
"null"
]
},
"filePath": {
"type": [
"string",
"null"
]
},
"mediaType": {
"type": [
"string",
"null"
]
}
},
"title": "File Details",
"type": "object"
},
"linkset": {
"additionalProperties": false,
"description": "When used with resolution system returning a linkset additional information can help disambiguate multiple linksets in the response.",
"properties": {
"mediaType": {
"type": [
"string",
"null"
]
},
"recordType": {
"type": [
"string",
"null"
]
}
},
"title": "Linkset",
"type": "object"
}
},
"additionalProperties": false,
"description": "Describes the form of an Asset along with the attributes specific to that asset\u2019s form",
"properties": {
"Carrier": {
"description": "For describing the physical storage device on which the digital assence is stored",
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
}
],
"title": "Carrier"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the participant",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "AssetSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"isAnalog": {
"description": "True if the Asset is an Analog Asset.",
"title": "Is Analog",
"type": [
"boolean",
"null"
]
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": false,
"description": "A set of properties that describe the asset in this form",
"properties": {
"assetGroup": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/assetGroup"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"dimensions": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/dimensions"
},
"fileDetails": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/fileDetails"
},
"linkset": {
"$ref": "#/$defs/Asset/properties/AssetSC/$defs/linkset"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"DerivationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Deriviation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"Representation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RepresentationOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Asset Structural Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Asset Structural Characteristics",
"type": "object"
},
"assetFC": {
"$defs": {
"empty": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"type": "object"
},
"generic": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"type": [
"object",
"null"
]
},
"functionalType": {
"not": {
"enum": [
"scd"
]
},
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
},
"scd": {
"additionalProperties": false,
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": false,
"properties": {
"component": {
"items": {
"properties": {
"Shot": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"type": "object"
},
"duration": {
"type": [
"string",
"null"
]
},
"recordEnd": {
"type": [
"string",
"null"
]
},
"recordStart": {
"type": [
"string",
"null"
]
},
"sourceEnd": {
"type": [
"string",
"null"
]
},
"sourceStart": {
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"functionalType": {
"const": "scd",
"type": "string"
}
},
"required": [
"functionalType"
],
"type": "object"
}
},
"description": "Describes the use or purpose of an Asset within the production process",
"oneOf": [
{
"description": "Allow for null",
"type": "null"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/empty",
"title": "Allow for empty object, no functional characteristics"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/generic",
"title": "A generic schema allowing any functional type and properties"
},
{
"$ref": "#/$defs/Asset/properties/assetFC/$defs/scd",
"title": "Functional characteristics for a Sequence Chronology Descriptor"
}
],
"title": "Asset Functional Characteristics"
}
},
"title": "Asset Definitions",
"type": "object"
},
"Infrastructure": {
"additionalProperties": false,
"properties": {
"Infrastructure": {
"additionalProperties": true,
"description": "The underlying systems and framework required for the production of the Creative Work; it is generally not specific to a particular Creative Work.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"InfrastructureSC": {
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Infrastructure",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"infrastructureFC": {
"$ref": "#/$defs/Infrastructure/properties/infrastructureFC",
"title": "Functional Characteristics"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure",
"type": "object"
},
"InfrastructureSC": {
"additionalProperties": false,
"description": "Describes the form of the Infrastructure along with the attributes specific to that infrastructure's form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityType": {
"const": "InfrastructureSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the infrastructure in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Infrastructure Structural Characteristics",
"type": "object"
},
"infrastructureFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Infrastructure within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Infrastructure Functional Characteristics",
"type": "object"
}
},
"title": "Infrastructure Definitions",
"type": "object"
},
"MediaCreationContext": {
"additionalProperties": false,
"properties": {
"Character": {
"additionalProperties": false,
"description": "A sentient entity (usually a person but not always) in the script whose specific identity is consequential to the narrative. A Character is generally identified by a specific name.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"characterName": {
"$ref": "#/$defs/Utility/properties/completeName",
"title": "Character Name"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the character",
"title": "Character Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Character",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "The primary name used for the character",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"profile": {
"additionalProperties": false,
"properties": {
"background": {
"additionalProperties": true,
"title": "background",
"type": "object"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"physicalCharacteristics": {
"additionalProperties": true,
"description": "Allows for the the description of certain physical characteristics on a character, things that might be useful to an art department, wardrobe or casting for example.",
"properties": {
"eyeColor": {
"description": "The color of the characters eyes",
"title": "Eye Color",
"type": "string"
},
"hairColor": {
"description": "The hair color of the character",
"examples": [
"Brown",
"Pink",
"Blonde",
""
],
"title": "Hair Color",
"type": "string"
},
"hairLength": {
"description": "The length of hair of the character",
"title": "Hair Length",
"type": "string"
},
"height": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/linearDistance",
"title": "height"
},
"species": {
"description": "A species to which this character belongs",
"examples": [
"Human",
"Borg",
"Goblin",
"Frog"
],
"title": "Species",
"type": "string"
},
"weight": {
"$ref": "#/$defs/Utility/properties/unitOfMeasurement/properties/weight",
"title": "weight"
}
},
"title": "Physical Characteristics",
"type": "object"
}
},
"title": "Profile",
"type": "object"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Character",
"type": "object"
},
"Context": {
"additionalProperties": true,
"description": "Informs scope within the construction process of a Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"type": "object"
}
]
},
"type": [
"array",
"null"
]
},
"For": {
"description": "The entities for which this Context applies to",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
}
]
},
"title": "Context For",
"type": [
"array",
"null"
]
},
"contextType": {
"description": "A classifiaction of the type of context represented",
"examples": [
"narrative",
"production"
],
"title": "Context Type",
"type": [
"string",
"null"
]
},
"contributesTo": {
"properties": {
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"contributor": {
"properties": {
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Context",
"title": "Entity Type",
"type": "string"
},
"features": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"featuresIn": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"for": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"has": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Participant/properties/Participant",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Sequence": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Slate": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the Context",
"title": "Context name",
"type": [
"string",
"null"
]
},
"neededBy": {
"properties": {
"Character": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"needs": {
"properties": {
"Effect": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeAudio": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeObject": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeStyling": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"NarrativeWardrobe": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"SpecialAction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"releated": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"representedBy": {
"properties": {
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"represents": {
"properties": {
"NarrativeScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"usedIn": {
"properties": {
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionScene": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"uses": {
"properties": {
"Asset": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Asset/properties/Asset",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"Infrastructure": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
},
"ProductionLocation": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation",
"type": "object"
},
{
"$ref": "#/$defs/core/properties/reference"
}
]
},
"type": [
"array",
"null"
]
}
},
"type": [
"object",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Context",
"type": "object"
},
"CreativeWork": {
"additionalProperties": false,
"description": "A uniquely identified production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"approximateLength": {
"$ref": "#/$defs/Utility/properties/time/properties/periodInTime/properties/durationTime",
"title": "Approximate Length"
},
"countryOfOrigin": {
"items": {
"$ref": "#/$defs/Utility/properties/country"
},
"title": "Country Of Origin",
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the creative work",
"title": "Creative Work Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "CreativeWork",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "The primary name used for the creative work",
"title": "Creative Work name",
"type": [
"string",
"null"
]
},
"originalLanguage": {
"items": {
"$ref": "#/$defs/Utility/properties/language"
},
"title": "Original Languages",
"type": [
"array",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"title": {
"additionalProperties": true,
"properties": {
"internalTitle": {
"description": "The internal title of the work",
"title": "Creative Work Internal Title",
"type": [
"string",
"null"
]
},
"officialTitle": {
"description": "The official title of the work",
"title": "Creative Work Official Title",
"type": [
"string",
"null"
]
},
"workingTitle": {
"description": "The working title of the work",
"title": "Creative Work Working Title",
"type": [
"string",
"null"
]
}
},
"title": "Creative Work Title",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Creative Work",
"type": "object"
},
"Depiction": {
"additionalProperties": false,
"description": "The representation of something from a narrative entity by a production entity in the Creative Work, specified or implied by the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depictor": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
],
"type": "object"
},
"Depicts": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
}
],
"type": "object"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"depictionType": {
"description": "A categorization of the type of depiction",
"enum": [
"depiction",
"portrayal"
],
"title": "Object type",
"type": "string"
},
"description": {
"description": "A brief description of the depiction or portrayal",
"title": "Depiction Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Depiction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Depiction Styling Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Depiction",
"type": "object"
},
"Effect": {
"additionalProperties": false,
"description": "An on screen visual effect considered essential to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative effect",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"effectType": {
"description": "A categorization of the type of effect.",
"enum": [
"effect",
"specialEffect",
"visualEffect"
],
"title": "Object type",
"type": "string"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Effect",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the effect",
"title": "Narrative Effect Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Effect",
"type": "object"
},
"NarrativeAudio": {
"additionalProperties": false,
"description": "A named piece of audio significant to the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative audio",
"title": "Narrative Audio Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAudio",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the audio clip",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type of audio.",
"enum": [
"audio",
"soundEffect",
"music"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Audio",
"type": "object"
},
"NarrativeLocation": {
"additionalProperties": false,
"description": "A location specified or implied by the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative location",
"title": "Narrative Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Narrative Location Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Location",
"type": "object"
},
"NarrativeObject": {
"additionalProperties": false,
"description": "A named object related to or interacting with characters that is implied or understood to be necessary for the narrative. Includes items like props, wardrobe, set dressing and vehicles.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative object",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeObject",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the object",
"title": "Narrative Object Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A departmental categorization for the object.",
"enum": [
"narrativeObject",
"narrativeProp",
"narrativeGreenery",
"narrativeVehicle",
"narrativeSetDressing"
],
"title": "Object type",
"type": "string"
},
"quantity": {
"title": "Quantity",
"type": [
"string",
"number"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"size": {
"title": "Size",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Object",
"type": "object"
},
"NarrativeScene": {
"additionalProperties": false,
"description": "Taken from the narrative itself and traditionally defined by creative intent and typically a unity of time, place, action, or theme.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative scene",
"title": "Narrative Scene Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the scene",
"title": "Scene Name",
"type": "string"
},
"sceneName": {
"additionalProperties": true,
"description": "A human readable name for the scene",
"properties": {
"altName": {
"description": "An alternate, often shorter, name used in applications to identify the scenes",
"title": "Scene alternate name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A full descriptive name for the scene",
"title": "Scene full name",
"type": [
"string",
"null"
]
}
},
"title": "Narrative Scene Name",
"type": "object"
},
"sceneNumber": {
"description": "A number used in the script to refer to the scene",
"title": "Scene Number",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
},
"slugline": {
"items": {
"additionalProperties": false,
"description": "An arbitrary note or comment pertaining to the entity",
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": [
"string",
"null"
]
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": [
"string",
"null"
]
}
},
"title": "Slugline",
"type": "object"
},
"title": "Slugline",
"type": "array"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Scene",
"type": "object"
},
"NarrativeStyling": {
"additionalProperties": false,
"description": "Styling required to prepare an actor for their role",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative styling",
"title": "Narrative Styling Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeStyling",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type styling.",
"enum": [
"narrativeStyling",
"narrativeHair",
"narrativeMakeup",
"narrativeProsthetics"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Styling",
"type": "object"
},
"NarrativeWardrobe": {
"additionalProperties": false,
"description": "The clothing for a Character in the narrative.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the narrative wardrobe",
"title": "Narrative Wardrobe Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeWardrobe",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the styling",
"title": "Narrative Styling Name",
"type": [
"string",
"null"
]
},
"narrativeType": {
"description": "A categorization of the type wardrobe",
"enum": [
"narrativeWardrobe"
],
"title": "Object type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Narrative Wardrobe",
"type": "object"
},
"ProductionLocation": {
"additionalProperties": false,
"description": "A real place that is used to depict the Narrative Location or used for creating the production.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the production location",
"title": "Production Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionLocation",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"locationType": {
"default": "production",
"description": "Describes whether this is production location or more specifically a shooting location",
"enum": [
"production",
"shooting"
],
"type": "string"
},
"name": {
"description": "A human readable name for the location",
"title": "Production Location Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Location",
"type": "object"
},
"ProductionScene": {
"additionalProperties": false,
"description": "Defined either by explicit divisions in the structure of the Script, e.g., by a Slugline, or by additional capture for use in the Creative Work that is not tied to any particular Scene in the Script.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the production scene",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "ProductionScene",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the production scene",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"sceneDescriptor": {
"description": "An alphanumeric reference to a Production Scene",
"title": "Scene Descriptor",
"type": [
"string",
"null"
]
},
"sceneHeader": {
"description": "Used when referring to the Production Scene. It is generally synonymous with Slugline and is used to divide a Script into scenes.",
"title": "Scene Header",
"type": [
"string",
"null"
]
},
"sceneName": {
"$ref": "#/$defs/Utility/properties/basicName",
"title": "Scene Name"
},
"sceneNumber": {
"description": "A number tied to a Slugline when a Script is locked",
"title": "Scene Number",
"type": [
"null",
"string"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Production Scene",
"type": "object"
},
"Sequence": {
"additionalProperties": false,
"description": "A sequence of shots linked to creative intent.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"SCD": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
],
"title": "Sequence Chronology Descriptor"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the sequence",
"title": "Sequence description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Sequence",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the editorial sequence",
"title": "Sequence Name",
"type": [
"string",
"null"
]
},
"provenance": {
"$ref": "#/$defs/Utility/properties/provenance",
"title": "Provenance"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"sequenceType": {
"enum": [
"vfx",
"editorial",
"image",
"animation",
"color"
],
"title": "Sequence Type",
"type": "string"
},
"version": {
"additionalProperties": false,
"description": "A particular form, variant, or representation of an Asset that differs in some way from its source Asset.",
"properties": {
"Alternative": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"Revision": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"RevisionOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"Variant": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"type": "array"
},
"VariantOf": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
}
]
},
"annotation": {
"description": "A collection of notes specific to this version",
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the version",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"name": {
"title": "A name for this specific version of the Asset",
"type": "string"
},
"versionNumber": {
"$ref": "#/$defs/Utility/properties/versionNumber"
}
},
"title": "Sequence Version Information",
"type": "object"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Sequence",
"type": "object"
},
"Slate": {
"additionalProperties": false,
"description": "Used to capture key identifying information about what is being recorded on any given setup and take.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"CreativeWork": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
}
]
},
"Director": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Director",
"type": [
"array",
"null"
]
},
"cameraLabel": {
"description": "Label for the Camera responsible for the Capture, usually related to the role and responsibility of the group operating it and usually a single upper-case letter starting with A.",
"title": "Camera Label",
"type": [
"string",
"null"
]
},
"cameraRoll": {
"description": "Identifier for a group of events captured together on the same camera on the same media.",
"title": "Camera Roll",
"type": [
"string",
"null"
]
},
"cameraUnit": {
"description": "A group of Participants responsible for shooting some element of a Scene, e.g., a Main Unit or Second Unit.",
"title": "Camera Unit",
"type": [
"string",
"null"
]
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the slate",
"title": "Slate description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Slate",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the Slate",
"title": "Slate Name",
"type": [
"string",
"null"
]
},
"recordingFPS": {
"description": "Frames per second recorded by the camera.",
"title": "Recording FPS",
"type": [
"number",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"shootDate": {
"$ref": "#/$defs/Utility/properties/time/properties/date",
"description": "The date of capture or creation",
"title": "Shoot Date"
},
"shootDay": {
"description": "The number of the day on the shooting schedule.",
"title": "Shoot Day",
"type": [
"number",
"string",
"null"
]
},
"slateUID": {
"description": "Slate Unique Identifier",
"title": "Slate UID",
"type": "string"
},
"soundRoll": {
"description": "Identifier for a group of audio events captured together on the same recording device and same media.",
"title": "Sound Roll",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Slate",
"type": "object"
},
"SpecialAction": {
"additionalProperties": false,
"description": "An action or set of actions that are performed and require additional choreography or supervision.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"actionType": {
"description": "A categorization of the type action.",
"enum": [
"action",
"stunt",
"choreography",
"fight",
"motionCapture",
"marine",
"aerial"
],
"title": "Object type",
"type": "string"
},
"customData": {
"$ref": "#/$defs/core/properties/customData",
"title": "Custom Data"
},
"description": {
"description": "A brief description of the narrative action",
"title": "Narrative Object Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "NarrativeAction",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the action",
"title": "Narrative Action Name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Special Action",
"type": "object"
}
},
"title": "Media Creation Context Definitions",
"type": "object"
},
"Participant": {
"additionalProperties": false,
"properties": {
"Department": {
"additionalProperties": false,
"description": "Part of a larger Organization with a particular set of responsibilities on the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"departmentName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"description": {
"description": "A brief description of the department",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Department",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the department, primarily for use as a label",
"title": "Department name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "department",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Department",
"type": "object"
},
"Organization": {
"additionalProperties": false,
"description": "A legal entity or groups of people associated with the production.. with a particular purpose relative to the production.",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the organization",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Organization",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the organization, primarily for use as a label",
"title": "Organization name",
"type": [
"string",
"null"
]
},
"organizationName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "organization",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Organization",
"type": "object"
},
"Participant": {
"additionalProperties": false,
"description": "The entities (people, organizations, and services) that are responsible for the production of the Creative Work.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": [
"array",
"null"
]
},
"Depiction": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
}
]
},
"type": [
"array",
"null"
]
},
"Participant": {
"description": "Any Participants that are members of this Participant group",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"title": "Participant",
"type": "array"
},
"ParticipantSC": {
"description": "Describes the form of a Participant along with the attributes specific to that Participant\u2019s form.",
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
}
],
"title": "Participant Structural Characteristics",
"type": "object"
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Participant",
"title": "Participant Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the participant",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Participant",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the participant, primarily for use as a label",
"title": "Participant name",
"type": [
"string",
"null"
]
},
"participantFC": {
"additionalProperties": true,
"description": "The use or purpose of a Participant within the production process",
"properties": {
"Role": {
"description": "",
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"type": "array"
},
"functionalType": {
"title": "Functional Type",
"type": [
"string",
"null"
]
},
"jobTitle": {
"description": "A formal name for the position a Person holds in relation to the production, usually associated with a specific set of responsibilities.",
"title": "Job Title",
"type": [
"string",
"null"
]
}
},
"title": "Participant Functional Characteristics",
"type": "object"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Participant",
"type": "object"
},
"Person": {
"additionalProperties": false,
"description": "People are the individuals that are associated with the production",
"properties": {
"Location": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Utility/properties/Location"
}
]
},
"contact": {
"$ref": "#/$defs/Utility/properties/contact",
"description": "Contact information for the Person",
"title": "Person Contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the person",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Person",
"title": "Entity Type",
"type": "string"
},
"gender": {
"$ref": "#/$defs/Utility/properties/gender"
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"title": "Identifier",
"type": "array"
},
"jobTitle": {
"description": "A persons job title (as distinct from a specific role)",
"title": "Job Title",
"type": [
"string",
"null"
]
},
"name": {
"description": "A human readable name for the person, convenient for use in UI's etc.",
"title": "Person name",
"type": [
"string",
"null"
]
},
"personName": {
"$ref": "#/$defs/Utility/properties/completeName",
"description": "The canonical name or set of names and titles for the Person",
"title": "Person Name"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralType": {
"const": "person",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Person",
"type": "object"
},
"Role": {
"additionalProperties": false,
"description": "A set of properties that define the role of a participant within the production",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"title": "Role Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Role",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"examples": [
"Director",
"Producer",
"Composer",
"Art Department"
],
"title": "Role Name",
"type": [
"string",
"null"
]
},
"roleType": {
"description": "The specific role, typically used in authorization systems",
"title": "Role Type",
"type": "string"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Role",
"type": "object"
},
"Service": {
"additionalProperties": false,
"description": "A computer driven agent that can perform tasks given the proper context and structured data.",
"properties": {
"contact": {
"$ref": "#/$defs/Utility/properties/contact"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A brief description of the service",
"title": "Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Service",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"name": {
"description": "A human readable name for the service, primarily for use as a label",
"title": "Service name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"serviceName": {
"$ref": "#/$defs/Utility/properties/basicName"
},
"structuralType": {
"const": "service",
"type": "string"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Service",
"type": "object"
}
},
"title": "Participant Definitions",
"type": "object"
},
"Task": {
"additionalProperties": false,
"properties": {
"Task": {
"additionalProperties": true,
"description": "A piece of work to be done and completed as a step in the production process.",
"properties": {
"Context": {
"$ref": "#/$defs/MediaCreationContext/properties/Context",
"title": "Asset Context"
},
"TaskSC": {
"$ref": "#/$defs/Task/properties/TaskSC",
"title": "Structural Characteristics"
},
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"description": {
"description": "A human readable description of the asset",
"title": "Asset description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Task",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the asset",
"title": "Asset name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"taskFC": {
"$ref": "#/$defs/Task/properties/taskFC",
"title": "Functional Characteristics"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task",
"type": "object"
},
"TaskSC": {
"additionalProperties": true,
"description": "Describes the form of Task along with the attributes specific to that task\u2019s form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "TaskSC",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
},
"structuralProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the asset in this form",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Structural Properties",
"type": [
"object",
"null"
]
},
"structuralType": {
"description": "A structured description of the the assets form",
"examples": [
"assetGroup",
"digital.image",
"analog.movingImage"
],
"title": "Structural Type",
"type": [
"string",
"null"
]
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Task Structural Characteristics",
"type": "object"
},
"taskFC": {
"additionalProperties": true,
"description": "Describes the use or purpose of an Asset within the production process",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
},
"functionalProperties": {
"additionalProperties": true,
"description": "A set of properties that describe the tasks functional use",
"properties": {
"customData": {
"$ref": "#/$defs/core/properties/customData"
}
},
"title": "Functional Properties",
"type": [
"object",
"null"
]
},
"functionalType": {
"description": "The use or purpose of a Task within the production process.",
"title": "Functional Type",
"type": [
"string",
"null"
]
}
},
"title": "Task Functional Characteristics",
"type": "object"
}
},
"title": "Task Definitions",
"type": "object"
},
"Utility": {
"additionalProperties": false,
"description": "Common data models and data structures used in multiple places and in multiple ways in a larger system.",
"properties": {
"Location": {
"additionalProperties": false,
"description": "A particular place or position either in either the real world or the narrative world.",
"properties": {
"Context": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
}
]
},
"type": "array"
},
"address": {
"$ref": "#/$defs/Utility/properties/address",
"title": "Address"
},
"coordinates": {
"$ref": "#/$defs/Utility/properties/coordinates",
"title": "Coordinates"
},
"description": {
"description": "A brief description of the location",
"title": "Location Description",
"type": [
"string",
"null"
]
},
"entityInfo": {
"$ref": "#/$defs/core/properties/entityInfo",
"title": "Entity Information"
},
"entityType": {
"const": "Location",
"title": "Entity Type",
"type": "string"
},
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier",
"title": "Identifier"
},
"name": {
"description": "A human readable name for the location",
"title": "Location name",
"type": [
"string",
"null"
]
},
"schemaVersion": {
"$ref": "#/$defs/core/properties/schemaVersion",
"title": "Schema Version"
}
},
"required": [
"entityType",
"identifier",
"schemaVersion"
],
"title": "Location",
"type": "object"
},
"address": {
"additionalProperties": false,
"description": "A postal address or identifiable location of a place or building",
"properties": {
"country": {
"$ref": "#/$defs/Utility/properties/country",
"title": "Country"
},
"locality": {
"description": "The locality in which the street address is, and which is in the region.",
"examples": [
"Mountain View"
],
"title": "Address locality",
"type": [
"string",
"null"
]
},
"postalCode": {
"description": "A zip or postal code",
"examples": [
"94534"
],
"title": "Zip or Postal Code",
"type": [
"string",
"null"
]
},
"region": {
"description": "The region in which the locality is, and which is in the country",
"examples": [
"California"
],
"title": "Address region",
"type": [
"string",
"null"
]
},
"street": {
"description": "The street address",
"examples": [
"1600 Amphitheater Parkway"
],
"title": "Street Address",
"type": [
"string",
"null"
]
}
},
"title": "Address",
"type": [
"object",
"null"
]
},
"basicName": {
"additionalProperties": false,
"description": "A description of things name and an alternative name",
"properties": {
"altName": {
"description": "An alternate, often shortened name for the entity",
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "The full an complete name of the entity",
"title": "Full Name",
"type": [
"string",
"null"
]
}
},
"title": "Basic Name",
"type": [
"object",
"null"
]
},
"completeName": {
"additionalProperties": false,
"description": "A detailed description of a person, or others, name and variants of their name.",
"properties": {
"alias": {
"description": "An alias being used by a person often used to disguise someones real identity, sometimes used when booking hotel rooms or restaurants ",
"title": "Alias",
"type": [
"string",
"null"
]
},
"altName": {
"title": "Alternate Name",
"type": [
"string",
"null"
]
},
"birthName": {
"description": "A persons name at birth, also referred to as maiden name",
"title": "Birth Name",
"type": [
"string",
"null"
]
},
"contractualName": {
"title": "Contractual Name",
"type": [
"string",
"null"
]
},
"displayName": {
"title": "Display Name",
"type": [
"string",
"null"
]
},
"familyName": {
"description": "A persons family name, also referred to as surname",
"title": "Family Name",
"type": [
"string",
"null"
]
},
"firstGivenName": {
"description": "A person's first name, also referred to as given name",
"title": "First Given Name",
"type": [
"string",
"null"
]
},
"fullName": {
"description": "A complete name, typically a conjunction of familyName, firstGivenName and possibly other fields.",
"title": "Full Name",
"type": [
"string",
"null"
]
},
"moniker": {
"title": "Moniker",
"type": [
"string",
"null"
]
},
"nickname": {
"title": "Nickname",
"type": [
"string",
"null"
]
},
"prefix": {
"description": "A prefix that can indicate a persons gender or title",
"examples": [
"Mrs",
"Mr",
"Dr",
"General"
],
"title": "Prefix",
"type": [
"string",
"null"
]
},
"primaryName": {
"description": "A persons primary name, one they typically use, also often a combination of first, second and family name",
"title": "Primary Name",
"type": [
"string",
"null"
]
},
"pseudonym": {
"title": "Pseudonym",
"type": [
"string",
"null"
]
},
"scriptName": {
"title": "Script Name",
"type": [
"string",
"null"
]
},
"secondGivenName": {
"description": "A persons second given name, also referred to as middle name",
"title": "Second Given Name",
"type": [
"string",
"null"
]
},
"sortName": {
"title": "Sort Name",
"type": [
"string",
"null"
]
},
"suffix": {
"description": "A suffix, often used to indicate a title or classification",
"examples": [
"MBE",
"MD",
"RN",
"II",
"IV"
],
"title": "Suffix",
"type": [
"string",
"null"
]
},
"translatedName": {
"title": "Translated Name",
"type": [
"string",
"null"
]
}
},
"title": "Complete Name",
"type": "object"
},
"contact": {
"additionalProperties": false,
"properties": {
"email": {
"$ref": "#/$defs/Utility/properties/email",
"title": "Email"
},
"telephone": {
"$ref": "#/$defs/Utility/properties/telephone",
"title": "Telephone"
}
},
"title": "Contact",
"type": "object"
},
"coordinates": {
"additionalProperties": false,
"description": "A global positioning coordinate in compliance with WGS 84",
"properties": {
"latitude": {
"maximum": 90,
"minimum": -90,
"title": "latitude",
"type": "number"
},
"longitude": {
"maximum": 180,
"minimum": -180,
"title": "longitude",
"type": "number"
}
},
"title": "Coordinates",
"type": [
"object",
"null"
]
},
"country": {
"description": "The country, as an ISO 3166-1 alpha-2 country code",
"examples": [
"US"
],
"maxLength": 2,
"minLength": 2,
"title": "Country",
"type": [
"string",
"null"
]
},
"email": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Email",
"type": "object"
},
"gender": {
"additionalProperties": false,
"description": "A person, or others, expressed or prefered gender and pronoun",
"properties": {
"gender": {
"description": "The gender by which an individual identifies",
"enum": [
"male",
"female",
"other",
"unknown",
null
],
"title": "Identifies as gender",
"type": [
"string",
"null"
]
},
"genderPronoun": {
"description": "An individuals pronoun of choice",
"enum": [
"he/him",
"she/her",
"ze/hir",
"they/their",
null
],
"title": "Preferred pronoun",
"type": [
"string",
"null"
]
}
},
"title": "Gender",
"type": [
"object",
"null"
]
},
"identifier": {
"description": "An identifier uniquely identifies an entity within a particular scope.",
"items": {
"additionalProperties": false,
"properties": {
"combinedForm": {
"description": "A combination of the Identifier Scope and Value that is useful for utilizing the identifier in a system, for example a URN (URN:ID:IdentifierScope:IdentifierValue).",
"title": "Identifier Combined Form",
"type": "string"
},
"identifierScope": {
"description": "The universe within which an identifier is valid and unique.",
"title": "Identifier Scope",
"type": "string"
},
"identifierValue": {
"description": "A string of characters that uniquely identifies an object within a particular scope.",
"title": "Identifier Value",
"type": "string"
},
"url": {
"description": "A URL or IRI that can be used for resolving the Identifier Value within the Identifier Scope.",
"title": "URL",
"type": "string"
}
},
"required": [
"identifierScope",
"identifierValue"
],
"type": "object"
},
"minItems": 1,
"title": "Identifier",
"type": "array"
},
"language": {
"description": "An IETF BCP 47 language code",
"title": "Language",
"type": [
"string",
"null"
]
},
"note": {
"additionalProperties": false,
"properties": {
"text": {
"description": "The text of the note or annotation",
"title": "Text",
"type": "string"
},
"title": {
"description": "A title for the note or annotation",
"title": "Title",
"type": "string"
}
},
"title": "Note",
"type": [
"object",
"null"
]
},
"provenance": {
"additionalProperties": false,
"description": "A record of when something was changed and by whom.",
"properties": {
"CreatedBy": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
}
]
},
"Origin": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
}
]
},
"Role": {
"oneOf": [
{
"$ref": "#/$defs/core/properties/reference"
},
{
"$ref": "#/$defs/Participant/properties/Role"
}
]
},
"createdOn": {
"$ref": "#/$defs/Utility/properties/time/properties/dateTime"
},
"note": {
"items": {
"$ref": "#/$defs/Utility/properties/note"
},
"type": "array"
},
"reason": {
"type": "string"
}
},
"title": "Provenance",
"type": "object"
},
"telephone": {
"additionalProperties": false,
"properties": {
"business": {
"title": "Business",
"type": [
"string",
"null"
]
},
"personal": {
"title": "Personal",
"type": [
"string",
"null"
]
}
},
"title": "Telephone",
"type": "object"
},
"time": {
"additionalProperties": false,
"properties": {
"date": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2020-11-21"
],
"pattern": "\\d{4}-[01]\\d-[0-3]\\d",
"title": "Date",
"type": [
"string",
"null"
]
},
"dateTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"2023-08-24T20:51:15Z\n2023-08-24T20:51:15.56Z\n2023-08-24T20:51:15+08:00\n2023-08-24T20:51:15.23-04:00"
],
"pattern": "^(?:19|20)\\d{2}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\\d|3[01])T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:|\\.\\d\\d)(?:Z|-0[1-9]|-1\\d|-2[0-3]|-00:?(?:0[1-9]|[1-5]\\d)|\\+[01]\\d|\\+2[0-3])(?:|:?[0-5]\\d)$",
"title": "Date & Time",
"type": [
"string",
"null"
]
},
"descriptiveTime": {
"additionalProperties": false,
"properties": {
"eventInTime": {
"description": "Describes a specific event that occurred",
"examples": [
"Hindenburg disaster",
"World Trade Center attack",
"Queen Elizabeth coronation"
],
"title": "Event in Time",
"type": "string"
},
"periodInDay": {
"examples": [
"Morning",
"Noon",
"Midnight",
"Afternoon",
"Night"
],
"title": "Period in Day",
"type": "string"
},
"periodInTime": {
"examples": [
"Ming dynasty",
"World War II",
"Jurassic period",
"20th century"
],
"title": "Period in Time",
"type": "string"
},
"relativeTime": {
"examples": [
"Later",
"Continuous",
"6 months earlier",
"A long time ago"
],
"title": "Relative Time",
"type": "string"
}
},
"title": "Descriptive Time",
"type": "object"
},
"durationTime": {
"description": "Should be formatted to comply with ISO 8601",
"examples": [
"P2Y12M3D"
],
"pattern": "^(-?)P(?=.)((\\d+)Y)?((\\d+)M)?((\\d+)D)?(T(?=.)((\\d+)H)?((\\d+)M)?(\\d*(\\.\\d+)?S)?)?$",
"title": "Duration of Time",
"type": [
"string",
"null"
]
},
"periodInTime": {
"additionalProperties": false,
"properties": {
"durationTime": {
"title": "Duration of Time",
"type": "string"
},
"endTime": {
"title": "End Time",
"type": "string"
},
"startTime": {
"title": "Start Time",
"type": "string"
}
},
"required": [
"startTime"
],
"title": "Period in Time",
"type": "object"
},
"timecode": {
"description": "SMPTE timecode",
"examples": [
"00:03:43:12"
],
"pattern": "^(?:(?:[0-1][0-9]|[0-2][0-3]):)(?:[0-5][0-9]:){2}(?:[0-2][0-9])$",
"title": "SMPTE Timcode in the format HH:MM:SS:FF. \nAssumes the frame rate is 23.98, 24, 25, 29.97 NDF, or 30",
"type": [
"string",
"null"
]
},
"timestamp": {
"title": "Timestamp",
"type": [
"number",
"null"
]
}
},
"title": "Time",
"type": "object"
},
"unitOfMeasurement": {
"additionalProperties": false,
"properties": {
"dimensions": {
"description": "Encode a set of measurements to describe a 2 or 3 dimensional object (metric, imperial or pixels)",
"properties": {
"depth": {
"description": "The depth or Z axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"height": {
"description": "The height or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
},
"width": {
"description": "The width or X axis of the object",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
},
{
"description": "Encode a measurement of the number of pixels, typically in a digital image",
"examples": [
"250px"
],
"pattern": "^(\\d+px)$",
"type": "string"
}
]
}
},
"title": "dimensions",
"type": "object"
},
"linearDistance": {
"description": "Encode a measurement of distance using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode distance using the metric system of measurement (kilometer, meter, centimetre, millimeter",
"examples": [
"100m",
"6km2m56cm12mm"
],
"pattern": "^-?(\\d+km)?(\\d+m)?(\\d+cm)?(\\d+mm)?$",
"type": "string"
},
{
"description": "Encode distance using the imperial system of measurement (miles, feet, inches)",
"examples": [
"2000ft",
"2mi12ft6in"
],
"pattern": "^-?(\\d+mi)?(\\d+ft)?(\\d+in)?$",
"type": "string"
}
],
"title": "Linear Distance"
},
"weight": {
"description": "Encode a measurement of weight using the imperial or metric system",
"oneOf": [
{
"type": "null"
},
{
"description": "Encode weight using the metric system of measurement (kilogram, gram)",
"examples": [
"3kg7g"
],
"pattern": "^(\\d+kg)?(\\d+g)?$",
"type": "string"
},
{
"description": "Encode weight using the imperial system of measurement (pounds, ounces)",
"examples": [
"12lb14oz"
],
"pattern": "^(\\d+lb)?(\\d+oz)?$",
"type": "string"
}
],
"title": "weight"
}
},
"type": "object"
},
"versionNumber": {
"description": "A designation indicating a place in a sequence of versions",
"title": "Version Number",
"type": [
"string",
"number",
"null"
]
}
},
"title": "Utility Definitions",
"type": "object"
},
"core": {
"additionalProperties": false,
"description": "Helper objects used in building the schema",
"properties": {
"customData": {
"additionalProperties": true,
"description": "A user defined set of custom data in the payload of the instance, used where the formal schema lacks required properties",
"title": "Custom Data",
"type": "object"
},
"entityInfo": {
"additionalProperties": false,
"description": "Reserved for future use to describe specific details about the instance of the entity",
"title": "Entity Information",
"type": [
"object",
"null"
]
},
"reference": {
"additionalProperties": false,
"description": "An identifier that references another entity in the graph",
"properties": {
"identifier": {
"$ref": "#/$defs/Utility/properties/identifier"
}
},
"title": "Reference entity",
"type": [
"object",
"null"
]
},
"rootArray": {
"items": {
"anyOf": [
{
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
{
"$ref": "#/$defs/Participant/properties/Participant"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
{
"$ref": "#/$defs/Utility/properties/Location"
},
{
"$ref": "#/$defs/Participant/properties/Role"
},
{
"$ref": "#/$defs/Participant/properties/Person"
},
{
"$ref": "#/$defs/Participant/properties/Department"
},
{
"$ref": "#/$defs/Participant/properties/Organization"
},
{
"$ref": "#/$defs/Participant/properties/Service"
},
{
"$ref": "#/$defs/Asset/properties/Asset"
},
{
"$ref": "#/$defs/Asset/properties/AssetSC"
},
{
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
{
"$ref": "#/$defs/Infrastructure/properties/Infrastructure"
},
{
"$ref": "#/$defs/Infrastructure/properties/InfrastructureSC"
},
{
"$ref": "#/$defs/Task/properties/Task"
},
{
"$ref": "#/$defs/Task/properties/TaskSC"
}
]
},
"type": "array"
},
"rootObject": {
"additionalProperties": false,
"properties": {
"Asset": {
"items": {
"$ref": "#/$defs/Asset/properties/Asset"
},
"title": "Asset",
"type": "array"
},
"AssetSC": {
"items": {
"$ref": "#/$defs/Asset/properties/AssetSC"
},
"title": "Asset Structural Characteristics",
"type": "array"
},
"Character": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Character"
},
"title": "Character",
"type": "array"
},
"Context": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Context"
},
"title": "Context",
"type": "array"
},
"CreativeWork": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/CreativeWork"
},
"title": "Creative Work",
"type": "array"
},
"Department": {
"items": {
"$ref": "#/$defs/Participant/properties/Department"
},
"title": "Department",
"type": "array"
},
"Depiction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Depiction"
},
"title": "Context",
"type": "array"
},
"Effect": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Effect"
},
"title": "Effect",
"type": "array"
},
"Location": {
"items": {
"$ref": "#/$defs/Utility/properties/Location"
},
"title": "Location",
"type": "array"
},
"NarrativeAudio": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeAudio"
},
"title": "Narrative Audio",
"type": "array"
},
"NarrativeLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeLocation"
},
"title": "Narrative Location",
"type": "array"
},
"NarrativeObject": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeObject"
},
"title": "Narrative Object",
"type": "array"
},
"NarrativeScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeScene"
},
"title": "Narrative Scene",
"type": "array"
},
"NarrativeStyling": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeStyling"
},
"title": "Narrative Styling",
"type": "array"
},
"NarrativeWardrobe": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/NarrativeWardrobe"
},
"title": "Narrative Wardrobe",
"type": "array"
},
"Organization": {
"items": {
"$ref": "#/$defs/Participant/properties/Organization"
},
"title": "Organization",
"type": "array"
},
"Participant": {
"items": {
"$ref": "#/$defs/Participant/properties/Participant"
},
"title": "Participant",
"type": "array"
},
"Person": {
"items": {
"$ref": "#/$defs/Participant/properties/Person"
},
"title": "Person",
"type": "array"
},
"ProductionLocation": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionLocation"
},
"title": "Production Location",
"type": "array"
},
"ProductionScene": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/ProductionScene"
},
"title": "Production Scene",
"type": "array"
},
"Role": {
"items": {
"$ref": "#/$defs/Participant/properties/Role"
},
"title": "Service",
"type": "array"
},
"Sequence": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Sequence"
},
"title": "Sequence",
"type": "array"
},
"Service": {
"items": {
"$ref": "#/$defs/Participant/properties/Service"
},
"title": "Service",
"type": "array"
},
"Slate": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/Slate"
},
"title": "Slate",
"type": "array"
},
"SpecialAction": {
"items": {
"$ref": "#/$defs/MediaCreationContext/properties/SpecialAction"
},
"title": "Special Action",
"type": "array"
}
},
"type": "object"
},
"schemaVersion": {
"default": "https://movielabs.com/omc/json/schema/v2.0",
"description": "Describes the version of OMC-JSON schema that was used to create this instance",
"enum": [
"https://movielabs.com/omc/json/schema/v2.0"
],
"title": "Schema Version",
"type": "string"
}
},
"title": "Core",
"type": "object"
}
},
"$id": "https://movielabs.com/omc/json/schema/v2.0",
"$schema": "https://json-schema.org/draft/2019-09/schema",
"oneOf": [
{
"$ref": "#/$defs/core/properties/rootObject"
},
{
"$ref": "#/$defs/core/properties/rootArray"
}
],
"title": "OMC-JSON schema v2.0"
} | Apache-2.0 | en |
rik-org/rik | 0f255b67a1a513677be9bc57c0cbbefbbb67ff82 | 2023-04-12T11:53:40 | docs/src/workloads/schema-v1.json | 68 | 2024-05-28T02:20:54.188222Z | {
"$id": "https://rik-org.github.io/rik/workloads/schema-v1.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"description": "Reference for workload in RIK with apiVersion v1",
"properties": {
"apiVersion": {
"default": "v1",
"description": "The version associated to the current schema",
"type": "string"
},
"kind": {
"description": "The kind of the resource",
"enum": [
"Pod",
"Function"
],
"type": "string"
},
"name": {
"description": "Unique name of the workload",
"type": "string"
},
"replicas": {
"description": "Number of replicas expected (won't be deployed)",
"minimum": 1,
"type": "integer"
},
"spec": {
"description": "Full specification of the workload",
"properties": {
"containers": {
"description": "List of containers to be deployed",
"items": {
"properties": {
"image": {
"description": "Image to be used for the container",
"type": "string"
},
"name": {
"description": "Name of the container",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"function": {
"description": "Function to be deployed",
"properties": {
"execution": {
"properties": {
"rootfs": {
"description": "Rootfs to be used for the container, must a be URL that can be publicly accesed",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"required": [
"containers",
"function"
],
"type": "object"
}
},
"required": [
"apiVersion",
"kind",
"name",
"replicas",
"spec"
],
"title": "Workload-v1",
"type": "object"
} | Apache-2.0 | en |
yaegassy/coc-php-cs-fixer | aa1728ab8bcc5bb27186690c04e7250fb056d515 | 2022-07-14T00:51:22 | schemas/pint-schema.json | 31 | 2024-05-28T01:43:08.708278Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "There should be one or no space before colon, and one space after it in return type declarations, according to configuration."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type operator.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type operator.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
yaegassy/coc-php-cs-fixer | 1de7dcdf0c457d793364fdfe06e0d8b631af5dca | 2022-07-05T08:05:16 | schemas/pint-schema.json | 31 | 2024-05-28T01:43:08.708278Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "There should be one or no space before colon, and one space after it in return type declarations, according to configuration."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list and parameters list must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 7.3 required for `arguments`, PHP >= 8.0 for `parameters`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type operator.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type operator.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
yaegassy/coc-php-cs-fixer | 6dd24ebf34166b5b4362b001e98cc089e5b974df | 2022-10-17T01:30:27 | schemas/pint-schema.json | 31 | 2024-05-28T01:43:08.708278Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"cache-folder": {
"description": "Cache file path for customise it. Defaults to tmp folder that your operating system uses.",
"type": "string"
},
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_concat_operator": {
"description": "There should not be useless concat operations."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
yaegassy/coc-php-cs-fixer | ca236091a0c97d655714c4fa78e0dd854821dc49 | 2022-11-25T02:12:36 | schemas/pint-schema.json | 31 | 2024-05-28T01:43:08.708278Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"cache-folder": {
"description": "Cache file path for customise it. Defaults to tmp folder that your operating system uses.",
"type": "string"
},
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_fn_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for short arrow functions.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc.",
"properties": {
"annotations": {
"default": [],
"description": "List of annotations to remove, e.g. `[\"author\"]`.",
"type": "array"
},
"case_sensitive": {
"default": true,
"description": "Should annotations be case sensitive.",
"type": "boolean"
}
},
"type": "object"
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_concat_operator": {
"description": "There should not be useless concat operations."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"case",
"constant",
"constant_private",
"constant_protected",
"constant_public",
"construct",
"destruct",
"magic",
"method",
"method_abstract",
"method_private",
"method_private_abstract",
"method_private_abstract_static",
"method_private_static",
"method_protected",
"method_protected_abstract",
"method_protected_abstract_static",
"method_protected_static",
"method_public",
"method_public_abstract",
"method_public_abstract_static",
"method_public_static",
"method_static",
"phpunit",
"private",
"property",
"property_private",
"property_private_readonly",
"property_private_static",
"property_protected",
"property_protected_readonly",
"property_protected_static",
"property_public",
"property_public_readonly",
"property_public_static",
"property_static",
"protected",
"public",
"use_trait"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"method",
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arguments",
"arrays",
"match",
"parameters"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
yaegassy/coc-php-cs-fixer | 1559ffd505523601bfa1cc6f8e3d18654083ddea | 2022-07-05T01:24:28 | schemas/pint-schema.json | 31 | 2024-05-28T01:43:08.708278Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr-12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered so that `@param` annotations come first, then `@throws` annotations, then `@return` annotations."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other, and annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "There should be one or no space before colon, and one space after it in return type declarations, according to configuration."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list and parameters list must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 7.3 required for `arguments`, PHP >= 8.0 for `parameters`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type operator.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type operator.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
yaegassy/coc-php-cs-fixer | dc272531396cb81982ca51c7db5417675f38e434 | 2022-09-12T02:33:13 | schemas/pint-schema.json | 31 | 2024-05-28T01:43:08.708278Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
yaegassy/coc-php-cs-fixer | b95638478c12396f7c90c0b25d3f6d3b56e74632 | 2022-10-11T03:31:54 | schemas/pint-schema.json | 31 | 2024-05-28T01:43:08.708278Z | {
"$schema": "https://json-schema.org/draft-04/schema#",
"properties": {
"cache-folder": {
"description": "Cache file path for customise it. Defaults to tmp folder that your operating system uses.",
"type": "string"
},
"exclude": {
"description": "List of folders to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notName": {
"description": "List of file name patterns to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"notPath": {
"description": "List of exact file paths to exclude.",
"items": {
"type": "string"
},
"type": "array"
},
"preset": {
"default": "laravel",
"description": "Preset that applies a group of rules to the formatting.",
"oneOf": [
{
"enum": [
"laravel",
"symfony",
"psr12"
]
}
],
"type": "string"
},
"rules": {
"description": "Customise rules used for the formatting, this replaces the ones of the preset",
"properties": {
"align_multiline_comment": {
"description": "Each line of multi-line DocComments must have an asterisk [PSR-5] and must be aligned with the first one."
},
"array_indentation": {
"description": "Each element of an array must be indented exactly once."
},
"array_push": {
"description": "Converts simple usages of `array_push($x, $y);` to `$x[] = $y;`."
},
"array_syntax": {
"description": "PHP arrays should be declared using the configured syntax."
},
"assign_null_coalescing_to_coalesce_equal": {
"description": "Use the null coalescing assignment operator `??=` where possible."
},
"backtick_to_shell_exec": {
"description": "Converts backtick operators to `shell_exec` calls."
},
"binary_operator_spaces": {
"description": "Binary operators should be surrounded by space as configured.",
"properties": {
"default": {
"default": "single_space",
"description": "Default fix strategy.",
"oneOf": [
{
"enum": [
"align",
"align_single_space",
"align_single_space_minimal",
"single_space",
"no_space",
null
]
}
]
},
"operators": {
"default": {},
"description": "Dictionary of `binary operator` => `fix strategy` values that differ from the default strategy. Supported are: `=`, `*`, `/`, `%`, `<`, `>`, `|`, `^`, `+`, `-`, `&`, `&=`, `&&`, `||`, `.=`, `/=`, `=>`, `==`, `>=`, `===`, `!=`, `<>`, `!==`, `<=`, `and`, `or`, `xor`, `-=`, `%=`, `*=`, `|=`, `+=`, `<<`, `<<=`, `>>`, `>>=`, `^=`, `**`, `**=`, `<=>`, `??`, `??=`",
"type": "array"
}
},
"type": "object"
},
"blank_line_after_namespace": {
"description": "There MUST be one blank line after the namespace declaration."
},
"blank_line_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag and it is followed by a blank line."
},
"blank_line_before_statement": {
"description": "An empty line feed must precede any configured statement."
},
"blank_line_between_import_groups": {
"description": "Putting blank lines between `use` statement groups."
},
"braces": {
"description": "The body of each structure MUST be enclosed by braces. Braces should be properly placed. Body of braces should be properly indented.",
"properties": {
"allow_single_line_anonymous_class_with_empty_body": {
"default": false,
"description": "Whether single line anonymous class with empty body notation should be allowed.",
"type": "boolean"
},
"allow_single_line_closure": {
"default": false,
"description": "Whether single line lambda notation should be allowed.",
"type": "boolean"
},
"position_after_anonymous_constructs": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after anonymous constructs (anonymous classes and lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_control_structures": {
"default": "same",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after control structures.",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
},
"position_after_functions_and_oop_constructs": {
"default": "next",
"description": "whether the opening brace should be placed on \"next\" or \"same\" line after classy constructs (non-anonymous classes, interfaces, traits, methods and non-lambda functions).",
"oneOf": [
{
"enum": [
"next",
"same"
]
}
]
}
},
"type": "object"
},
"cast_spaces": {
"description": "A single space or none should be between cast and variable."
},
"class_attributes_separation": {
"description": "Class, trait and interface elements must be separated with one or none blank line."
},
"class_definition": {
"description": "Whitespace around the keywords of a class, trait, enum or interfaces definition should be one space.",
"properties": {
"inline_constructor_arguments": {
"default": true,
"description": "Whether constructor argument list in anonymous classes should be single line.",
"type": "boolean"
},
"multi_line_extends_each_single_line": {
"default": false,
"description": "Whether definitions should be multiline.",
"type": "boolean"
},
"single_item_single_line": {
"default": false,
"description": "Whether definitions should be single line when including a single item.",
"type": "boolean"
},
"single_line": {
"default": false,
"description": "Whether definitions should be single line.",
"type": "boolean"
},
"space_before_parenthesis": {
"default": false,
"description": "Whether there should be a single space after the parenthesis of anonymous class (PSR12) or not.",
"type": "boolean"
}
},
"type": "object"
},
"class_keyword_remove": {
"description": "Converts `::class` keywords to FQCN strings."
},
"class_reference_name_casing": {
"description": "When referencing an internal class it must be written using the correct casing."
},
"clean_namespace": {
"description": "Namespace must not contain spacing, comments or PHPDoc."
},
"combine_consecutive_issets": {
"description": "Using `isset($var) &&` multiple times should be done in one call."
},
"combine_consecutive_unsets": {
"description": "Calling `unset` on multiple items should be done in one call."
},
"combine_nested_dirname": {
"description": "Replace multiple nested calls of `dirname` by only one call with second `$level` parameter. Requires PHP >= 7.0."
},
"comment_to_phpdoc": {
"description": "Comments with annotation should be docblock when used on structural elements."
},
"compact_nullable_typehint": {
"description": "Remove extra spaces in a nullable typehint."
},
"concat_space": {
"description": "Concatenation should be spaced according configuration."
},
"constant_case": {
"description": "The PHP constants `true`, `false`, and `null` MUST be written using the correct casing."
},
"control_structure_braces": {
"description": "The body of each control structure MUST be enclosed within braces."
},
"control_structure_continuation_position": {
"description": "Control structure continuation keyword must be on the configured line."
},
"curly_braces_position": {
"description": "Curly braces must be placed as configured.",
"properties": {
"allow_single_line_anonymous_functions": {
"default": true,
"description": "allow anonymous functions to have opening and closing braces on the same line.",
"type": "boolean"
},
"allow_single_line_empty_anonymous_classes": {
"default": true,
"description": "allow anonymous classes to have opening and closing braces on the same line.",
"type": "boolean"
},
"anonymous_classes_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"anonymous_functions_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of anonymous functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"classes_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of classes body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"control_structures_opening_brace": {
"default": "same_line",
"description": "the position of the opening brace of control structures body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
},
"functions_opening_brace": {
"default": "next_line_unless_newline_at_signature_end",
"description": "the position of the opening brace of functions body.",
"oneOf": [
{
"enum": [
"next_line_unless_newline_at_signature_end",
"same_line"
]
}
]
}
},
"type": "object"
},
"date_time_create_from_format_call": {
"description": "The first argument of `DateTime::createFromFormat` method must start with `!`."
},
"date_time_immutable": {
"description": "Class `DateTimeImmutable` should be used instead of `DateTime`."
},
"declare_equal_normalize": {
"description": "Equal sign in declare statement should be surrounded by spaces or not following configuration."
},
"declare_parentheses": {
"description": "There must not be spaces around `declare` statement parentheses."
},
"declare_strict_types": {
"description": "Force strict types declaration in all files. Requires PHP >= 7.0."
},
"dir_constant": {
"description": "Replaces `dirname(__FILE__)` expression with equivalent `__DIR__` constant."
},
"doctrine_annotation_array_assignment": {
"description": "Doctrine annotations must use configured operator for assignment in arrays.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"operator": {
"default": "=",
"description": "The operator to use.",
"oneOf": [
{
"enum": [
"=",
":"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_braces": {
"description": "Doctrine annotations without arguments must use the configured syntax.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"syntax": {
"default": "without_braces",
"description": "Whether to add or remove braces.",
"oneOf": [
{
"enum": [
"with_braces",
"without_braces"
]
}
]
}
},
"type": "object"
},
"doctrine_annotation_indentation": {
"description": "Doctrine annotations must be indented with four spaces.",
"properties": {
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
},
"indent_mixed_lines": {
"default": false,
"description": "Whether to indent lines that have content before closing parenthesis.",
"type": "boolean"
}
},
"type": "object"
},
"doctrine_annotation_spaces": {
"description": "Fixes spaces in Doctrine annotations.",
"properties": {
"after_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces after argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `:` operator.",
"type": [
"null",
"boolean"
]
},
"after_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces after array assignment `=` operator.",
"type": [
"null",
"boolean"
]
},
"around_commas": {
"default": true,
"description": "Whether to fix spaces around commas.",
"type": "boolean"
},
"around_parentheses": {
"default": true,
"description": "Whether to fix spaces around parentheses.",
"type": "boolean"
},
"before_argument_assignments": {
"default": false,
"description": "Whether to add, remove or ignore spaces before argument assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_colon": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `:` assignment operator.",
"type": [
"null",
"boolean"
]
},
"before_array_assignments_equals": {
"default": true,
"description": "Whether to add, remove or ignore spaces before array `=` assignment operator.",
"type": [
"null",
"boolean"
]
},
"ignored_tags": {
"default": [
"abstract",
"access",
"code",
"deprec",
"encode",
"exception",
"final",
"ingroup",
"inheritdoc",
"inheritDoc",
"magic",
"name",
"toc",
"tutorial",
"private",
"static",
"staticvar",
"staticVar",
"throw",
"api",
"author",
"category",
"copyright",
"deprecated",
"example",
"filesource",
"global",
"ignore",
"internal",
"license",
"link",
"method",
"package",
"param",
"property",
"property-read",
"property-write",
"return",
"see",
"since",
"source",
"subpackage",
"throws",
"todo",
"TODO",
"usedBy",
"uses",
"var",
"version",
"after",
"afterClass",
"backupGlobals",
"backupStaticAttributes",
"before",
"beforeClass",
"codeCoverageIgnore",
"codeCoverageIgnoreStart",
"codeCoverageIgnoreEnd",
"covers",
"coversDefaultClass",
"coversNothing",
"dataProvider",
"depends",
"expectedException",
"expectedExceptionCode",
"expectedExceptionMessage",
"expectedExceptionMessageRegExp",
"group",
"large",
"medium",
"preserveGlobalState",
"requires",
"runTestsInSeparateProcesses",
"runInSeparateProcess",
"small",
"test",
"testdox",
"ticket",
"uses",
"SuppressWarnings",
"noinspection",
"package_version",
"enduml",
"startuml",
"psalm",
"phpstan",
"template",
"fix",
"FIXME",
"fixme",
"override"
],
"description": "List of tags that must not be treated as Doctrine Annotations.",
"type": "array"
}
},
"type": "object"
},
"echo_tag_syntax": {
"description": "Replaces short-echo `<?=` with long format `<?php echo`/`<?php print` syntax, or vice-versa.",
"properties": {
"format": {
"default": "long",
"description": "The desired language construct.",
"oneOf": [
{
"enum": [
"long",
"short"
]
}
]
},
"long_function": {
"default": "echo",
"description": "The function to be used to expand the short echo tags",
"oneOf": [
{
"enum": [
"echo",
"print"
]
}
]
},
"shorten_simple_statements_only": {
"default": true,
"description": "Render short-echo tags only in case of simple code",
"type": "boolean"
}
},
"type": "object"
},
"elseif": {
"description": "The keyword `elseif` should be used instead of `else if` so that all control keywords look like single words."
},
"empty_loop_body": {
"description": "Empty loop-body must be in configured style."
},
"empty_loop_condition": {
"description": "Empty loop-condition must be in configured style."
},
"encoding": {
"description": "PHP code MUST use only UTF-8 without BOM (remove BOM)."
},
"ereg_to_preg": {
"description": "Replace deprecated `ereg` regular expression functions with `preg`."
},
"error_suppression": {
"description": "Error control operator should be added to deprecation notices and/or removed from other cases.",
"properties": {
"mute_deprecation_error": {
"default": true,
"description": "Whether to add `@` in deprecation notices.",
"type": "boolean"
},
"noise_remaining_usages": {
"default": false,
"description": "Whether to remove `@` in remaining usages.",
"type": "boolean"
},
"noise_remaining_usages_exclude": {
"default": [],
"description": "List of global functions to exclude from removing `@`",
"type": "array"
}
},
"type": "object"
},
"escape_implicit_backslashes": {
"description": "Escape implicit backslashes in strings and heredocs to ease the understanding of which are special chars interpreted by PHP and which not.",
"properties": {
"double_quoted": {
"default": true,
"description": "Whether to fix double-quoted strings.",
"type": "boolean"
},
"heredoc_syntax": {
"default": true,
"description": "Whether to fix heredoc syntax.",
"type": "boolean"
},
"single_quoted": {
"default": false,
"description": "Whether to fix single-quoted strings.",
"type": "boolean"
}
},
"type": "object"
},
"explicit_indirect_variable": {
"description": "Add curly braces to indirect variables to make them clear to understand. Requires PHP >= 7.0."
},
"explicit_string_variable": {
"description": "Converts implicit variables into explicit ones in double-quoted strings or heredoc syntax."
},
"final_class": {
"description": "All classes must be final, except abstract ones and Doctrine entities."
},
"final_internal_class": {
"description": "Internal classes should be `final`.",
"properties": {
"annotation_exclude": {
"default": [
"@final",
"@Entity",
"@ORM\\Entity",
"@ORM\\Mapping\\Entity",
"@Mapping\\Entity",
"@Document",
"@ODM\\Document"
],
"description": "Class level annotations tags that must be omitted to fix the class, even if all of the white list ones are used as well. (case insensitive)",
"type": "array"
},
"annotation_include": {
"default": [
"@internal"
],
"description": "Class level annotations tags that must be set in order to fix the class. (case insensitive)",
"type": "array"
},
"consider_absent_docblock_as_internal_class": {
"default": false,
"description": "Should classes without any DocBlock be fixed to final?",
"type": "boolean"
}
},
"type": "object"
},
"final_public_method_for_abstract_class": {
"description": "All `public` methods of `abstract` classes should be `final`."
},
"fopen_flag_order": {
"description": "Order the flags in `fopen` calls, `b` and `t` must be last."
},
"fopen_flags": {
"description": "The flags in `fopen` calls must omit `t`, and `b` must be omitted or included consistently."
},
"full_opening_tag": {
"description": "PHP code must use the long `<?php` tags or short-echo `<?=` tags and not other tag variations."
},
"fully_qualified_strict_types": {
"description": "Transforms imported FQCN parameters and return types in function arguments to short version."
},
"function_declaration": {
"description": "Spaces should be properly placed in a function declaration.",
"properties": {
"closure_function_spacing": {
"default": "one",
"description": "Spacing to use before open parenthesis for closures.",
"oneOf": [
{
"enum": [
"none",
"one"
]
}
]
},
"trailing_comma_single_line": {
"default": false,
"description": "Whether trailing commas are allowed in single line signatures.",
"type": "boolean"
}
},
"type": "object"
},
"function_to_constant": {
"description": "Replace core functions calls returning constants with the constants."
},
"function_typehint_space": {
"description": "Ensure single space between function's argument and its typehint."
},
"general_phpdoc_annotation_remove": {
"description": "Configured annotations should be omitted from PHPDoc."
},
"general_phpdoc_tag_rename": {
"description": "Renames PHPDoc tags.",
"properties": {
"case_sensitive": {
"default": false,
"description": "Whether tags should be replaced only if they have exact same casing.",
"type": "boolean"
},
"fix_annotation": {
"default": true,
"description": "Whether annotation tags should be fixed.",
"type": "boolean"
},
"fix_inline": {
"default": true,
"description": "Whether inline tags should be fixed.",
"type": "boolean"
},
"replacements": {
"default": {},
"description": "A map of tags to replace.",
"type": "array"
}
},
"type": "object"
},
"get_class_to_class_keyword": {
"description": "Replace `get_class` calls on object variables with class keyword syntax."
},
"global_namespace_import": {
"description": "Imports or fully qualifies global classes/functions/constants.",
"properties": {
"import_classes": {
"default": true,
"description": "Whether to import, not import or ignore global classes.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_constants": {
"default": null,
"description": "Whether to import, not import or ignore global constants.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
},
"import_functions": {
"default": null,
"description": "Whether to import, not import or ignore global functions.",
"oneOf": [
{
"enum": [
true,
false,
null
]
}
]
}
},
"type": "object"
},
"group_import": {
"description": "There MUST be group use for the same namespaces."
},
"header_comment": {
"description": "Add, replace or remove header comment.",
"properties": {
"comment_type": {
"default": "comment",
"description": "Comment syntax type.",
"oneOf": [
{
"enum": [
"PHPDoc",
"comment"
]
}
]
},
"header": {
"description": "Proper header content.",
"type": "string"
},
"location": {
"default": "after_declare_strict",
"description": "The location of the inserted header.",
"oneOf": [
{
"enum": [
"after_open",
"after_declare_strict"
]
}
]
},
"separate": {
"default": "both",
"description": "Whether the header should be separated from the file content with a new line.",
"oneOf": [
{
"enum": [
"both",
"top",
"bottom",
"none"
]
}
]
}
},
"type": "object"
},
"heredoc_indentation": {
"description": "Heredoc/nowdoc content must be properly indented. Requires PHP >= 7.3."
},
"heredoc_to_nowdoc": {
"description": "Convert `heredoc` to `nowdoc` where possible."
},
"implode_call": {
"description": "Function `implode` must be called with 2 arguments in the documented order."
},
"include": {
"description": "Include/Require and file path should be divided with a single space. File path should not be placed under brackets."
},
"increment_style": {
"description": "Pre- or post-increment and decrement operators should be used if possible."
},
"indentation_type": {
"description": "Code MUST use configured indentation type."
},
"integer_literal_case": {
"description": "Integer literals must be in correct case."
},
"is_null": {
"description": "Replaces `is_null($var)` expression with `null === $var`."
},
"lambda_not_used_import": {
"description": "Lambda must not import variables it doesn't use."
},
"line_ending": {
"description": "All PHP files must use same line ending."
},
"linebreak_after_opening_tag": {
"description": "Ensure there is no code on the same line as the PHP open tag."
},
"list_syntax": {
"description": "List (`array` destructuring) assignment should be declared using the configured syntax. Requires PHP >= 7.1."
},
"logical_operators": {
"description": "Use `&&` and `||` logical operators instead of `and` and `or`."
},
"lowercase_cast": {
"description": "Cast should be written in lower case."
},
"lowercase_keywords": {
"description": "PHP keywords MUST be in lower case."
},
"lowercase_static_reference": {
"description": "Class static references `self`, `static` and `parent` MUST be in lower case."
},
"magic_constant_casing": {
"description": "Magic constants should be referred to using the correct casing."
},
"magic_method_casing": {
"description": "Magic method definitions and calls must be using the correct casing."
},
"mb_str_functions": {
"description": "Replace non multibyte-safe functions with corresponding mb function."
},
"method_argument_space": {
"description": "In method arguments and method call, there MUST NOT be a space before each comma and there MUST be one space after each comma. Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether the whitespace between heredoc end and comma should be removed.",
"type": "boolean"
},
"keep_multiple_spaces_after_comma": {
"default": false,
"description": "Whether keep multiple spaces after comma.",
"type": "boolean"
},
"on_multiline": {
"default": "ensure_fully_multiline",
"description": "Defines how to handle function arguments lists that contain newlines.",
"oneOf": [
{
"enum": [
"ignore",
"ensure_single_line",
"ensure_fully_multiline"
]
}
]
}
},
"type": "object"
},
"method_chaining_indentation": {
"description": "Method chaining MUST be properly indented. Method chaining with different levels of indentation is not supported."
},
"modernize_strpos": {
"description": "Replace `strpos()` calls with `str_starts_with()` or `str_contains()` if possible."
},
"modernize_types_casting": {
"description": "Replaces `intval`, `floatval`, `doubleval`, `strval` and `boolval` function calls with according type casting operator."
},
"multiline_comment_opening_closing": {
"description": "DocBlocks must start with two asterisks, multiline comments must start with a single asterisk, after the opening slash. Both must end with a single asterisk before the closing slash."
},
"multiline_whitespace_before_semicolons": {
"description": "Forbid multi-line whitespace before the closing semicolon or move the semicolon to the new line for chained calls."
},
"native_constant_invocation": {
"description": "Add leading `\\` before constant invocation of internal constant to speed up resolving. Constant name match is case-sensitive, except for `null`, `false` and `true`.",
"properties": {
"exclude": {
"default": [
"null",
"false",
"true"
],
"description": "List of constants to ignore.",
"type": "array"
},
"fix_built_in": {
"default": true,
"description": "Whether to fix constants returned by `get_defined_constants`. User constants are not accounted in this list and must be specified in the include one.",
"type": "boolean"
},
"include": {
"default": [],
"description": "List of additional constants to fix.",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix constant invocations that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of constant invocation not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_casing": {
"description": "Function defined by PHP should be called using the correct casing."
},
"native_function_invocation": {
"description": "Add leading `\\` before function invocation to speed up resolving.",
"properties": {
"exclude": {
"default": [],
"description": "List of functions to ignore.",
"type": "array"
},
"include": {
"default": [
"@compiler_optimized"
],
"description": "List of function names or sets to fix. Defined sets are `@internal` (all native functions), `@all` (all global functions) and `@compiler_optimized` (functions that are specially optimized by Zend).",
"type": "array"
},
"scope": {
"default": "all",
"description": "Only fix function calls that are made within a namespace or fix all.",
"oneOf": [
{
"enum": [
"all",
"namespaced"
]
}
]
},
"strict": {
"default": true,
"description": "Whether leading `\\` of function call not meant to have it should be removed.",
"type": "boolean"
}
},
"type": "object"
},
"native_function_type_declaration_casing": {
"description": "Native type hints for functions should use the correct case."
},
"new_with_braces": {
"description": "All instances created with `new` keyword must (not) be followed by braces.",
"properties": {
"anonymous_class": {
"default": true,
"description": "Whether anonymous classes should be followed by parentheses.",
"type": "boolean"
},
"named_class": {
"default": true,
"description": "Whether named classes should be followed by parentheses.",
"type": "boolean"
}
},
"type": "object"
},
"no_alias_functions": {
"description": "Master functions shall be used instead of aliases."
},
"no_alias_language_construct_call": {
"description": "Master language constructs shall be used instead of aliases."
},
"no_alternative_syntax": {
"description": "Replace control structure alternative syntax to use braces."
},
"no_binary_string": {
"description": "There should not be a binary flag before strings."
},
"no_blank_lines_after_class_opening": {
"description": "There should be no empty lines after class opening brace."
},
"no_blank_lines_after_phpdoc": {
"description": "There should not be blank lines between docblock and the documented element."
},
"no_blank_lines_before_namespace": {
"description": "There should be no blank lines before a namespace declaration."
},
"no_break_comment": {
"description": "There must be a comment when fall-through is intentional in a non-empty case body."
},
"no_closing_tag": {
"description": "The closing `?>` tag MUST be omitted from files containing only PHP."
},
"no_empty_comment": {
"description": "There should not be any empty comments."
},
"no_empty_phpdoc": {
"description": "There should not be empty PHPDoc blocks."
},
"no_empty_statement": {
"description": "Remove useless (semicolon) statements."
},
"no_extra_blank_lines": {
"description": "Removes extra blank lines and/or blank lines following configuration."
},
"no_homoglyph_names": {
"description": "Replace accidental usage of homoglyphs (non ascii characters) in names."
},
"no_leading_import_slash": {
"description": "Remove leading slashes in `use` clauses."
},
"no_leading_namespace_whitespace": {
"description": "The namespace declaration line shouldn't contain leading whitespace."
},
"no_mixed_echo_print": {
"description": "Either language construct `print` or `echo` should be used."
},
"no_multiline_whitespace_around_double_arrow": {
"description": "Operator `=>` should not be surrounded by multi-line whitespaces."
},
"no_multiple_statements_per_line": {
"description": "There must not be more than one statement per line."
},
"no_null_property_initialization": {
"description": "Properties MUST not be explicitly initialized with `null` except when they have a type declaration (PHP 7.4)."
},
"no_php4_constructor": {
"description": "Convert PHP4-style constructors to `__construct`."
},
"no_short_bool_cast": {
"description": "Short cast `bool` using double exclamation mark should not be used."
},
"no_singleline_whitespace_before_semicolons": {
"description": "Single-line whitespace before closing semicolon are prohibited."
},
"no_space_around_double_colon": {
"description": "There must be no space around double colons (also called Scope Resolution Operator or Paamayim Nekudotayim)."
},
"no_spaces_after_function_name": {
"description": "When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis."
},
"no_spaces_around_offset": {
"description": "There MUST NOT be spaces around offset braces."
},
"no_spaces_inside_parenthesis": {
"description": "There MUST NOT be a space after the opening parenthesis. There MUST NOT be a space before the closing parenthesis."
},
"no_superfluous_elseif": {
"description": "Replaces superfluous `elseif` with `if`."
},
"no_superfluous_phpdoc_tags": {
"description": "Removes `@param`, `@return` and `@var` tags that don't provide any useful information.",
"properties": {
"allow_mixed": {
"default": false,
"description": "Whether type `mixed` without description is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"allow_unused_params": {
"default": false,
"description": "Whether `param` annotation without actual signature is allowed (`true`) or considered superfluous (`false`)",
"type": "boolean"
},
"remove_inheritdoc": {
"default": false,
"description": "Remove `@inheritDoc` tags",
"type": "boolean"
}
},
"type": "object"
},
"no_trailing_comma_in_list_call": {
"description": "Remove trailing commas in list function calls."
},
"no_trailing_comma_in_singleline": {
"description": "If a list of values separated by a comma is contained on a single line, then the last item MUST NOT have a trailing comma."
},
"no_trailing_comma_in_singleline_array": {
"description": "PHP single-line arrays should not have trailing comma."
},
"no_trailing_comma_in_singleline_function_call": {
"description": "When making a method or function call on a single line there MUST NOT be a trailing comma after the last argument."
},
"no_trailing_whitespace": {
"description": "Remove trailing whitespace at the end of non-blank lines."
},
"no_trailing_whitespace_in_comment": {
"description": "There MUST be no trailing spaces inside comment or PHPDoc."
},
"no_trailing_whitespace_in_string": {
"description": "There must be no trailing whitespace in strings."
},
"no_unneeded_control_parentheses": {
"description": "Removes unneeded parentheses around control statements."
},
"no_unneeded_curly_braces": {
"description": "Removes unneeded curly braces that are superfluous and aren't part of a control structure's body."
},
"no_unneeded_final_method": {
"description": "Removes `final` from methods where possible."
},
"no_unneeded_import_alias": {
"description": "Imports should not be aliased as the same name."
},
"no_unreachable_default_argument_value": {
"description": "In function arguments there must not be arguments with default values before non-default ones."
},
"no_unset_cast": {
"description": "Variables must be set `null` instead of using `(unset)` casting."
},
"no_unset_on_property": {
"description": "Properties should be set to `null` instead of using `unset`."
},
"no_unused_imports": {
"description": "Unused `use` statements must be removed."
},
"no_useless_else": {
"description": "There should not be useless `else` cases."
},
"no_useless_nullsafe_operator": {
"description": "There should not be useless `null-safe-operators` `?->` used."
},
"no_useless_return": {
"description": "There should not be an empty `return` statement at the end of a function."
},
"no_useless_sprintf": {
"description": "There must be no `sprintf` calls with only the first argument."
},
"no_whitespace_before_comma_in_array": {
"description": "In array declaration, there MUST NOT be a whitespace before each comma."
},
"no_whitespace_in_blank_line": {
"description": "Remove trailing whitespace at the end of blank lines."
},
"non_printable_character": {
"description": "Remove Zero-width space (ZWSP), Non-breaking space (NBSP) and other invisible unicode symbols."
},
"normalize_index_brace": {
"description": "Array index should always be written by using square braces."
},
"not_operator_with_space": {
"description": "Logical NOT operators (`!`) should have leading and trailing whitespaces."
},
"not_operator_with_successor_space": {
"description": "Logical NOT operators (`!`) should have one trailing whitespace."
},
"nullable_type_declaration_for_default_null_value": {
"description": "Adds or removes `?` before type declarations for parameters with a default `null` value."
},
"object_operator_without_whitespace": {
"description": "There should not be space before or after object operators `->` and `?->`."
},
"octal_notation": {
"description": "Literal octal must be in `0o` notation."
},
"operator_linebreak": {
"description": "Operators - when multiline - must always be at the beginning or at the end of the line.",
"properties": {
"only_booleans": {
"default": false,
"description": "whether to limit operators to only boolean ones",
"type": "boolean"
},
"position": {
"default": "beginning",
"description": "whether to place operators at the beginning or at the end of the line",
"oneOf": [
{
"enum": [
"beginning",
"end"
]
}
]
}
},
"type": "object"
},
"ordered_class_elements": {
"description": "Orders the elements of classes/interfaces/traits/enums.",
"properties": {
"order": {
"default": [
"use_trait",
"case",
"constant_public",
"constant_protected",
"constant_private",
"property_public",
"property_protected",
"property_private",
"construct",
"destruct",
"magic",
"phpunit",
"method_public",
"method_protected",
"method_private"
],
"description": "List of strings defining order of elements.",
"oneOf": [
{
"enum": [
[
"use_trait",
"public",
"protected",
"private",
"case",
"constant",
"constant_public",
"constant_protected",
"constant_private",
"property",
"property_static",
"property_public",
"property_protected",
"property_private",
"property_public_readonly",
"property_protected_readonly",
"property_private_readonly",
"property_public_static",
"property_protected_static",
"property_private_static",
"method",
"method_abstract",
"method_static",
"method_public",
"method_protected",
"method_private",
"method_public_abstract",
"method_protected_abstract",
"method_private_abstract",
"method_public_abstract_static",
"method_protected_abstract_static",
"method_private_abstract_static",
"method_public_static",
"method_protected_static",
"method_private_static",
"construct",
"destruct",
"magic",
"phpunit"
]
]
}
],
"type": "array"
},
"sort_algorithm": {
"default": "none",
"description": "How multiple occurrences of same type statements should be sorted",
"oneOf": [
{
"enum": [
"none",
"alpha"
]
}
]
}
},
"type": "object"
},
"ordered_imports": {
"description": "Ordering `use` statements.",
"properties": {
"imports_order": {
"default": null,
"description": "Defines the order of import types.",
"type": [
"array",
"null"
]
},
"sort_algorithm": {
"default": "alpha",
"description": "whether the statements should be sorted alphabetically or by length, or not sorted",
"oneOf": [
{
"enum": [
"alpha",
"length",
"none"
]
}
]
}
},
"type": "object"
},
"ordered_interfaces": {
"description": "Orders the interfaces in an `implements` or `interface extends` clause.",
"properties": {
"direction": {
"default": "ascend",
"description": "Which direction the interfaces should be ordered",
"oneOf": [
{
"enum": [
"ascend",
"descend"
]
}
]
},
"order": {
"default": "alpha",
"description": "How the interfaces should be ordered",
"oneOf": [
{
"enum": [
"alpha",
"length"
]
}
]
}
},
"type": "object"
},
"ordered_traits": {
"description": "Trait `use` statements must be sorted alphabetically."
},
"php_unit_construct": {
"description": "PHPUnit assertion method calls like `->assertSame(true, $foo)` should be written with dedicated method like `->assertTrue($foo)`."
},
"php_unit_dedicate_assert": {
"description": "PHPUnit assertions like `assertInternalType`, `assertFileExists`, should be used over `assertTrue`."
},
"php_unit_dedicate_assert_internal_type": {
"description": "PHPUnit assertions like `assertIsArray` should be used over `assertInternalType`."
},
"php_unit_expectation": {
"description": "Usages of `->setExpectedException*` methods MUST be replaced by `->expectException*` methods."
},
"php_unit_fqcn_annotation": {
"description": "PHPUnit annotations should be a FQCNs including a root namespace."
},
"php_unit_internal_class": {
"description": "All PHPUnit test classes should be marked as internal."
},
"php_unit_method_casing": {
"description": "Enforce camel (or snake) case for PHPUnit test methods, following configuration."
},
"php_unit_mock": {
"description": "Usages of `->getMock` and `->getMockWithoutInvokingTheOriginalConstructor` methods MUST be replaced by `->createMock` or `->createPartialMock` methods."
},
"php_unit_mock_short_will_return": {
"description": "Usage of PHPUnit's mock e.g. `->will($this->returnValue(..))` must be replaced by its shorter equivalent such as `->willReturn(...)`."
},
"php_unit_namespaced": {
"description": "PHPUnit classes MUST be used in namespaced version, e.g. `\\PHPUnit\\Framework\\TestCase` instead of `\\PHPUnit_Framework_TestCase`."
},
"php_unit_no_expectation_annotation": {
"description": "Usages of `@expectedException*` annotations MUST be replaced by `->setExpectedException*` methods.",
"properties": {
"target": {
"default": "newest",
"description": "Target version of PHPUnit.",
"oneOf": [
{
"enum": [
"3.2",
"4.3",
"newest"
]
}
],
"type": "string"
},
"use_class_const": {
"default": true,
"description": "Use ::class notation.",
"type": "boolean"
}
},
"type": "object"
},
"php_unit_set_up_tear_down_visibility": {
"description": "Changes the visibility of the `setUp()` and `tearDown()` functions of PHPUnit to `protected`, to match the PHPUnit TestCase."
},
"php_unit_size_class": {
"description": "All PHPUnit test cases should have `@small`, `@medium` or `@large` annotation to enable run time limits."
},
"php_unit_strict": {
"description": "PHPUnit methods like `assertSame` should be used instead of `assertEquals`."
},
"php_unit_test_annotation": {
"description": "Adds or removes @test annotations from tests, following configuration."
},
"php_unit_test_case_static_method_calls": {
"description": "Calls to `PHPUnit\\Framework\\TestCase` static methods must all be of the same type, either `$this->`, `self::` or `static::`.",
"properties": {
"call_type": {
"default": "static",
"description": "The call type to use for referring to PHPUnit methods.",
"oneOf": [
{
"enum": [
"this",
"self",
"static"
]
}
],
"type": "string"
},
"methods": {
"default": [],
"description": "Dictionary of `method` => `call_type` values that differ from the default strategy.",
"type": "array"
}
},
"type": "object"
},
"php_unit_test_class_requires_covers": {
"description": "Adds a default `@coversNothing` annotation to PHPUnit test classes that have no `@covers*` annotation."
},
"phpdoc_add_missing_param_annotation": {
"description": "PHPDoc should contain `@param` for all params."
},
"phpdoc_align": {
"description": "All items of the given phpdoc tags must be either left-aligned or (by default) aligned vertically.",
"properties": {
"align": {
"default": "vertical",
"description": "Align comments",
"oneOf": [
{
"enum": [
"left",
"vertical"
]
}
],
"type": "string"
},
"tags": {
"default": [
"method",
"param",
"property",
"return",
"throws",
"type",
"var"
],
"description": "The tags that should be aligned.",
"oneOf": [
{
"enum": [
[
"param",
"property",
"property-read",
"property-write",
"return",
"throws",
"type",
"var",
"method"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"phpdoc_annotation_without_dot": {
"description": "PHPDoc annotation descriptions should not be a sentence."
},
"phpdoc_indent": {
"description": "Docblocks should have the same indentation as the documented subject."
},
"phpdoc_inline_tag_normalizer": {
"description": "Fixes PHPDoc inline tags."
},
"phpdoc_line_span": {
"description": "Changes doc blocks from single to multi line, or reversed. Works for class constants, properties and methods only.",
"properties": {
"const": {
"default": "multi",
"description": "Whether const blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"method": {
"default": "multi",
"description": "Whether method doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
},
"property": {
"default": "multi",
"description": "Whether property doc blocks should be single or multi line",
"oneOf": [
{
"enum": [
"single",
"multi",
null
]
}
]
}
},
"type": "object"
},
"phpdoc_no_access": {
"description": "`@access` annotations should be omitted from PHPDoc."
},
"phpdoc_no_alias_tag": {
"description": "No alias PHPDoc tags should be used."
},
"phpdoc_no_empty_return": {
"description": "`@return void` and `@return null` annotations should be omitted from PHPDoc."
},
"phpdoc_no_package": {
"description": "`@package` and `@subpackage` annotations should be omitted from PHPDoc."
},
"phpdoc_no_useless_inheritdoc": {
"description": "Classy that does not inherit must not have `@inheritdoc` tags."
},
"phpdoc_order": {
"description": "Annotations in PHPDoc should be ordered in defined sequence."
},
"phpdoc_order_by_value": {
"description": "Order phpdoc tags by value."
},
"phpdoc_return_self_reference": {
"description": "The type of `@return` annotations of methods returning a reference to itself must the configured one."
},
"phpdoc_scalar": {
"description": "Scalar types should always be written in the same form. `int` not `integer`, `bool` not `boolean`, `float` not `real` or `double`."
},
"phpdoc_separation": {
"description": "Annotations in PHPDoc should be grouped together so that annotations of the same type immediately follow each other. Annotations of a different type are separated by a single blank line."
},
"phpdoc_single_line_var_spacing": {
"description": "Single line `@var` PHPDoc should have proper spacing."
},
"phpdoc_summary": {
"description": "PHPDoc summary should end in either a full stop, exclamation mark, or question mark."
},
"phpdoc_tag_casing": {
"description": "Fixes casing of PHPDoc tags."
},
"phpdoc_tag_type": {
"description": "Forces PHPDoc tags to be either regular annotations or inline."
},
"phpdoc_to_comment": {
"description": "Docblocks should only be used on structural elements."
},
"phpdoc_to_param_type": {
"description": "EXPERIMENTAL: Takes `@param` annotations of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_to_property_type": {
"description": "EXPERIMENTAL: Takes `@var` annotation of non-mixed types and adjusts accordingly the property signature. Requires PHP >= 7.4."
},
"phpdoc_to_return_type": {
"description": "EXPERIMENTAL: Takes `@return` annotation of non-mixed types and adjusts accordingly the function signature. Requires PHP >= 7.0."
},
"phpdoc_trim": {
"description": "PHPDoc should start and end with content, excluding the very first and last line of the docblocks."
},
"phpdoc_trim_consecutive_blank_line_separation": {
"description": "Removes extra blank lines after summary and after description in PHPDoc."
},
"phpdoc_types": {
"description": "The correct case must be used for standard PHP types in PHPDoc."
},
"phpdoc_types_order": {
"description": "Sorts PHPDoc types.",
"properties": {
"null_adjustment": {
"default": "always_first",
"description": "Forces the position of `null` (overrides `sort_algorithm`).",
"oneOf": [
{
"enum": [
"always_first",
"always_last",
"none"
]
}
]
},
"sort_algorithm": {
"default": "alpha",
"description": "The sorting algorithm to apply.",
"oneOf": [
{
"enum": [
"alpha",
"none"
]
}
]
}
},
"type": "object"
},
"phpdoc_var_annotation_correct_order": {
"description": "`@var` and `@type` annotations must have type and name in the correct order."
},
"phpdoc_var_without_name": {
"description": "`@var` and `@type` annotations of classy properties should not contain the name."
},
"pow_to_exponentiation": {
"description": "Converts `pow` to the `**` operator."
},
"protected_to_private": {
"description": "Converts `protected` variables and methods to `private` where possible."
},
"psr_autoloading": {
"description": "Classes must be in a path that matches their namespace, be at least one namespace deep and the class name should match the file name."
},
"random_api_migration": {
"description": "Replaces `rand`, `srand`, `getrandmax` functions calls with their `mt_*` analogs or `random_int`."
},
"regular_callable_call": {
"description": "Callables must be called without using `call_user_func*` when possible."
},
"return_assignment": {
"description": "Local, dynamic and directly referenced variables should not be assigned and directly returned by a function or method."
},
"return_type_declaration": {
"description": "Adjust spacing around colon in return type declarations and backed enum types."
},
"self_accessor": {
"description": "Inside class or interface element `self` should be preferred to the class name itself."
},
"self_static_accessor": {
"description": "Inside a `final` class or anonymous class `self` should be preferred to `static`."
},
"semicolon_after_instruction": {
"description": "Instructions must be terminated with a semicolon."
},
"set_type_to_cast": {
"description": "Cast shall be used, not `settype`."
},
"short_scalar_cast": {
"description": "Cast `(boolean)` and `(integer)` should be written as `(bool)` and `(int)`, `(double)` and `(real)` as `(float)`, `(binary)` as `(string)`."
},
"simple_to_complex_string_variable": {
"description": "Converts explicit variables in double-quoted strings and heredoc syntax from simple to complex format (`${` to `{$`)."
},
"simplified_if_return": {
"description": "Simplify `if` control structures that return the boolean result of their condition."
},
"simplified_null_return": {
"description": "A return statement wishing to return `void` should not return `null`."
},
"single_blank_line_at_eof": {
"description": "A PHP file without end tag must always end with a single empty line feed."
},
"single_blank_line_before_namespace": {
"description": "There should be exactly one blank line before a namespace declaration."
},
"single_class_element_per_statement": {
"description": "There MUST NOT be more than one property or constant declared per statement."
},
"single_import_per_statement": {
"description": "There MUST be one use keyword per declaration."
},
"single_line_after_imports": {
"description": "Each namespace use MUST go on its own line and there MUST be one blank line after the use statements block."
},
"single_line_comment_spacing": {
"description": "Single-line comments must have proper spacing."
},
"single_line_comment_style": {
"description": "Single-line comments and multi-line comments with only one line of actual content should use the `//` syntax."
},
"single_line_throw": {
"description": "Throwing exception must be done in single line."
},
"single_quote": {
"description": "Convert double quotes to single quotes for simple strings."
},
"single_space_after_construct": {
"description": "Ensures a single space after language constructs."
},
"single_trait_insert_per_statement": {
"description": "Each trait `use` must be done as single statement."
},
"space_after_semicolon": {
"description": "Fix whitespace after a semicolon."
},
"standardize_increment": {
"description": "Increment and decrement operators should be used if possible."
},
"standardize_not_equals": {
"description": "Replace all `<>` with `!=`."
},
"statement_indentation": {
"description": "Each statement must be indented."
},
"static_lambda": {
"description": "Lambdas not (indirect) referencing `$this` must be declared `static`."
},
"strict_comparison": {
"description": "Comparisons should be strict."
},
"strict_param": {
"description": "Functions should be used with `$strict` param set to `true`."
},
"string_length_to_empty": {
"description": "String tests for empty must be done against `''`, not with `strlen`."
},
"string_line_ending": {
"description": "All multi-line strings must use correct line ending."
},
"switch_case_semicolon_to_colon": {
"description": "A case should be followed by a colon and not a semicolon."
},
"switch_case_space": {
"description": "Removes extra spaces between colon and case value."
},
"switch_continue_to_break": {
"description": "Switch case must not be ended with `continue` but with `break`."
},
"ternary_operator_spaces": {
"description": "Standardize spaces around ternary operator."
},
"ternary_to_elvis_operator": {
"description": "Use the Elvis operator `?:` where possible."
},
"ternary_to_null_coalescing": {
"description": "Use `null` coalescing operator `??` where possible. Requires PHP >= 7.0."
},
"trailing_comma_in_multiline": {
"description": "Multi-line arrays, arguments list, parameters list and `match` expressions must have a trailing comma.",
"properties": {
"after_heredoc": {
"default": false,
"description": "Whether a trailing comma should also be placed after heredoc end.",
"type": "boolean"
},
"elements": {
"default": [
"arrays"
],
"description": "Where to fix multiline trailing comma (PHP >= 8.0 for `parameters` and `match`).",
"oneOf": [
{
"enum": [
[
"arrays",
"arguments",
"parameters",
"match"
]
]
}
],
"type": "array"
}
},
"type": "object"
},
"trim_array_spaces": {
"description": "Arrays should be formatted like function/method arguments, without leading or trailing single line space."
},
"types_spaces": {
"description": "A single space or none should be around union type and intersection type operators.",
"properties": {
"space": {
"default": "none",
"description": "spacing to apply around union type and intersection type operators.",
"oneOf": [
{
"enum": [
"none",
"single"
]
}
]
},
"space_multiple_catch": {
"default": null,
"description": "spacing to apply around type operator when catching exceptions of multiple types, use `null` to follow the value configured for `space`.",
"oneOf": [
{
"enum": [
"none",
"single",
null
]
}
]
}
},
"type": "object"
},
"unary_operator_spaces": {
"description": "Unary operators should be placed adjacent to their operands."
},
"use_arrow_functions": {
"description": "Anonymous functions with one-liner return statement must use arrow functions."
},
"visibility_required": {
"description": "Visibility MUST be declared on all properties and methods; `abstract` and `final` MUST be declared before the visibility; `static` MUST be declared after the visibility."
},
"void_return": {
"description": "Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1."
},
"whitespace_after_comma_in_array": {
"description": "In array declaration, there MUST be a whitespace after each comma."
},
"yoda_style": {
"description": "Write conditions in Yoda style (`true`), non-Yoda style (`['equal' => false, 'identical' => false, 'less_and_greater' => false]`) or ignore those conditions (`null`) based on configuration.",
"properties": {
"always_move_variable": {
"default": false,
"description": "Whether variables should always be on non assignable side when applying Yoda style.",
"type": "boolean"
},
"equal": {
"default": true,
"description": "Style for equal (`==`, `!=`) statements.",
"type": [
"boolean",
"null"
]
},
"identical": {
"default": true,
"description": "Style for identical (`===`, `!==`) statements.",
"type": [
"boolean",
"null"
]
},
"less_and_greater": {
"default": null,
"description": "Style for less and greater than (`<`, `<=`, `>`, `>=`) statements.",
"type": [
"boolean",
"null"
]
}
},
"type": "object"
}
},
"type": "object"
}
},
"title": "Laravel Pint",
"type": "object"
} | MIT | en |
je4/gocfl | e00b109b80b400ae8d504b889a9aad3461ec28c9 | 2023-11-24T16:29:36 | data/fullextensions/object/NNNN-metafile/gocfl-info-1.0.json | 9 | 2024-05-27T08:16:10.339061Z | {
"$defs": {
"Info": {
"additionalProperties": false,
"properties": {
"additional": {
"description": "unstructured additional data",
"title": "additional data",
"type": [
"number",
"string",
"boolean",
"object",
"array",
"null"
]
},
"address": {
"description": "address of person ingesting this archive (email)",
"title": "address",
"type": "string"
},
"alternative_titles": {
"description": "list of alternative titles of this object or parts of it",
"items": {
"type": "string"
},
"title": "alternative titles",
"type": "array",
"uniqueItems": true
},
"collection": {
"description": "name of collection the object belongs to",
"title": "collection name",
"type": "string"
},
"collection_id": {
"description": "id of collection the object belongs to",
"pattern": "[a-zA-Z0-9/._:-]+",
"title": "collection identifier",
"type": "string"
},
"created": {
"description": "date",
"format": "date-time",
"title": "creation date",
"type": "string"
},
"deprecates": {
"description": "signature of object",
"title": "deprecates",
"type": "string"
},
"description": {
"type": "string"
},
"identifiers": {
"description": "list of identifiers",
"items": {
"type": "string"
},
"title": "identifiers",
"type": "array",
"uniqueItems": true
},
"ingest_workflow": {
"description": "name of the workflow",
"title": "ingest workflow",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"last_changed": {
"description": "date",
"format": "date-time",
"title": "last changed",
"type": "string"
},
"organisation": {
"description": "name of organisation responsible for the object",
"title": "organisation name",
"type": "string"
},
"organisation_address": {
"description": "address of organisation taking care of this archive (e.g. email)",
"title": "address",
"type": "string"
},
"organisation_id": {
"description": "id or abbreviation of organisation responsible for the object",
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "organisation identifier",
"type": "string"
},
"references": {
"description": "list of signatures",
"items": {
"type": "string"
},
"title": "references",
"type": "array"
},
"sets": {
"description": "list of datasets object is belonging to",
"items": {
"type": "string"
},
"title": "sets",
"type": "array",
"uniqueItems": true
},
"signature": {
"description": "unique identifier within the archive system",
"maxLength": 128,
"minLength": 3,
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "archival signature",
"type": "string"
},
"title": {
"description": "title of object",
"title": "title",
"type": "string"
},
"user": {
"description": "name of person ingesting this object",
"title": "user",
"type": "string"
}
},
"required": [
"signature",
"organisation_id",
"organisation",
"title",
"user",
"address",
"created",
"last_changed"
],
"type": "object"
}
},
"$ref": "#/$defs/Info",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
je4/gocfl | 2a20d87ba5e1b8992e4210dea12909af6069c0d0 | 2023-11-30T09:36:20 | data/defaultextensions/object/NNNN-metafile/gocfl-info-1.0.json | 9 | 2024-05-27T08:16:10.339061Z | {
"$defs": {
"Info": {
"additionalProperties": false,
"properties": {
"additional": {
"description": "unstructured additional data",
"title": "additional data",
"type": [
"number",
"string",
"boolean",
"object",
"array",
"null"
]
},
"address": {
"description": "adress of person ingesting this archive (email",
"title": "address",
"type": "string"
},
"alternative_titles": {
"description": "list of alternative titles of this object or parts of it",
"items": {
"type": "string"
},
"title": "alternative titles",
"type": "array",
"uniqueItems": true
},
"collection": {
"description": "name of collection the object belongs to",
"title": "collection name",
"type": "string"
},
"collection_id": {
"description": "id of collection the object belongs to",
"pattern": "[a-zA-Z0-9/._:-]+",
"title": "collection identifier",
"type": "string"
},
"created": {
"description": "date",
"format": "date-time",
"title": "creation date",
"type": "string"
},
"deprecates": {
"description": "signature of object",
"title": "deprecates",
"type": "string"
},
"description": {
"type": "string"
},
"identifiers": {
"description": "list of identifiers",
"items": {
"type": "string"
},
"title": "identifiers",
"type": "array",
"uniqueItems": true
},
"ingest_workflow": {
"description": "name of the workflow",
"title": "ingest workflow",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"last_changed": {
"description": "date",
"format": "date-time",
"title": "last changed",
"type": "string"
},
"organisation": {
"description": "name of organisation responsible for the object",
"title": "organisation name",
"type": "string"
},
"organisation_address": {
"description": "adress of person ingesting this archive (email",
"title": "address",
"type": "string"
},
"organisation_id": {
"description": "id or abbreviation of organisation responsible for the object",
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "organisation identifier",
"type": "string"
},
"references": {
"description": "list of signatures",
"items": {
"type": "string"
},
"title": "references",
"type": "array"
},
"sets": {
"description": "list of datasets object is belonging to",
"items": {
"type": "string"
},
"title": "sets",
"type": "array",
"uniqueItems": true
},
"signature": {
"description": "unique identifier within the archive system",
"maxLength": 128,
"minLength": 3,
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "archival signature",
"type": "string"
},
"title": {
"description": "title of object",
"title": "title",
"type": "string"
},
"user": {
"description": "name of person ingesting this object",
"title": "user",
"type": "string"
}
},
"required": [
"signature",
"organisation_id",
"organisation",
"organisation_address",
"title",
"user",
"address",
"created",
"last_changed"
],
"type": "object"
}
},
"$ref": "#/$defs/Info",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
je4/gocfl | 7a7bb61bfedc82a1eaa2433712e551a1ee5e2115 | 2023-06-22T15:45:50 | gocfl-info-1.0.json | 9 | 2024-05-27T08:16:10.339061Z | {
"$defs": {
"Info": {
"additionalProperties": false,
"properties": {
"additional": {
"description": "unstructured additional data",
"title": "additional data",
"type": [
"number",
"string",
"boolean",
"object",
"array",
"null"
]
},
"address": {
"description": "adress of person ingesting this archive (email",
"title": "address",
"type": "string"
},
"alternative_titles": {
"description": "list of alternative titles of this object or parts of it",
"items": {
"type": "string"
},
"title": "alternative titles",
"type": "array",
"uniqueItems": true
},
"collection": {
"description": "name of collection the object belongs to",
"title": "collection name",
"type": "string"
},
"collection_id": {
"description": "id of collection the object belongs to",
"pattern": "[a-zA-Z0-9/._:-]+",
"title": "collection identifier",
"type": "string"
},
"created": {
"description": "date",
"format": "date-time",
"title": "creation date",
"type": "string"
},
"deprecates": {
"description": "signature of object",
"title": "deprecates",
"type": "string"
},
"description": {
"type": "string"
},
"identifiers": {
"description": "list of identifiers",
"items": {
"type": "string"
},
"title": "identifiers",
"type": "array",
"uniqueItems": true
},
"ingest_workflow": {
"description": "name of the workflow",
"title": "ingest workflow",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"last_changed": {
"description": "date",
"format": "date-time",
"title": "last changed",
"type": "string"
},
"organisation": {
"description": "name of organisation responsible for the object",
"title": "organisation name",
"type": "string"
},
"organisation_id": {
"description": "id or abbreviation of organisation responsible for the object",
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "organisation identifier",
"type": "string"
},
"references": {
"description": "list of signatures",
"items": {
"type": "string"
},
"title": "references",
"type": "array"
},
"sets": {
"description": "list of datasets object is belonging to",
"items": {
"type": "string"
},
"title": "sets",
"type": "array",
"uniqueItems": true
},
"signature": {
"description": "unique identifier within the archive system",
"maxLength": 128,
"minLength": 3,
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "archival signature",
"type": "string"
},
"title": {
"description": "title of object",
"title": "title",
"type": "string"
},
"user": {
"description": "name of person ingesting this object",
"title": "user",
"type": "string"
}
},
"required": [
"signature",
"organisation_id",
"organisation",
"title",
"user",
"address",
"created",
"last_changed"
],
"type": "object"
}
},
"$ref": "#/$defs/Info",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
je4/gocfl | 1bed00c70be244ea4dcd354e1ba1908ae3113535 | 2023-09-13T12:42:24 | data/defaultextensions/object/NNNN-metafile/gocfl-info-1.0.json | 9 | 2024-05-27T08:16:10.339061Z | {
"$defs": {
"Info": {
"additionalProperties": false,
"properties": {
"additional": {
"description": "unstructured additional data",
"title": "additional data",
"type": [
"number",
"string",
"boolean",
"object",
"array",
"null"
]
},
"address": {
"description": "adress of person ingesting this archive (email",
"title": "address",
"type": "string"
},
"alternative_titles": {
"description": "list of alternative titles of this object or parts of it",
"items": {
"type": "string"
},
"title": "alternative titles",
"type": "array",
"uniqueItems": true
},
"collection": {
"description": "name of collection the object belongs to",
"title": "collection name",
"type": "string"
},
"collection_id": {
"description": "id of collection the object belongs to",
"pattern": "[a-zA-Z0-9/._:-]+",
"title": "collection identifier",
"type": "string"
},
"created": {
"description": "date",
"format": "date-time",
"title": "creation date",
"type": "string"
},
"deprecates": {
"description": "signature of object",
"title": "deprecates",
"type": "string"
},
"description": {
"type": "string"
},
"identifiers": {
"description": "list of identifiers",
"items": {
"type": "string"
},
"title": "identifiers",
"type": "array",
"uniqueItems": true
},
"ingest_workflow": {
"description": "name of the workflow",
"title": "ingest workflow",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"last_changed": {
"description": "date",
"format": "date-time",
"title": "last changed",
"type": "string"
},
"organisation": {
"description": "name of organisation responsible for the object",
"title": "organisation name",
"type": "string"
},
"organisation_id": {
"description": "id or abbreviation of organisation responsible for the object",
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "organisation identifier",
"type": "string"
},
"references": {
"description": "list of signatures",
"items": {
"type": "string"
},
"title": "references",
"type": "array"
},
"sets": {
"description": "list of datasets object is belonging to",
"items": {
"type": "string"
},
"title": "sets",
"type": "array",
"uniqueItems": true
},
"signature": {
"description": "unique identifier within the archive system",
"maxLength": 128,
"minLength": 3,
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "archival signature",
"type": "string"
},
"title": {
"description": "title of object",
"title": "title",
"type": "string"
},
"user": {
"description": "name of person ingesting this object",
"title": "user",
"type": "string"
}
},
"required": [
"signature",
"organisation_id",
"organisation",
"title",
"user",
"address",
"created",
"last_changed"
],
"type": "object"
}
},
"$ref": "#/$defs/Info",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
je4/gocfl | df5cde78e987f2634ddf1f1ed63d478462c204f6 | 2023-06-23T10:31:08 | data/fullextensions/object/NNNN-metafile/gocfl-info-1.0.json | 9 | 2024-05-27T08:16:10.339061Z | {
"$defs": {
"Info": {
"additionalProperties": false,
"properties": {
"additional": {
"description": "unstructured additional data",
"title": "additional data",
"type": [
"number",
"string",
"boolean",
"object",
"array",
"null"
]
},
"address": {
"description": "adress of person ingesting this archive (email",
"title": "address",
"type": "string"
},
"alternative_titles": {
"description": "list of alternative titles of this object or parts of it",
"items": {
"type": "string"
},
"title": "alternative titles",
"type": "array",
"uniqueItems": true
},
"collection": {
"description": "name of collection the object belongs to",
"title": "collection name",
"type": "string"
},
"collection_id": {
"description": "id of collection the object belongs to",
"pattern": "[a-zA-Z0-9/._:-]+",
"title": "collection identifier",
"type": "string"
},
"created": {
"description": "date",
"format": "date-time",
"title": "creation date",
"type": "string"
},
"deprecates": {
"description": "signature of object",
"title": "deprecates",
"type": "string"
},
"description": {
"type": "string"
},
"identifiers": {
"description": "list of identifiers",
"items": {
"type": "string"
},
"title": "identifiers",
"type": "array",
"uniqueItems": true
},
"ingest_workflow": {
"description": "name of the workflow",
"title": "ingest workflow",
"type": "string"
},
"keywords": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"last_changed": {
"description": "date",
"format": "date-time",
"title": "last changed",
"type": "string"
},
"organisation": {
"description": "name of organisation responsible for the object",
"title": "organisation name",
"type": "string"
},
"organisation_id": {
"description": "id or abbreviation of organisation responsible for the object",
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "organisation identifier",
"type": "string"
},
"references": {
"description": "list of signatures",
"items": {
"type": "string"
},
"title": "references",
"type": "array"
},
"sets": {
"description": "list of datasets object is belonging to",
"items": {
"type": "string"
},
"title": "sets",
"type": "array",
"uniqueItems": true
},
"signature": {
"description": "unique identifier within the archive system",
"maxLength": 128,
"minLength": 3,
"pattern": "[a-zA-Z0-9/.-:-]+",
"title": "archival signature",
"type": "string"
},
"title": {
"description": "title of object",
"title": "title",
"type": "string"
},
"user": {
"description": "name of person ingesting this object",
"title": "user",
"type": "string"
}
},
"required": [
"signature",
"organisation_id",
"organisation",
"title",
"user",
"address",
"created",
"last_changed"
],
"type": "object"
}
},
"$ref": "#/$defs/Info",
"$schema": "https://json-schema.org/draft/2020-12/schema"
} | Apache-2.0 | en |
gregsdennis/json-everything | b8ea46d981bf35ac0193c91d365469ffefd59f7a | 2024-05-14T03:11:14 | src/JsonSchema.Tests/Files/Issue435_schema.json | 868 | 2024-05-27T21:58:40.446108Z | {
"$defs": {
"BaseType": {
"properties": {
"field1": {
"type": "string"
}
},
"type": "object"
},
"DerivedType": {
"allOf": [
{
"$ref": "#/$defs/BaseType"
},
{
"properties": {
"field2": {
"type": "string"
}
}
}
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema",
"items": {
"$ref": "#/$defs/DerivedType"
},
"type": "array"
} | MIT | en |
TRaSH-Guides/Guides | d0a8289f2831edcd7e637b76d5ae3ad892726168 | 2022-08-24T13:35:52 | metadata.schema.json | 1,550 | 2024-05-29T10:09:53.308845Z | {
"$defs": {
"custom_formats": {
"items": {
"type": "string"
},
"type": "array"
},
"radarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/custom_formats"
}
},
"type": "object"
},
"release_profiles": {
"items": {
"type": "string"
},
"type": "array"
},
"sonarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/custom_formats"
},
"release_profiles": {
"$ref": "#/$defs/release_profiles"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/TRaSH-/Guides/master/metadata.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"json_paths": {
"additionalProperties": false,
"properties": {
"radarr": {
"$ref": "#/$defs/radarr"
},
"sonarr": {
"$ref": "#/$defs/sonarr"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
TRaSH-Guides/Guides | 6c9d94c87ca24cce6fe829f1aaed4f1b003b9546 | 2023-02-16T19:46:26 | metadata.schema.json | 1,550 | 2024-05-29T10:09:53.308845Z | {
"$defs": {
"paths_object": {
"items": {
"type": "string"
},
"type": "array"
},
"radarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
},
"recyclarr": {
"additionalProperties": false,
"properties": {
"templates": {
"type": "string"
}
},
"type": "object"
},
"sonarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
},
"release_profiles": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/TRaSH-/Guides/master/metadata.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"json_paths": {
"additionalProperties": false,
"properties": {
"radarr": {
"$ref": "#/$defs/radarr"
},
"recyclarr": {
"$ref": "#/$defs/recyclarr"
},
"sonarr": {
"$ref": "#/$defs/sonarr"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
TRaSH-Guides/Guides | 9c17d5fae66f2b95e45cc0df70b77b0584bcea34 | 2023-02-16T23:44:05 | metadata.schema.json | 1,550 | 2024-05-29T10:09:53.308845Z | {
"$defs": {
"paths_object": {
"items": {
"type": "string"
},
"type": "array"
},
"radarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
},
"recyclarr": {
"additionalProperties": false,
"properties": {
"templates": {
"type": "string"
}
},
"type": "object"
},
"sonarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
},
"release_profiles": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/TRaSH-/Guides/master/metadata.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"json_paths": {
"additionalProperties": false,
"properties": {
"radarr": {
"$ref": "#/$defs/radarr"
},
"sonarr": {
"$ref": "#/$defs/sonarr"
}
},
"type": "object"
},
"recyclarr": {
"$ref": "#/$defs/recyclarr"
}
},
"type": "object"
} | MIT | en |
TRaSH-Guides/Guides | 7f986596046de8e544b8f64bac38b8f104c17f1d | 2022-08-24T13:58:34 | metadata.schema.json | 1,550 | 2024-05-29T10:09:53.308845Z | {
"$defs": {
"paths_object": {
"items": {
"type": "string"
},
"type": "array"
},
"radarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
},
"sonarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
},
"release_profiles": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/TRaSH-/Guides/master/metadata.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"json_paths": {
"additionalProperties": false,
"properties": {
"radarr": {
"$ref": "#/$defs/radarr"
},
"sonarr": {
"$ref": "#/$defs/sonarr"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
TRaSH-Guides/Guides | 9bce114c976c9201e4041ae1c9e43144bc5e2ed8 | 2022-08-15T15:19:44 | metadata.schema.json | 1,550 | 2024-05-29T10:09:53.308845Z | {
"$defs": {
"custom_formats": {
"items": {
"type": "string"
},
"type": "array"
},
"radarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/custom_formats"
}
},
"type": "object"
},
"release_profiles": {
"items": {
"type": "string"
},
"type": "array"
},
"sonarr": {
"additionalProperties": false,
"properties": {
"release_profiles": {
"$ref": "#/$defs/release_profiles"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/TRaSH-/Guides/master/metadata.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"json_paths": {
"additionalProperties": false,
"properties": {
"radarr": {
"$ref": "#/$defs/radarr"
},
"sonarr": {
"$ref": "#/$defs/sonarr"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
TRaSH-Guides/Guides | 92ed62325e7e596bceb6d679ade74bd98cc1e703 | 2022-12-11T20:43:16 | metadata.schema.json | 1,550 | 2024-05-29T10:09:53.308845Z | {
"$defs": {
"paths_object": {
"items": {
"type": "string"
},
"type": "array"
},
"radarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
},
"sonarr": {
"additionalProperties": false,
"properties": {
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
},
"release_profiles": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/TRaSH-/Guides/master/metadata.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"json_paths": {
"additionalProperties": false,
"properties": {
"radarr": {
"$ref": "#/$defs/radarr"
},
"sonarr": {
"$ref": "#/$defs/sonarr"
}
},
"type": "object"
}
},
"type": "object"
} | MIT | en |
TRaSH-Guides/Guides | 44d3f87d44fcdc5186750a7d94c2593168cc5f0f | 2024-04-23T04:00:35 | metadata.schema.json | 1,550 | 2024-05-29T10:09:53.308845Z | {
"$defs": {
"paths_object": {
"items": {
"type": "string"
},
"type": "array"
},
"radarr": {
"additionalProperties": false,
"properties": {
"custom_format_groups": {
"$ref": "#/$defs/paths_object"
},
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
},
"quality_profiles": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
},
"recyclarr": {
"additionalProperties": false,
"properties": {
"templates": {
"type": "string"
}
},
"type": "object"
},
"sonarr": {
"additionalProperties": false,
"properties": {
"custom_format_groups": {
"$ref": "#/$defs/paths_object"
},
"custom_formats": {
"$ref": "#/$defs/paths_object"
},
"naming": {
"$ref": "#/$defs/paths_object"
},
"qualities": {
"$ref": "#/$defs/paths_object"
},
"quality_profiles": {
"$ref": "#/$defs/paths_object"
},
"release_profiles": {
"$ref": "#/$defs/paths_object"
}
},
"type": "object"
}
},
"$id": "https://raw.githubusercontent.com/TRaSH-/Guides/master/metadata.schema.json",
"$schema": "https://json-schema.org/draft-07/schema",
"additionalProperties": false,
"properties": {
"$schema": {
"type": "string"
},
"json_paths": {
"additionalProperties": false,
"properties": {
"radarr": {
"$ref": "#/$defs/radarr"
},
"sonarr": {
"$ref": "#/$defs/sonarr"
}
},
"type": "object"
},
"recyclarr": {
"$ref": "#/$defs/recyclarr"
}
},
"type": "object"
} | MIT | en |
Subsets and Splits