doc.json 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546
  1. {
  2. "$schema": "http://json-schema.org/schema",
  3. "$id": "ng-cli://commands/doc.json",
  4. "description": "Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword.",
  5. "$longDescription": "",
  6. "$type": "native",
  7. "$impl": "./doc-impl#DocCommand",
  8. "type": "object",
  9. "allOf": [
  10. {
  11. "properties": {
  12. "keyword": {
  13. "type": "string",
  14. "description": "The keyword to search for, as provided in the search bar in angular.io.",
  15. "$default": {
  16. "$source": "argv",
  17. "index": 0
  18. }
  19. },
  20. "search": {
  21. "aliases": ["s"],
  22. "type": "boolean",
  23. "default": false,
  24. "description": "When true, searches all of angular.io. Otherwise, searches only API reference documentation."
  25. },
  26. "version" : {
  27. "oneOf": [
  28. {
  29. "type": "number",
  30. "minimum": 4
  31. },
  32. {
  33. "enum": [2, "next"]
  34. }
  35. ],
  36. "description": "Contains the version of Angular to use for the documentation. If not provided, the command uses your current Angular core version."
  37. }
  38. },
  39. "required": [
  40. ]
  41. },
  42. { "$ref": "./definitions.json#/definitions/base" }
  43. ]
  44. }