Skip to content

Updating for new Config Endpoints, fixing typescript broken link#1011

Open
SarahScargall wants to merge 3 commits intoMemMachine:mainfrom
SarahScargall:exceptions
Open

Updating for new Config Endpoints, fixing typescript broken link#1011
SarahScargall wants to merge 3 commits intoMemMachine:mainfrom
SarahScargall:exceptions

Conversation

@SarahScargall
Copy link
Contributor

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.json to explicitly define the internal structure of configuration and resource objects.

Key updates include:

  1. Explicit Property Mapping: Translated nested Pydantic models from config_service.py into the OpenAPI schema. This includes detailed properties for episodic_memory (long-term/short-term settings) and semantic_memory.
  2. Requirement Enforcement: Marked essential fields like name, provider, and config as required in the resource management endpoints to match the backend validation in config_router.py.
  3. Enum Integration: Added enums for resource providers (OpenAI, Bedrock, etc.) to generate dropdown selectors in the documentation.
  4. Error Model Alignment: Updated RestErrorModel to include code, message, and trace fields, ensuring that the documentation accurately reflects the structured error payloads defined in exceptions.py.

Dependencies: None. This is a documentation-only change to the specification file.

Fixes/Closes

Fixes # 1010

Type of change

  • Documentation update

How Has This Been Tested?

Manual verification:

  1. Uploaded the updated openapi.json to the Mintlify environment.
  2. Navigated to the Configuration section in the API Reference.
  3. Verified that the PUT /api/v2/config/memory and POST /api/v2/config/resources/embedders endpoints now display full attribute trees and input fields in the "Body" tab.
  4. Confirmed that "required" badges appear correctly next to mandatory fields.

Test Results: Mintlify UI now correctly renders all nested properties for the Memory Configuration and Resource suites.

Checklist

  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation
  • I have checked my code and corrected any misspellings

Maintainer Checklist

  • Confirmed all checks passed
  • Contributor has signed the commit(s)
  • Reviewed the code
  • Run, Tested, and Verified the change(s) work as expected

Screenshots/Gifs

Here's a screenshot showing the change in navigation for Typescript:
Screenshot 2026-01-30 at 2 57 57 PM

And Here's a screenshot showing the Navigation change to our API Rest sub-section of our API Reference section:
Screenshot 2026-01-30 at 3 17 22 PM

Further comments

Adding additionalProperties: true to the resource config objects ensures that while we provide a visible guide for common fields (like api_key), the API remains flexible enough to accept new provider-specific parameters as the Python backend evolves.

…tructure

Signed-off-by: Sarah Scargall <sarah.scargall@memverge.com>
Signed-off-by: Sarah Scargall <sarah.scargall@memverge.com>
Copy link
Contributor

@sscargal sscargal left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@sscargal sscargal left a comment

Choose a reason for hiding this comment

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

LGTM

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.

2 participants