Updating for new Config Endpoints, fixing typescript broken link#1011
Open
SarahScargall wants to merge 3 commits intoMemMachine:mainfrom
Open
Updating for new Config Endpoints, fixing typescript broken link#1011SarahScargall wants to merge 3 commits intoMemMachine:mainfrom
SarahScargall wants to merge 3 commits intoMemMachine:mainfrom
Conversation
…tructure Signed-off-by: Sarah Scargall <sarah.scargall@memverge.com>
Signed-off-by: Sarah Scargall <sarah.scargall@memverge.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of the change
The high-level purpose of this PR is to resolve visibility issues in the Mintlify-generated API documentation. Previously, the "Configuration" suite of endpoints appeared empty or partially hidden because the OpenAPI schema used generic object types without explicit properties. This PR "meats out" those schemas to ensure all available configuration options are visible and interactive in the UI.
Description
This change updates
openapi.jsonto explicitly define the internal structure of configuration and resource objects.Key updates include:
config_service.pyinto the OpenAPI schema. This includes detailed properties forepisodic_memory(long-term/short-term settings) andsemantic_memory.name,provider, andconfigas required in the resource management endpoints to match the backend validation inconfig_router.py.RestErrorModelto includecode,message, andtracefields, ensuring that the documentation accurately reflects the structured error payloads defined inexceptions.py.Dependencies: None. This is a documentation-only change to the specification file.
Fixes/Closes
Fixes # 1010
Type of change
How Has This Been Tested?
Manual verification:
openapi.jsonto the Mintlify environment.PUT /api/v2/config/memoryandPOST /api/v2/config/resources/embeddersendpoints now display full attribute trees and input fields in the "Body" tab.Test Results: Mintlify UI now correctly renders all nested properties for the Memory Configuration and Resource suites.
Checklist
Maintainer Checklist
Screenshots/Gifs
Here's a screenshot showing the change in navigation for Typescript:

And Here's a screenshot showing the Navigation change to our API Rest sub-section of our API Reference section:

Further comments
Adding
additionalProperties: trueto the resourceconfigobjects ensures that while we provide a visible guide for common fields (likeapi_key), the API remains flexible enough to accept new provider-specific parameters as the Python backend evolves.