cleanup: schema titles on request and response payloads #19

New issue

Copy link

New issue

Copy link

Open

Open

cleanup: schema titles on request and response payloads#19

Copy link

Assignees

Labels

documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is neededmedium priority

Description

skeptrunedev

opened on Oct 2, 2024

Issue body actions

• https://docs.trieve.ai/api-reference/chunk/create-or-upsert-chunk-or-chunks needs titles for both request and response body variants - single, batch
• 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
• https://docs.trieve.ai/api-reference/chunk/get-recommended-chunks needs Option 2 for response body to be titled V1
• 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
• 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
• https://docs.trieve.ai/api-reference/analytics/send-ctr-data needs to get click as a term in its description
• https://docs.trieve.ai/api-reference/analytics/send-event-data needs title to be specified for all req body variants
• 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

Activity

1. skeptrunedev

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   enhancementNew feature or requestNew feature or request

   help wantedExtra attention is neededExtra attention is needed

   medium priority

   on Oct 2, 2024
2. skeptrunedev

   assigned

   densumesh

   and

   cdxker

   on Oct 2, 2024
3. cdxker

   unassigned

   densumesh

   on Oct 8, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

• 
  cdxker

Labels

documentationImprovements or additions to documentationImprovements or additions to documentationenhancementNew feature or requestNew feature or requesthelp wantedExtra attention is neededExtra attention is neededmedium priority

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions