create json schema and example yaml for an object - Githubissues

3DStreet / 3dstreet-assets-dist

Distribution repo for 3DStreet assets for use by first and third party clients

https://assets.3dstreet.app/

Other

6 stars 4 forks source link

create json schema and example yaml for an object #9

Open kfarr opened 1 year ago

kfarr commented 1 year ago

to help with the goal of having a public model browsing interface

create a JSON schema (example)
and a YAML for each model (example)

Required fields for each model:

id (model mixin string, no spaces only A-Za-z0-9 and "-" symbols)
name (a display name supporting any unicode characters)
description (string, <280 chars)
preview (image URL)
asset (URL)
category (one of vehicle, character, building, mobility, etc...)

optional fields:

long description (string, basic markdown supported)
model dimensions (string of height, width, depth in meters)
license name (string, short <255 chars)
license details (string, long >255 chars)
license link (URL)
copyright details
author name
author link
streetmix segment name and/or variant (type?)
source file (URL)

kfarr commented 1 year ago

Here's a v1 of this schema generated by GPT-4 from the above ticket 3dstreet-model-schema-0.0.1.json.zip

kfarr commented 1 year ago

https://github.com/3DStreet/3dstreet-docs/commit/dfc1195e07543643ff3a2607fac870b17a312886