docs: improve documentation
Closed this issue · 1 comments
wise-introvert commented
Add a few more examples and explain a little more clearly what the output means
wise-introvert commented
A more realistic json object that can be used for the example:
{
"users": [
{
"id": 1,
"name": "John Smith",
"email": "john.smith@example.com",
"address": {
"street": "123 Main St",
"city": "Anytown",
"state": "NY",
"zip": "12345",
"phoneNumbers": [
{
"type": "home",
"number": "555-555-5555"
},
{
"type": "work",
"number": "555-555-5556"
}
],
"previousAddresses": [
{
"street": "456 Elm St",
"city": "Anytown",
"state": "NY",
"zip": "54321",
"yearsLived": 3,
"phoneNumbers": [
{
"type": "home",
"number": "555-555-5557"
},
{
"type": "work",
"number": "555-555-5558"
}
],
"previousAddresses": [
{
"street": "111 Pine St",
"city": "Anytown",
"state": "NY",
"zip": "11111",
"yearsLived": 1
},
{
"street": "222 Cedar St",
"city": "Anytown",
"state": "NY",
"zip": "22222",
"yearsLived": 2
}
]
},
{
"street": "789 Oak St",
"city": "Anytown",
"state": "NY",
"zip": "67890",
"yearsLived": 5,
"phoneNumbers ": [
{
"type": "home",
"number": "555-555-5559"
},
{
"type": "work",
"number": "555-555-5560"
}
],
"previousAddresses": [
{
"street": "333 Maple St",
"city": "Anytown",
"state": "NY",
"zip": "33333",
"yearsLived": 3
},
{
"street": "444 Birch St",
"city": "Anytown",
"state": "NY",
"zip": "44444",
"yearsLived": 4
}
]
}
]
},
"orders": [
{
"id": 101,
"date": "2022-01-01",
"total": 123,
"items": [
{
"name": "item 1",
"quantity": 2,
"price": 50
},
{
"name": "item 2",
"quantity": 1,
"price": 40
}
],
"shippingAddress": {
"street": "123 Main St",
"city": "Anytown",
"state": "NY",
"zip": "12345"
}
},
{
"id": 102,
"date": "2022-02-01",
"total": 200,
"items": [
{
"name": "item 3",
"quantity": 3,
"price": 30
},
{
"name": "item 4",
"quantity": 2,
"price": 25
}
],
"shippingAddress": {
"street": "456 Elm St",
"city": "Anytown",
"state": "NY",
"zip": "54321"
}
}
]
},
{
"id": 2,
"name": "Jane Doe",
"email": "jane.doe@example.com",
"address": {
"street": "987 Park Ave",
"city": "Anytown",
"state": "NY",
"zip": "98765",
"phoneNumbers": [
{
"type": "home",
"number": "555-555-5561"
},
{
"type": "work",
"number": "555-555-5562"
}
],
"previousAddresses": [
{
"street": "654 Elm St",
"city": "Anytown",
"state": "NY",
"zip": "65432",
"yearsLived": 4
},
{
"street": "321 Oak St",
"city": "Anytown",
"state": "NY",
"zip": "32109",
"yearsLived": 2,
"phoneNumbers": [
{
"type": "home",
"number": "555-555-5563"
},
{
"type": "work",
"number": "555-555-5564"
}
],
"previousAddresses": [
{
"street": "321 Pine St",
"city": "Anytown",
"state": "NY",
"zip": "11111",
"yearsLived": 1
},
{
"street": "432 Cedar St",
"city": "Anytown",
"state": "NY",
"zip": "22222",
"yearsLived": 2
}
]
},
{
"street": "765 Oak St",
"city": "Anytown",
"state": "NY",
"zip": "67890",
"yearsLived": 5,
"phoneNumbers": [
{
"type": "home",
"number": "555-555-5565"
},
{
"type": "work",
"number": "555-555-5566"
}
],
"previousAddresses": [
{
"street": "876 Maple St",
"city": "Anytown",
"state": "NY",
"zip": "33333",
"yearsLived": 3
},
{
"street": "987 Birch St",
"city": "Anytown",
"state": "NY",
"zip": "44444",
"yearsLived": 4
}
]
}
]
},
"orders": [
{
"id": 101,
"date": "2022-01-01",
"total": 123,
"items": [
{
"name": "item 1",
"quantity": 2,
"price": 50
},
{
"name": "item 2",
"quantity": 1,
"price": 40
}
],
"shippingAddress": {
"street": "123 Main St",
"city": "Anytown",
"state": "NY",
"zip": "12345"
}
},
{
"id": 102,
"date": "2022-02-01",
"total": 200,
"items": [
{
"name": "item 3",
"quantity": 3,
"price": 30
},
{
"name": "item 4",
"quantity": 2,
"price": 25
}
],
"shippingAddress": {
"street": "456 Elm St",
"city": "Anytown",
"state": "NY",
"zip": "54321"
}
}
]
}
]
}