devflowinc / devflowinc/docs

cleanup: schema titles on request and response payloads

Open
#19 0 comments 0 reactions 1 assignee Assigned to @cdxker View on GitHub
documentation enhancement help wanted medium priority
Dominant language
MDX
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

- [x] https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks needs titles for both request and response body variants - `single, batch`
- [x] https://docs.trieve.ai/api-reference/chunk/search `chunks.chunk` on `V2` for response needs titles for variants
- [ ] https://docs.trieve.ai/api-reference/chunk/rag-on-specified-chunks needs a better explanation for response
- [x] https://docs.trieve.ai/api-reference/chunk/get-recommended-chunks needs `Option 2` for response body to be titled `V1`
- [x] https://docs.trieve.ai/api-reference/chunk-group/create-or-upsert-group-or-groups needs titles for both request and response body variants - `single, batch`
- [x] https://docs.trieve.ai/api-reference/chunk-group/search-over-groups `results.chunks.chunk` on `V2` for response needs titles for variants
- [ ] https://docs.trieve.ai/api-reference/message/edit-message needs a better explanation for response
- [ ] https://docs.trieve.ai/api-reference/message/create-message needs a better explanation for response
- [ ] https://docs.trieve.ai/api-reference/message/regenerate-message needs a better explanation for response
- [x] https://docs.trieve.ai/api-reference/analytics/send-ctr-data needs to get `click` as a term in its description
- [x] https://docs.trieve.ai/api-reference/analytics/send-event-data needs `title` to be specified for all req body variants
- [x] https://docs.trieve.ai/api-reference/analytics/get-all-events needs explanations for filter and response explaining how they work
- [ ] https://docs.trieve.ai/api-reference/analytics/rate-rag req body values need docstrings
- [ ] https://docs.trieve.ai/api-reference/analytics/get-recommendation-analytics req. and response bodies need docstrings
- [ ] https://docs.trieve.ai/api-reference/analytics/rate-search body needs docstrings
- [ ] https://docs.trieve.ai/api-reference/analytics/get-top-datasets req and resp body keys need docstrings
- [ ] https://docs.trieve.ai/api-reference/dataset/create-dataset resp body needs docstrings
- [ ] https://docs.trieve.ai/api-reference/dataset/get-all-tags resp body needs docstrings
- [ ] https://docs.trieve.ai/api-reference/dataset/get-datasets-from-organization resp body needs docstrings
- [ ] https://docs.trieve.ai/api-reference/dataset/get-usage-by-dataset-id resp body needs docstrings
- [ ] https://docs.trieve.ai/api-reference/events/get-events-for-the-dataset resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/organization/update-organization resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/organization/create-organization resp need docstrings
- [ ] https://docs.trieve.ai/api-reference/organization/get-organization-usage resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/organization/get-organization-users resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/organization/get-organization | resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/auth/get-me resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/health/health-check should be `204`
- [ ] https://docs.trieve.ai/api-reference/invitation/get-invitations resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/stripe/get-all-invoices resp needs docstrings
- [ ] https://docs.trieve.ai/api-reference/stripe/get-all-plans resp needs docstrings

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.