Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add assistants api reference #801

Merged
merged 15 commits into from
Dec 8, 2023
Merged

Conversation

0xHieu01
Copy link
Contributor

@0xHieu01 0xHieu01 commented Dec 1, 2023

  • Solved issue docs: assistants API reference #688
  • Adding the requestBody and response for each assistant endpoint API
  • Run auto format for all .yaml files to make the code clean
  • Fixing some minor bugs in the API Reference page

Copy link
Contributor

github-actions bot commented Dec 1, 2023

Preview URL: https://f0d8c9d9.jan-qn8.pages.dev

@0xHieu01 0xHieu01 self-assigned this Dec 1, 2023
@freelerobot freelerobot changed the title docs: add assistants endpoint docs: add assistants api reference Dec 1, 2023
Copy link
Contributor

@freelerobot freelerobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hieu-jan a more accurate reference for assistants is here: http://localhost:3001/specs/assistants/#assistantjson

The github description is a bit outdated.

Pls fix then we're ready to merge! Thank you

docs/openapi/specs/assistants.yaml Outdated Show resolved Hide resolved
@0xHieu01
Copy link
Contributor Author

0xHieu01 commented Dec 4, 2023

I have updated the assistant model. Currently fixing the request and response content of each API endpoint.

@hiro-v hiro-v added P1: important Important feature / fix type: docs Improvements or additions to documentation labels Dec 4, 2023
@freelerobot freelerobot self-requested a review December 7, 2023 04:03
Copy link
Contributor

@freelerobot freelerobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets rebase and get in what you have here. Thanks @hieu-jan

@0xHieu01
Copy link
Contributor Author

0xHieu01 commented Dec 7, 2023

Hi @0xSage, I made some new change to the current version including

  • Adding the requestBody and response for each assistant endpoint API
  • Run auto format for all .yaml files to make the code clean
  • Fixing some minor bugs in the API Reference page

Copy link
Contributor

@freelerobot freelerobot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, things look a bit better, but I think I mentioned in a previous PR that non of these fields are required:

image

@0xHieu01
Copy link
Contributor Author

0xHieu01 commented Dec 8, 2023

Hi @0xSage, sorry for confusing you, I guess this image is from the old deployment version. In the current latest version, I already fixed this one too. https://f0d8c9d9.jan-qn8.pages.dev/api-reference

@0xHieu01 0xHieu01 requested a review from freelerobot December 8, 2023 07:09
@freelerobot
Copy link
Contributor

Hi @0xSage, sorry for confusing you, I guess this image is from the old deployment version. In the current latest version, I already fixed this one too. https://f0d8c9d9.jan-qn8.pages.dev/api-reference

My bad. I thought I pulled your latest changes, but was running an older commit. Looks great now - thanks!

@0xHieu01 0xHieu01 merged commit 9b00f6a into main Dec 8, 2023
1 check passed
@0xHieu01 0xHieu01 deleted the docs/assistants-api-reference branch December 8, 2023 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
P1: important Important feature / fix type: docs Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants