apollo/spruce
1
0
Fork 0
Code Issues Pull requests Projects Releases Activity Actions
spruce/docs/schema.asciidoc

179 lines
2.6 KiB
Text
Raw Normal View History

checkpoint: move all docs to docs folder for flow site support
2024-02-05 23:35:05 +00:00
---
title: "Spruce - JSON schema reference"
---
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
= JSON schema reference
NOTE: This page was auto-generated with spruce-docgen.
== CV
A short written summary of your skills, achievements and experiences in relation to your role.
[%header,cols=3*]
|===
|Field
|Type
|Description
|contact
fix: improve spruce-docgen Improve spruce-docgen by improving how additionalProperties is unmarshalled. If the value is either true or false then AdditionalProperties is set to the default schema value. Update getType to return discovered maps. Update refType to return UNKNOWN if the ref string is invalid. Regenerated docs/schema.asciidoc
2023-08-18 15:06:38 +01:00
|map(string)
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
|Your contact information. You can use any key/value pairs here.
|education
fix: create separate types for work and education Create separate types for education and employment to fix the issue where unnecessary fields are created under both education and employment when a new CV is created.
2023-08-19 00:29:55 +01:00
|list(<<Education>>)
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
|A list of your education experiences.
|employment
fix: create separate types for work and education Create separate types for education and employment to fix the issue where unnecessary fields are created under both education and employment when a new CV is created.
2023-08-19 00:29:55 +01:00
|list(<<Employment>>)
|A list of your employment history.
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
|firstName
|string
|Your first name(s).
|interests
|list(string)
|A list of sentences summarising your interests and hobbies.
|jobTitle
|string
|Your current job title.
|lastName
|string
|Your last name.
|links
fix: improve spruce-docgen Improve spruce-docgen by improving how additionalProperties is unmarshalled. If the value is either true or false then AdditionalProperties is set to the default schema value. Update getType to return discovered maps. Update refType to return UNKNOWN if the ref string is invalid. Regenerated docs/schema.asciidoc
2023-08-18 15:06:38 +01:00
|map(string)
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
|URLs to your online presence such as GitHub or your website. You can use any key/value pairs here.
|skills
|list(<<Skills>>)
|A categorised list of your skills.
|summary
|list(string)
|A list of sentences summarising your skills, experiences and what you'd like to achieve in the near future.
|===
=== Date
[%header,cols=3*]
|===
|Field
|Type
|Description
|day
fix: use JSON schema to auto-generate the CV type - Use go generate and a third party tool called jsonschemagen to auto-generate the CV data type from the JSON schema. - Update the schema by changing number to integer to ensure that the integers are set to the correct type. - Refactor some code.
2023-08-18 23:42:01 +01:00
|integer
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
|The day of the month.
|month
fix: use JSON schema to auto-generate the CV type - Use go generate and a third party tool called jsonschemagen to auto-generate the CV data type from the JSON schema. - Update the schema by changing number to integer to ensure that the integers are set to the correct type. - Refactor some code.
2023-08-18 23:42:01 +01:00
|integer
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
|The numerical value of the month (e.g. 5 for May).
|year
fix: use JSON schema to auto-generate the CV type - Use go generate and a third party tool called jsonschemagen to auto-generate the CV data type from the JSON schema. - Update the schema by changing number to integer to ensure that the integers are set to the correct type. - Refactor some code.
2023-08-18 23:42:01 +01:00
|integer
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
|The year (e.g. 2023).
|===
=== Duration
[%header,cols=3*]
|===
|Field
|Type
|Description
|end
|<<Date>>
|The end date of the experience.
|present
|boolean
|Specifies whether you are currently employed or studying at the specified company or educational institute.
|start
|<<Date>>
|The start date of the experience.
|===
fix: create separate types for work and education Create separate types for education and employment to fix the issue where unnecessary fields are created under both education and employment when a new CV is created.
2023-08-19 00:29:55 +01:00
=== Education
[%header,cols=3*]
|===
|Field
|Type
|Description
|details
|list(string)
|Further details of the experience.
|duration
|<<Duration>>
|The duration of the experience.
|location
|string
|The location where the experience was based.
|qualification
|string
|The qualifications gained from this educational experience.
|school
|string
|The school or university where you have studied.
|===
=== Employment
feat: add JSON schema and document generator Add the schema for the CV JSON documentation and add an internal tool called spruce-docgen that generates an AsciiDoc referencing the schema.
2023-08-17 21:51:53 +01:00
[%header,cols=3*]
|===
|Field
|Type
|Description
|company
|string
|The company where your work experience took place.
|details
|list(string)
|Further details of the experience (e.g. achievements, daily responsibilities, etc).
|duration
|<<Duration>>
|The duration of the experience.
|jobTitle
|string
|The job title of your experience.
|location
|string
|The location where the experience was based.
|locationType
|string
|The location type of your work experience (e.g. Remote, Hybrid, On-site).
|===
=== Skills
[%header,cols=3*]
|===
|Field
|Type
|Description
|category
|string
|The skills category.
|values
|list(string)
|The skills listed in this category.
|===
Reference in a new issue Copy permalink