ldexterldesign / buy-sell Goto Github PK

💵 A schema (made from https://json-schema.org + https://schema.org) to help me record/reference when buying/selling things (and perhaps you too?)

buy-sell's Introduction

buy-sell's People

Contributors

Watchers

buy-sell's Issues

Add product.url

BUY Briki/cezve/ibrik

Sanitise use of additionalType property

See latest podcast schema

Add priceSpecification.discount/reduction/sale?

schemaorg/schemaorg#1742 (comment)

Create `.price` `$defs` and use it

E.g. priceSpecification.deliveryChargeSpecification.price

Increase alias usage

#6 (comment)

Enhance for unknown values (e.g. undefined, null, n/a, none, ?)

{
    "dateCreated": "2022-07-19",
    "datePurchased": "2019-09",
    "priceSpecification": {
        "deliveryChargeSpecification": {
            "price": null // ?
        },
        "price": null, // ?
        "priceCurrency": "eur",
        "totalPrice": 74.38,
        "totalPriceUnit": 7.438,
        "unitPriceSpecification": {
            "referenceQuantity": 10
        },
        "valueAddedTaxIncluded": null // ?
    },
    "product": {
        "brand": "http://tricorp.com",
        "model": "t190",
        "name": "tricorp",
        "size": "medium",
        "url": "http://tricorp.com/en/all-products/t-shirts/101002-t190/190-gsm-t-shirt"
    },
    "seller": {
        "agent": {
            "url": "http://beschermkleding-shop.nl/t-shirt-rom88-t-190.html"
        },
        "agentType": "organization"
    }
}

Remove s:additionalType on types which aren't https://schema.org/DataType (i.e. array, object)

remove product.nsn

gtin covers most products

transfer product.gtin & product.productID to product.identifier.gtin & product.identifier.gtin

Add examples (annotation) throughout schema.json & use the root examples to update data-example.json

update seller.allOf to seller.anyOf

seller can be a person, organisation or both

Review use of seller conditional schema logic

Currently anyOf but should be oneOf?

Implement feedback

Sorry for not getting to this sooner. I've been off the grid for a while.

I like the way the custom keywords are working out. The only issue is that $comment doesn't make sense in alias. alias is not a schema, so putting JSON Schema keywords in there doesn't make sense. I'd move that up a level.

The main problem I see is missing properties keywords in a few places. Mostly, I see this at the top level. For example, it looks like you intend the following to be top level properties: buyer, priceSpecification, product, seller, service. These need to be under a properties keyword.

Hi @jdesrosiers!

Thanks for feedback - very kind

I've deleted the gist and migrated it to this repo, which I created the other day - it's almost identical to the gist with the exception of some bits unrelated to your feedback

I'll implement your feedback in a commit shortly and hope you'd be kind enough to glance at it again so I can resolve this issue

Sincerely

Update URIs from URLs to aliases

https://github.com/ldexterldesign/BUY-SELL/blob/master/schema.json#L101

Before:

...
"s:additionalType": "https://schema.org/SellAction"
...

After:

...
"s:additionalType": "s:SellAction"
...

Add product.countryOfOrigin

Reference https://docs.google.com/spreadsheets/d/1Dix8qsAAjLS72ARj-gMq6-QCu14noJwjUPC60p2G0F0/edit#gid=1414837814

Add https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 to seller.location.addressCountry and anything else that warrants it

Specifically

add date

Transfer $comment to description (annotation)

The $comment keyword is strictly intended for adding comments to the JSON schema source. Its value must always be a string. Unlike the annotations title, description and examples, JSON schema implementations aren’t allowed to attach any meaning or behavior to it whatsoever, and may even strip them at any time. Therefore, they are useful for leaving notes to future editors of a JSON schema, (which is quite likely your future self), but should not be used to communicate to users of the schema.

"eligibleRegion": {
    "$comment": "Do use ISO 3166-1 alpha-3 three-letter country codes http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3",
    "examples": [
        "mlt",
        "gbr"
    ],
    "items": {
        "type": "string"
    },
    "s:additionalType": "http://schema.org/Text",
    "s:sameAs": "http://schema.org/eligibleRegion",
    "type": "array"
}

"totalPriceUnit": {
    "$comment": "totalPrice / unitPriceSpecification.referenceQuantity",
    "type": "number"
}

Both of these $comments are instructions to users so should not be $comments according to spec'. Transfer to description annotations.

Review itemOffered

https://schema.org/itemOffered

Update brand to organization type

From:

                    "brand": {
                        "properties": {
                            "name": {
                                "s:additionalType": "s:Text",
                                "type": "string"
                            },
                            "url": {
                                "$ref": "#url"
                            }
                        },
                        "s:additionalType": "s:Brand",
                        "s:sameAs": "s:brand",
                        "type": "object"
                    }

To:

                    "brand": {
                        "$ref": "#organization",
                        "s:sameAs": "s:brand"
                    }

[ ] 1/5 old, used lot, ok
[ ] 2/5 n/a, used, fine/good
[ ] 3/5 n/a, used some, great
[ ] 4/5 n/a, used little, excellent
[ ] 5/5 new, unused, mint/perfect

ldexterldesign / buy-sell Goto Github PK

buy-sell's Introduction

buy-sell's People

Contributors

Watchers

buy-sell's Issues

Recommend Projects

Recommend Topics

Recommend Org