New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

create json schema and example yaml for an object #9

Closed

kfarr opened this issue Mar 20, 2023 · 3 comments

Contributor

kfarr commented Mar 20, 2023 •

edited

Loading

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)

Contributor Author

kfarr commented Mar 20, 2023

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

Contributor Author

kfarr commented Mar 25, 2023

3DStreet/3dstreet-docs@dfc1195

Contributor Author

kfarr commented Oct 9, 2024

see https://github.com/3DStreet/3dstreet/blob/main/src/catalog.json

kfarr closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment