From 82f96ac9becc8ef9eec950071437237db7128a0a Mon Sep 17 00:00:00 2001 From: Danielsson Date: Sun, 7 Jul 2019 21:12:23 +0200 Subject: [PATCH 1/3] Add operationId properties to endpoints - This enables client SDK generators to create nicer names for the functions - Otherwise auto generated names are used, which are mostly suboptimal --- docs/_static/spec/rasa.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/_static/spec/rasa.yml b/docs/_static/spec/rasa.yml index 3f0a1cde43c4..4444b51be49c 100644 --- a/docs/_static/spec/rasa.yml +++ b/docs/_static/spec/rasa.yml @@ -16,6 +16,7 @@ paths: tags: - Server Information summary: Health endpoint of Rasa Server + operationId: getHealth description: >- This URL can be used as an endpoint to run health checks against. When the server is running @@ -35,6 +36,7 @@ paths: get: tags: - Server Information + operationId: getVersion summary: Version of Rasa description: >- Returns the version of Rasa. @@ -64,6 +66,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: getStatus tags: - Server Information summary: Status of the currently loaded Rasa model @@ -108,6 +111,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: getConversationTracker tags: - Tracker summary: Retrieve a conversations tracker @@ -139,6 +143,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: getConversationTrackerEvents tags: - Tracker summary: Append events to a tracker @@ -177,6 +182,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: replaceConversationTrackerEvents tags: - Tracker summary: Replace a trackers events @@ -213,6 +219,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: getConversationStory tags: - Tracker summary: Retrieve an end-to-end story corresponding to a conversation @@ -240,6 +247,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: executeConversationAction tags: - Tracker summary: Run an action in a conversation @@ -287,6 +295,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: predictConversationAction tags: - Tracker summary: Predict the next action @@ -322,6 +331,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: addConversationMessage tags: - Tracker summary: Add a message to a tracker @@ -359,6 +369,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: trainModel tags: - Model summary: Train a Rasa model @@ -398,6 +409,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: evaluateModelStories tags: - Model summary: Evaluate stories @@ -435,6 +447,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: testModelIntent tags: - Model summary: Perform an intent evaluation @@ -471,6 +484,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: predictModelAction tags: - Model summary: Predict an action on a temporary state @@ -511,6 +525,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: parseModelMessage tags: - Model summary: Parse a message using the Rasa model @@ -553,6 +568,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: replaceModel tags: - Model summary: Replace the currently loaded model @@ -583,6 +599,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: unloadModel tags: - Model summary: Unload the trained model @@ -601,6 +618,7 @@ paths: security: - TokenAuth: [] - JWT: [] + operationId: getDomain tags: - Domain summary: Retrieve the loaded domain From 43bf8f8ac2ae9af7356bf9ba3665774ee6d24dac Mon Sep 17 00:00:00 2001 From: Danielsson Date: Mon, 8 Jul 2019 11:09:42 +0200 Subject: [PATCH 2/3] Misleading operationId - it's a post, add suits better --- docs/_static/spec/rasa.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_static/spec/rasa.yml b/docs/_static/spec/rasa.yml index 4444b51be49c..018b435e8ab3 100644 --- a/docs/_static/spec/rasa.yml +++ b/docs/_static/spec/rasa.yml @@ -143,7 +143,7 @@ paths: security: - TokenAuth: [] - JWT: [] - operationId: getConversationTrackerEvents + operationId: addConversationTrackerEvents tags: - Tracker summary: Append events to a tracker From bff1d9f0580683ce4cdee895c29dda19c7f7a9b5 Mon Sep 17 00:00:00 2001 From: Danielsson Date: Mon, 15 Jul 2019 13:01:35 +0200 Subject: [PATCH 3/3] Rename to testModelStories for consistency --- docs/_static/spec/rasa.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_static/spec/rasa.yml b/docs/_static/spec/rasa.yml index 018b435e8ab3..54379f5cc58e 100644 --- a/docs/_static/spec/rasa.yml +++ b/docs/_static/spec/rasa.yml @@ -409,7 +409,7 @@ paths: security: - TokenAuth: [] - JWT: [] - operationId: evaluateModelStories + operationId: testModelStories tags: - Model summary: Evaluate stories