We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
Hi, so I have this in package.json: "devDependencies": { "apidoc-plugin-schema": "^0.1.8" }
"devDependencies": { "apidoc-plugin-schema": "^0.1.8" }
and this in my api file: * @apiSchema (Admin) {jsonschema=./addAgent.json} apiParam
* @apiSchema (Admin) {jsonschema=./addAgent.json} apiParam
and this in my ./addAgent.json file: { "type": "object", "properties": { "agent": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" } } } } }
{ "type": "object", "properties": { "agent": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" } } } } }
Then, when I run the command in terminal: apidoc -i ./endpoints/ -o ./docs/ -v I get this: verbose: apidoc-generator name: apidoc verbose: apidoc-generator version: 0.17.6 verbose: apidoc-core version: 0.8.3 verbose: apidoc-spec version: 0.3.0 verbose: run parser verbose: parse file: endpoints/admin/acceptTempAddress.ts verbose: parse file: endpoints/admin/acceptTempName.ts **warn: parser plugin 'apischema' not found in block: 2** verbose: parse file: endpoints/admin/addAgent.ts verbose: parse file: endpoints/admin/addBankToUsers.ts verbose: parse file: endpoints/admin/addClient.ts verbose: parse file: endpoints/admin/addMessage.ts verbose: parse file: endpoints/admin/createInstances.ts verbose: parse file: endpoints/admin/deleteClient.ts verbose: parse file: endpoints/admin/deleteContract.ts verbose: run worker verbose: worker preProcess: apierrorstructure verbose: worker preProcess: apierrortitle verbose: worker preProcess: apigroup verbose: worker preProcess: apiheaderstructure verbose: worker preProcess: apiheadertitle verbose: worker preProcess: apiparamtitle verbose: worker preProcess: apipermission verbose: worker preProcess: apistructure verbose: worker preProcess: apisuccessstructure verbose: worker preProcess: apisuccesstitle verbose: worker preProcess: apiuse verbose: worker postProcess: apierrorstructure verbose: worker postProcess: apierrortitle verbose: worker postProcess: apigroup verbose: worker postProcess: apiheaderstructure verbose: worker postProcess: apiheadertitle verbose: worker postProcess: apiname verbose: worker postProcess: apiparamtitle verbose: worker postProcess: apipermission verbose: worker postProcess: apisamplerequest verbose: worker postProcess: apistructure verbose: worker postProcess: apisuccessstructure verbose: worker postProcess: apisuccesstitle verbose: worker postProcess: apiuse verbose: run filter verbose: filter postFilter: apierror verbose: filter postFilter: apiheader verbose: filter postFilter: apiparam verbose: filter postFilter: apisuccess verbose: create dir: docs/ verbose: copy template /usr/local/lib/node_modules/apidoc/template/ to: docs/ verbose: write json file: docs/api_data.json verbose: write js file: docs/api_data.js verbose: write json file: docs/api_project.json verbose: write js file: docs/api_project.js info: Done. and of course, the params for "addAgent" are not generated.
apidoc -i ./endpoints/ -o ./docs/ -v
verbose: apidoc-generator name: apidoc verbose: apidoc-generator version: 0.17.6 verbose: apidoc-core version: 0.8.3 verbose: apidoc-spec version: 0.3.0 verbose: run parser verbose: parse file: endpoints/admin/acceptTempAddress.ts verbose: parse file: endpoints/admin/acceptTempName.ts **warn: parser plugin 'apischema' not found in block: 2** verbose: parse file: endpoints/admin/addAgent.ts verbose: parse file: endpoints/admin/addBankToUsers.ts verbose: parse file: endpoints/admin/addClient.ts verbose: parse file: endpoints/admin/addMessage.ts verbose: parse file: endpoints/admin/createInstances.ts verbose: parse file: endpoints/admin/deleteClient.ts verbose: parse file: endpoints/admin/deleteContract.ts verbose: run worker verbose: worker preProcess: apierrorstructure verbose: worker preProcess: apierrortitle verbose: worker preProcess: apigroup verbose: worker preProcess: apiheaderstructure verbose: worker preProcess: apiheadertitle verbose: worker preProcess: apiparamtitle verbose: worker preProcess: apipermission verbose: worker preProcess: apistructure verbose: worker preProcess: apisuccessstructure verbose: worker preProcess: apisuccesstitle verbose: worker preProcess: apiuse verbose: worker postProcess: apierrorstructure verbose: worker postProcess: apierrortitle verbose: worker postProcess: apigroup verbose: worker postProcess: apiheaderstructure verbose: worker postProcess: apiheadertitle verbose: worker postProcess: apiname verbose: worker postProcess: apiparamtitle verbose: worker postProcess: apipermission verbose: worker postProcess: apisamplerequest verbose: worker postProcess: apistructure verbose: worker postProcess: apisuccessstructure verbose: worker postProcess: apisuccesstitle verbose: worker postProcess: apiuse verbose: run filter verbose: filter postFilter: apierror verbose: filter postFilter: apiheader verbose: filter postFilter: apiparam verbose: filter postFilter: apisuccess verbose: create dir: docs/ verbose: copy template /usr/local/lib/node_modules/apidoc/template/ to: docs/ verbose: write json file: docs/api_data.json verbose: write js file: docs/api_data.js verbose: write json file: docs/api_project.json verbose: write js file: docs/api_project.js info: Done.
Any idea what's wrong? Thanks!
The text was updated successfully, but these errors were encountered:
No branches or pull requests
Hi,
so I have this in package.json:
"devDependencies": { "apidoc-plugin-schema": "^0.1.8" }
and this in my api file:
* @apiSchema (Admin) {jsonschema=./addAgent.json} apiParam
and this in my ./addAgent.json file:
{ "type": "object", "properties": { "agent": { "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": "string" } } } } }
Then, when I run the command in terminal:
apidoc -i ./endpoints/ -o ./docs/ -v
I get this:
verbose: apidoc-generator name: apidoc verbose: apidoc-generator version: 0.17.6 verbose: apidoc-core version: 0.8.3 verbose: apidoc-spec version: 0.3.0 verbose: run parser verbose: parse file: endpoints/admin/acceptTempAddress.ts verbose: parse file: endpoints/admin/acceptTempName.ts **warn: parser plugin 'apischema' not found in block: 2** verbose: parse file: endpoints/admin/addAgent.ts verbose: parse file: endpoints/admin/addBankToUsers.ts verbose: parse file: endpoints/admin/addClient.ts verbose: parse file: endpoints/admin/addMessage.ts verbose: parse file: endpoints/admin/createInstances.ts verbose: parse file: endpoints/admin/deleteClient.ts verbose: parse file: endpoints/admin/deleteContract.ts verbose: run worker verbose: worker preProcess: apierrorstructure verbose: worker preProcess: apierrortitle verbose: worker preProcess: apigroup verbose: worker preProcess: apiheaderstructure verbose: worker preProcess: apiheadertitle verbose: worker preProcess: apiparamtitle verbose: worker preProcess: apipermission verbose: worker preProcess: apistructure verbose: worker preProcess: apisuccessstructure verbose: worker preProcess: apisuccesstitle verbose: worker preProcess: apiuse verbose: worker postProcess: apierrorstructure verbose: worker postProcess: apierrortitle verbose: worker postProcess: apigroup verbose: worker postProcess: apiheaderstructure verbose: worker postProcess: apiheadertitle verbose: worker postProcess: apiname verbose: worker postProcess: apiparamtitle verbose: worker postProcess: apipermission verbose: worker postProcess: apisamplerequest verbose: worker postProcess: apistructure verbose: worker postProcess: apisuccessstructure verbose: worker postProcess: apisuccesstitle verbose: worker postProcess: apiuse verbose: run filter verbose: filter postFilter: apierror verbose: filter postFilter: apiheader verbose: filter postFilter: apiparam verbose: filter postFilter: apisuccess verbose: create dir: docs/ verbose: copy template /usr/local/lib/node_modules/apidoc/template/ to: docs/ verbose: write json file: docs/api_data.json verbose: write js file: docs/api_data.js verbose: write json file: docs/api_project.json verbose: write js file: docs/api_project.js info: Done.
and of course, the params for "addAgent" are not generated.
Any idea what's wrong?
Thanks!
The text was updated successfully, but these errors were encountered: