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

Correct & clarify parts of API spec #11130

Merged
merged 16 commits into from
May 27, 2022
Merged

Conversation

indam23
Copy link
Contributor

@indam23 indam23 commented May 18, 2022

Proposed changes:

GET /status endpoint: Correct response schema for model_id - a string, not an object.

GET /conversations/{conversation_id}/tracker : Describe each of the enum options for include_events query parameter

POST & PUT /conversations/{conversation_id}/tracker/events : Events schema added for each event type

GET /conversations/{conversation_id}/story: Clarified the all_sessions query parameter and default behaviour.

POST /model/test/intents : Remove JSON option, since the server was interpreting all input as YAML regardless of content-type header.

POST /model/parse: Explain what emulation_mode is and how it affects response results

Status (please check what you already did):

  • added some tests for the functionality
  • updated the documentation
  • updated the changelog (please check changelog for instructions)
  • reformat files using black (please check Readme for instructions)

@indam23 indam23 marked this pull request as ready for review May 19, 2022 10:34
@indam23 indam23 requested a review from a team as a code owner May 19, 2022 10:34
@indam23 indam23 requested review from losterloh and removed request for a team May 19, 2022 10:34
@indam23 indam23 requested review from ancalita and a team and removed request for losterloh and a team May 19, 2022 10:34
docs/docs/http-api.mdx Outdated Show resolved Hide resolved
Copy link
Member

@ancalita ancalita left a comment

Choose a reason for hiding this comment

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

Great stuff 💯 Left a few clarifying questions 😄
Also worth looking into the JSON removal and why it's causing the test_evaluate_invalid_intent_model_file to fail.

docs/static/spec/rasa.yml Outdated Show resolved Hide resolved
rasa/shared/core/trackers.py Outdated Show resolved Hide resolved
rasa/server.py Outdated Show resolved Hide resolved
rasa/server.py Outdated Show resolved Hide resolved
Co-authored-by: Anca Lita <27920906+ancalita@users.noreply.github.com>
@indam23 indam23 requested a review from ancalita May 27, 2022 11:53
Copy link
Member

@ancalita ancalita left a comment

Choose a reason for hiding this comment

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

Almost there 💯 Only asked for one unit test and probably some code can be removed.

rasa/server.py Outdated Show resolved Hide resolved
rasa/server.py Show resolved Hide resolved
@indam23 indam23 requested a review from ancalita May 27, 2022 14:00
@github-actions
Copy link
Contributor

🚀 A preview of the docs have been deployed at the following URL: https://11130--rasahq-docs-rasa-v2.netlify.app/docs/rasa

@indam23
Copy link
Contributor Author

indam23 commented May 27, 2022

Follow up issue is here #11151

Copy link
Member

@ancalita ancalita left a comment

Choose a reason for hiding this comment

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

🎉

@indam23 indam23 enabled auto-merge (squash) May 27, 2022 14:24
@indam23 indam23 merged commit ce46a2f into main May 27, 2022
@indam23 indam23 deleted the ATO-95-update-http-api-docs-section branch May 27, 2022 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants