Skip to content

Commit

Permalink
improved FAQ description text (#709)
Browse files Browse the repository at this point in the history
* improved FAQ description text

* Updated FAQ general questions

* Updated FAQ description text for fix one-sentence bug

* Update data/faq.json

Co-authored-by: Benjamin Granados <[email protected]>

* Update data/faq.json

Co-authored-by: Benjamin Granados <[email protected]>

* Update data/faq.json

Co-authored-by: Benjamin Granados <[email protected]>

* Update pages/overview/faq/index.page.tsx

---------

Co-authored-by: Benjamin Granados <[email protected]>
  • Loading branch information
kwennB and benjagm authored May 28, 2024
1 parent c400a71 commit f155ea9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
12 changes: 6 additions & 6 deletions data/faq.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
{
"id": 1,
"question": "What is JSON Schema?",
"answer": "JSON Schema is a vocabulary that allows you to annotate and validate JSON documents. It defines the structure, data types, and constraints of JSON data.",
"answer": "JSON Schema is a specification for defining the structure of JSON data. It provides a standardized way to annotate, describe, and validate JSON data. JSON Schema defines content, structure, data types, and other expected constraints within a JSON document.",
"category": "general"
},
{
Expand All @@ -14,7 +14,7 @@
{
"id": 3,
"question": "What is the purpose of 'type' in JSON Schema?",
"answer": "The 'type' keyword specifies the data type of the JSON value. It can be 'string', 'number', 'object', 'array', 'boolean', 'null', or a combination of these.",
"answer": "The 'type' keyword defines the data type of the schema and guarantees that the validated data complies with the specified type. JSON Schema defines these types; 'string', 'number', 'integer', 'object', 'array', 'boolean', and 'null'. The type keyword primarily functions for data validation, compatibility across systems, and restriction of JSON documents.",
"category": "general"
},
{
Expand All @@ -26,25 +26,25 @@
{
"id": 5,
"question": "What is the significance of 'required' in JSON Schema?",
"answer": "The 'required' keyword is an array that specifies which properties must be present in a JSON document. It enforces that these properties are not omitted.",
"answer": "The 'required' keyword ensures that specific properties must be present in the JSON data being validated. It specifies which properties are mandatory, avoids errors or incomplete processing by guaranteeing the provision of necessary data, and works for form validation, configuration files, schema evolution, etc.",
"category": "general"
},
{
"id": 6,
"question": "How can I validate a JSON document against a JSON Schema?",
"answer": "You can use various tools and libraries, such as AJV (Another JSON Schema Validator) in JavaScript, to validate a JSON document against a JSON Schema. These tools check if the document adheres to the specified schema rules.",
"answer": "You can use various tools and libraries, such as AJV (Another JSON Schema Validator), to validate a JSON document against a JSON Schema. It ensures the JSON data adheres to the expected format and constraints defined in the schema.",
"category": "general"
},
{
"id": 7,
"question": "What is the difference between 'object' and 'array' types in JSON Schema?",
"answer": "In JSON Schema, 'object' is used to define an object with named properties, while 'array' is used to define an ordered list of values. 'object' contains key-value pairs, whereas 'array' contains elements identified by their index.",
"answer": "The object type in JSON Schema represents a collection of key-value pairs, ideal for modeling entities with named properties, like a person with attributes such as name and age. In contrast, the array type represents ordered collections of items suited for sequences of similar elements, such as lists of strings or objects. Understanding these differences helps to describe and validate JSON data structures.",
"category": "general"
},
{
"id": 8,
"question": "Can I use JSON Schema to describe nested structures?",
"answer": "Yes, JSON Schema supports nested structures. You can define properties with their own JSON Schema, allowing you to describe complex hierarchical data.",
"answer": "JSON Schema allows for describing nested structures to represent complex, hierarchical data. You can define properties with their own JSON Schema, objects within objects, and arrays within objects or arrays, providing a flexible way to model various data relationships.",
"category": "general"
}
]
4 changes: 2 additions & 2 deletions pages/overview/faq/index.page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ export default function Content() {
</Head>
<Headline1>{newTitle}</Headline1>
<p>
Lorem ipsum dolor sit amet consectetur adipisicing elit. Nobis, totam?
Asperiores delectus perspiciatis, reprehenderit, harum quasi unde
Below you'll find answers to questions we get asked the most about JSON
Schema.
</p>

<Faq category='general' />
Expand Down

0 comments on commit f155ea9

Please sign in to comment.