[PR #2547] [MERGED] Feature/update api example outputs #4029

Closed
opened 2026-02-22 18:34:59 -05:00 by yindo · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Mintplex-Labs/anything-llm/pull/2547
Author: @MrSimonC
Created: 10/28/2024
Status: Merged
Merged: 10/29/2024
Merged by: @timothycarambat

Base: masterHead: feature/update-api-example-outputs


📝 Commits (3)

  • 9aaf16e /v1/workspace/{slug} actually returns an array - update example output
  • 67a746f Merge branch 'Mintplex-Labs:master' into feature/update-api-example-outputs
  • d4dbb4a update swagger example to show array output

📊 Changes

2 files changed (+28 additions, -24 deletions)

View changed files

📝 server/endpoints/api/workspace/index.js (+14 -12)
📝 server/swagger/openapi.json (+14 -12)

📄 Description

Pull Request Type

  • feat
  • 🐛 fix
  • ♻️ refactor
  • 💄 style
  • 🔨 chore
  • 📝 docs

Relevant Issues

resolves #2546

What is in this change?

This PR updates the documentation for the /v1/workspace/{slug} endpoint to reflect the actual API response, which is an array of workspaces, rather than a single workspace object.

Additional Information

This change is related to a docus improvement report #2546 where the inconsistent API response was identified. The updated documentation should help clarify the expected response for developers using the API.

Developer Validations

I've ran node init.js at /workspaces/anything-llm/server/swagger location to generate the openapi.json file.

[ ] I ran yarn lint from the root of the repo & committed changes
[x] Relevant documentation has been updated
[x] I have tested my code functionality
[ ] Docker build succeeds locally


🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Mintplex-Labs/anything-llm/pull/2547 **Author:** [@MrSimonC](https://github.com/MrSimonC) **Created:** 10/28/2024 **Status:** ✅ Merged **Merged:** 10/29/2024 **Merged by:** [@timothycarambat](https://github.com/timothycarambat) **Base:** `master` ← **Head:** `feature/update-api-example-outputs` --- ### 📝 Commits (3) - [`9aaf16e`](https://github.com/Mintplex-Labs/anything-llm/commit/9aaf16e82a51d748f11355f5019628d4703f799f) /v1/workspace/{slug} actually returns an array - update example output - [`67a746f`](https://github.com/Mintplex-Labs/anything-llm/commit/67a746ff3194f03bc65f68e62db97e78d63273fa) Merge branch 'Mintplex-Labs:master' into feature/update-api-example-outputs - [`d4dbb4a`](https://github.com/Mintplex-Labs/anything-llm/commit/d4dbb4a761d96d9d533fd4485be3a04a65e3a090) update swagger example to show array output ### 📊 Changes **2 files changed** (+28 additions, -24 deletions) <details> <summary>View changed files</summary> 📝 `server/endpoints/api/workspace/index.js` (+14 -12) 📝 `server/swagger/openapi.json` (+14 -12) </details> ### 📄 Description ### Pull Request Type <!-- For change type, change [ ] to [x]. --> - [ ] ✨ feat - [ ] 🐛 fix - [ ] ♻️ refactor - [ ] 💄 style - [ ] 🔨 chore - [x] 📝 docs ### Relevant Issues <!-- Use "resolves #xxx" to auto resolve on merge. Otherwise, please use "connect #xxx" --> resolves #2546 What is in this change? <!-- Describe the changes in this PR that are impactful to the repo. --> This PR updates the documentation for the /v1/workspace/{slug} endpoint to reflect the actual API response, which is an array of workspaces, rather than a single workspace object. Additional Information <!-- Add any other context about the Pull Request here that was not captured above. --> This change is related to a docus improvement report #2546 where the inconsistent API response was identified. The updated documentation should help clarify the expected response for developers using the API. Developer Validations <!-- All of the applicable items should be checked. --> I've ran `node init.js` at `/workspaces/anything-llm/server/swagger` location to generate the `openapi.json` file. [ ] I ran yarn lint from the root of the repo & committed changes [x] Relevant documentation has been updated [x] I have tested my code functionality [ ] Docker build succeeds locally --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-02-22 18:34:59 -05:00
yindo closed this issue 2026-02-22 18:34:59 -05:00
yindo changed title from [PR #2547] Feature/update api example outputs to [PR #2547] [MERGED] Feature/update api example outputs 2026-06-05 15:16:27 -04:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Mintplex-Labs/anything-llm#4029