Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

Conversation

@Simran-B
Copy link
Collaborator

@Simran-B Simran-B commented Jun 25, 2019

@Simran-B
Copy link
Collaborator Author

Simran-B commented Jul 29, 2019

HTTP docs:

  • there is no attribute "properties": { ... } expected, but rather the View properties directly (same level as name and type). This needs to be fixed (pointed out by Vadim).
  • there are multiple places where the response object is described, but without code and error
  • result is not mentioned / described as containing the important query result
  • globallyUniqueId is not mentioned and missing a description - it's an internal attribute as per Vadim, which collections have as well.
  • response structure only described in text, not for in Swagger way
  • immutable View properties:
    • globallyUniqueId
    • id
    • primarySort
    • type (?)
    • writebufferActive
    • writebufferIdle
    • writebufferSizeMax
  • make links from Java driver to ArangoSearch/Views HTTP docs more specific again? They used to link to e.g. views-getting.md, which I removed in the main repo PR because it's basically useless and redundant as long as we don't have any other View types.
  • broken hierarchy https://deploy-preview-89--zealous-morse-14392b.netlify.com/docs/3.5/http/views-arangosearch.html, probably Sub-objects at depth 3+ missing in HTTP response description #106
  • 3.5\arangosearch-analyzers.md#analyzer-features:
    • For example the text type will produce <!-- supports? -->
    • norm: the field normalization factor <!-- effect? -->
    • <!-- what else requires which features? -->
@Simran-B Simran-B removed the 9 WIP label Aug 20, 2019
@Simran-B Simran-B added this to the 3.5 milestone Aug 20, 2019
@Simran-B Simran-B marked this pull request as ready for review August 20, 2019 12:35
@Simran-B Simran-B merged commit f8796a6 into master Aug 20, 2019
@Simran-B Simran-B deleted the arangosearch-refactor branch August 27, 2019 10:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

1 participant