swagger.yml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. paths:
  2. /schema/index:
  3. get:
  4. tags:
  5. - Schema
  6. description: Get index information
  7. parameters:
  8. - $ref: '#/definitions/CollectionName'
  9. responses:
  10. 200:
  11. schema:
  12. type: object
  13. post:
  14. tags:
  15. - Schema
  16. description: Create or delete index in collection
  17. requestBody:
  18. description: Only type is create need extra_params
  19. required: true
  20. content:
  21. application/json:
  22. schema:
  23. type: object
  24. required:
  25. - type
  26. - collection_name
  27. - field_name
  28. properties:
  29. type:
  30. type: string
  31. example: create
  32. collection_name:
  33. type: string
  34. example: ''
  35. field_name:
  36. type: string
  37. example: 'vector field'
  38. extra_params:
  39. type: object
  40. example: {"index_type":"","metric_type":"","params":""}
  41. responses:
  42. 200:
  43. schema:
  44. type: object
  45. /schema/index/progress:
  46. get:
  47. tags:
  48. - Schema
  49. description: Get index building progress percentage
  50. parameters:
  51. - $ref: '#/definitions/CollectionName'
  52. responses:
  53. 200:
  54. schema:
  55. type: object
  56. /schema/index/state:
  57. get:
  58. tags:
  59. - Schema
  60. description: Get index state
  61. parameters:
  62. - $ref: '#/definitions/CollectionName'
  63. responses:
  64. 200:
  65. schema:
  66. type: object
  67. definitions:
  68. CollectionName:
  69. in: query
  70. name: collection_name
  71. type: string
  72. description: Collection name