mirror of
https://github.com/alexgo-io/stacks-blockchain-api.git
synced 2026-01-12 16:53:19 +08:00
61 lines
2.4 KiB
JSON
61 lines
2.4 KiB
JSON
{
|
|
"name": "@stacks/stacks-blockchain-api-types",
|
|
"version": "0.1.0",
|
|
"access": "public",
|
|
"description": "TypeScript descriptions of Stacks 2.0 blockchain API entities",
|
|
"main": "index.js",
|
|
"types": "index.d.ts",
|
|
"scripts": {
|
|
"build": "npm run generate:schemas",
|
|
"test": "npm run build && npm run lint:json && npm run lint:yaml && npm run validate:schemas && npm run deploy:docs",
|
|
"lint:yaml": "yamllint ./openapi.yaml",
|
|
"lint:json": "jsonlint-cli ./api/**/*.json ./entities/**/*.json",
|
|
"lint:openapi": "lint-openapi ./openapi.yaml",
|
|
"generate:types": "ts-node ./scripts/generate-types.ts",
|
|
"generate:schemas": "gulp && npm run generate:types",
|
|
"generate:resolved-spec": "export API_VERSION=$(shx tail -n 1 ../.git-info) && speccy resolve --output .tmp/openapi.resolved.yaml openapi.yaml && shx sed -i 'STACKS_API_VERSION' ${API_VERSION:-1.0.0} .tmp/openapi.resolved.yaml > /dev/null",
|
|
"generate:docs": "redoc-cli bundle --output .tmp/index.html .tmp/openapi.resolved.yaml",
|
|
"generate:postman": "openapi2postmanv2 --spec .tmp/openapi.resolved.yaml --output .tmp/collection.json --options folderStrategy=Tags,requestParametersResolution=Example,exampleParametersResolution=Example",
|
|
"validate:schemas": "rimraf .tmp && gulp flattenSchemas --silent && ts-node ./scripts/validate-schemas.ts",
|
|
"deploy:docs": "npm run generate:types && npm run generate:docs && gulp deployDocs"
|
|
},
|
|
"author": "@hirosystems",
|
|
"license": "ISC",
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/hirosystems/stacks-blockchain-api.git",
|
|
"directory": "docs"
|
|
},
|
|
"files": [
|
|
"openapi.yaml",
|
|
"index.d.ts",
|
|
"generated.d.ts",
|
|
"socket-io/**/*",
|
|
"api/**/*",
|
|
"entities/**/*"
|
|
],
|
|
"devDependencies": {
|
|
"@apidevtools/json-schema-ref-parser": "^9.0.7",
|
|
"@types/json-schema-merge-allof": "^0.6.0",
|
|
"ajv": "^6.12.2",
|
|
"chalk": "^4.0.0",
|
|
"del": "^5.1.0",
|
|
"glob": "^7.1.6",
|
|
"gulp": "^4.0.2",
|
|
"gulp-gh-pages": "^0.6.0-6",
|
|
"gulp-jsonschema-deref": "0.0.3",
|
|
"ibm-openapi-validator": "^0.27.1",
|
|
"json-schema": "^0.2.5",
|
|
"json-schema-merge-allof": "^0.7.0",
|
|
"json-schema-to-typescript": "^10.1.4",
|
|
"jsonlint-cli": "^1.0.1",
|
|
"openapi-to-postmanv2": "^2.10.1",
|
|
"redoc-cli": "^0.9.8",
|
|
"shx": "^0.3.3",
|
|
"speccy": "^0.11.0",
|
|
"ts-node": "^9.1.1",
|
|
"typescript": "^4.2.4",
|
|
"yaml-lint": "^1.2.4"
|
|
}
|
|
}
|