ApiPlan 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. API Plan
  2. ========
  3. Inary does not have a usable api. All the projects use its internal modules to do their
  4. jobs. This file holds a list of these usages by project as a guide for a new competent
  5. inary api.
  6. Inary
  7. ====
  8. Below are inary's internal calls that they may help to figure out common api calls.
  9. * packagedb.remove_repo
  10. * sourcedb.remove_repo
  11. * packagedb.which_repo
  12. * repodb.get_repo
  13. * packagedb.get_package
  14. * installdb.is_installed
  15. * packagedb.get_rev_deps
  16. * installdb.get_version
  17. * packagedb.has_package
  18. * packagedb.add_package
  19. * componentdb.add_package
  20. * filesdb.has_file
  21. * filesdb.get_file
  22. * installdb.get_info
  23. * installdb.files
  24. * installdb.pkg_dir
  25. * installdb.install
  26. * filesdb.add_files
  27. * componentdb.add_spec
  28. * sourcedb.add_spec
  29. * componentdb.get_union_comp
  30. * componentdb.remove_spec
  31. * installdb.get_version
  32. * componentdb.remove_repo
  33. * componentdb.remove_package
  34. * componentdb.update_component
  35. * componentdb.add_package
  36. * installdb.remove
  37. * filesdb.remove_files
  38. * sourcedb.pkgtosrc
  39. * sourcedb.get_spec
  40. * sourcedb.get_source
  41. * sourcedb.get_spec_repo
  42. * repodb.get_repo
  43. * componentdb.has_component
  44. * componentdb.get_component
  45. * installdb.is_installed
  46. * packagedb.list_packages
  47. * installdb.list_installed
  48. * componentdb.get_union_packages
  49. * componentdb.list_components
  50. * repodb.list
  51. * sourcedb.list
  52. * installdb.list_pending
  53. * filesdb.match_files
  54. Package Manager
  55. ===============
  56. Below are the inary modules used internally by package-manager. Package-manager should use inary
  57. api.
  58. * repodb.get_repo
  59. * packagedb.get_package
  60. pm still uses the old packagedb with inary.itemsbyrepo.installed or inary.itemsbyrepo.repos params
  61. * componentdb.list_components
  62. * repodb.list
  63. * componentdb.get_union_comp
  64. * componentdb.get_union_packages
  65. Sul-Ins
  66. ====
  67. Below are the inary modules used internally by Sul-Ins. Sul-Ins should use inary api.
  68. * api.add_repo
  69. * api.update_repo
  70. * api.remove_repo
  71. * api.install
  72. * packagedb.list_packages
  73. * installdb.list_pending
  74. * api.configure_pending
  75. * packagedb.get_package
  76. Buildfarm
  77. =========
  78. Below are the inary modules used internally by Inaryfarm.
  79. * api.create_delta_package
  80. PackageKit
  81. ==========
  82. Below are the inary modules used internally by PackageKit.
  83. * installdb.has_package
  84. * installdb.get_package
  85. * packagedb.has_package
  86. * packagedb.get_package
  87. * installdb.get_rev_deps
  88. * packagedb.get_rev_deps
  89. * installdb.get_package.runtimeDependencies
  90. * packagedb.get_package.runtimeDependencies
  91. * api.install
  92. * api.upgrade
  93. * api.remove
  94. * api.list_upgradable
  95. * api.update_repo
  96. * api.list_repos
  97. * repodb.get_repo.indexuri.get_uri
  98. * version.Version
  99. * util.any