Skip to content
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.

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

Create asset metadata template #9

Open
vuldin opened this issue Apr 18, 2022 · 0 comments
Open

Create asset metadata template #9

vuldin opened this issue Apr 18, 2022 · 0 comments
Assignees

Comments

@vuldin
Copy link
Collaborator

vuldin commented Apr 18, 2022

NPM has a REST API, and this page also defines some metadata details returned on requests to various endpoints: https://github.com/npm/registry/blob/master/docs/REGISTRY-API.md

Here are some ideas for asset metadata:

{
  "_id": "adf87afd87ag8h78h78hbcv",
  "name": "@org/asset-name",
  "version": "0.1.0",
  "description": "asset description",
  "keywords": ["asset", "model", "others"],
  "homepage": "https://somepage.com",
  "license": "MIT",
  "main": "index.js",
  "repository": {
    "type": "git",
    "url": https://github.com/someorg/somerepo"
  },
  "type": "model"
  "schema": {
    "type": "avro",
    "url": "http://schema-registry.org:8081/subject/someasset/1"
  },
  "maintainers": ["[email protected]", "[email protected]"],
  "isPrivate": true,
  "dependencies": {
    "@org1/asset1": "1.0.1",
    "@org1/asset2": "2.0.1",
    "@org2/asset1": "1.0.3"
  }
}

This is just a first draft based on npm and github. I'm not sure about isPrivate and dependencies... npm handles unpublished or private assets some other way (need to look into details). And dependencies may not make sense for our assets.

@jankivora jankivora self-assigned this Apr 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants