Request for adding an OpenAPI definition for the plandex server

[appreciated]

Hello Plandex Team,

I am currently using your project and find it extremely helpful! One enhancement that could significantly improve the possibility to use the plandex server without the command line would be to provide a OpenAPI specification. This would facilitate easier integration and clearer understanding of the API endpoints.

Thank you for considering this addition. I believe it would make a valuable improvement to plandex.

Best regards

Generated Documentation

Swagger Editor

openapi: 3.0.0
info: 
 title: Plandex Server API
 version: 1.0.0
 description: This is the API documentation for the Plandex server.
servers:
- url: http://localhost:8080
paths:
 /health:
   get:
     summary: Health Check
     description: Returns OK if the server is healthy.
     responses:
       '200':
         description: OK
 /version:
   get:
     summary: Get Version
     description: Returns the version of the server.
     responses:
       '200':
         description: The version of the server.
       '500':
         description: Error getting version
 /accounts/start_trial:
   post:
     summary: Start Trial
     description: Starts a trial account.
     responses:
       '200':
         description: Trial started successfully.
     tags:
       - accounts
 /accounts/email_verifications:
   post:
     summary: Create Email Verification
     description: Creates an email verification.
     responses:
       '200':
         description: Email verification created successfully.
     tags:
       - accounts
 /accounts/sign_in:
   post:
     summary: Sign In
     description: Signs in a user.
     responses:
       '200':
         description: Signed in successfully.
     tags:
       - accounts
 /accounts/sign_out:
   post:
     summary: Sign Out
     description: Signs out a user.
     responses:
       '200':
         description: Signed out successfully.
     tags:
       - accounts
 /accounts:
   post:
     summary: Create Account
     description: Creates a new account.
     responses:
       '200':
         description: Account created successfully.
     tags:
       - accounts
 /accounts/convert_trial:
   post:
     summary: Convert Trial
     description: Converts a trial account to a full account.
     responses:
       '200':
         description: Trial converted successfully.
     tags:
       - accounts
 /orgs/session:
   get:
     summary: Get Org Session
     description: Gets the current organization session.
     responses:
       '200':
         description: Current organization session.
     tags:
       - orgs
 /orgs:
   get:
     summary: List Orgs
     description: Lists all organizations.
     responses:
       '200':
         description: List of organizations.
     tags:
       - orgs
   post:
     summary: Create Org
     description: Creates a new organization.
     responses:
       '200':
         description: Organization created successfully.
     tags:
       - orgs
 /users:
   get:
     summary: List Users
     description: Lists all users.
     responses:
       '200':
         description: List of users.
     tags:
       - users
 /orgs/users/{userId}:
   delete:
     summary: Delete Org User
     description: Deletes a user from the organization.
     parameters:
       - name: userId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: User deleted successfully.
     tags:
       - orgs
 /orgs/roles:
   get:
     summary: List Org Roles
     description: Lists all roles within the organization.
     responses:
       '200':
         description: List of roles.
     tags:
       - orgs
 /invites:
   post:
     summary: Invite User
     description: Invites a user to the organization.
     responses:
       '200':
         description: User invited successfully.
     tags:
       - invites
 /invites/pending:
   get:
     summary: List Pending Invites
     description: Lists all pending invites.
     responses:
       '200':
         description: List of pending invites.
     tags:
       - invites
 /invites/accepted:
   get:
     summary: List Accepted Invites
     description: Lists all accepted invites.
     responses:
       '200':
         description: List of accepted invites.
     tags:
       - invites
 /invites/all:
   get:
     summary: List All Invites
     description: Lists all invites.
     responses:
       '200':
         description: List of all invites.
     tags:
       - invites
 /invites/{inviteId}:
   delete:
     summary: Delete Invite
     description: Deletes an invite.
     parameters:
       - name: inviteId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Invite deleted successfully.
     tags:
       - invites
 /projects:
   get:
     summary: List Projects
     description: Lists all projects.
     responses:
       '200':
         description: List of projects.
     tags:
       - projects
   post:
     summary: Create Project
     description: Creates a new project.
     responses:
       '200':
         description: Project created successfully.
     tags:
       - projects
 /projects/{projectId}/set_plan:
   put:
     summary: Set Plan
     description: Sets a plan for the project.
     parameters:
       - name: projectId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan set successfully.
     tags:
       - projects
 /projects/{projectId}/rename:
   put:
     summary: Rename Project
     description: Renames a project.
     parameters:
       - name: projectId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Project renamed successfully.
     tags:
       - projects
 /projects/{projectId}/plans/current_branches:
   post:
     summary: Get Current Branch by Plan ID
     description: Gets the current branch by plan ID.
     parameters:
       - name: projectId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Current branch retrieved successfully.
     tags:
       - projects
 /plans:
   get:
     summary: List Plans
     description: Lists all plans.
     responses:
       '200':
         description: List of plans.
     tags:
       - plans
 /plans/archive:
   get:
     summary: List Archived Plans
     description: Lists all archived plans.
     responses:
       '200':
         description: List of archived plans.
     tags:
       - plans
 /plans/ps:
   get:
     summary: List Running Plans
     description: Lists all running plans.
     responses:
       '200':
         description: List of running plans.
     tags:
       - plans
 /projects/{projectId}/plans:
   post:
     summary: Create Plan
     description: Creates a new plan.
     parameters:
       - name: projectId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan created successfully.
     tags:
       - projects
   delete:
     summary: Delete Plan
     description: Deletes a plan.
     parameters:
       - name: projectId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan deleted successfully.
     tags:
       - projects
 /plans/{planId}:
   get:
     summary: Get Plan
     description: Gets a specific plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan retrieved successfully.
     tags:
       - plans
   delete:
     summary: Delete Plan
     description: Deletes a specific plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan deleted successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/tell:
   post:
     summary: Tell Plan
     description: Tells the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan told successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/respond_missing_file:
   post:
     summary: Respond Missing File
     description: Responds to a missing file.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Responded to missing file successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/build:
   patch:
     summary: Build Plan
     description: Builds the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan built successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/connect:
   patch:
     summary: Connect Plan
     description: Connects the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan connected successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/stop:
   delete:
     summary: Stop Plan
     description: Stops the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan stopped successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/current_plan:
   get:
     summary: Get Current Plan
     description: Gets the current plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Current plan retrieved successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/apply:
   patch:
     summary: Apply Plan
     description: Applies the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan applied successfully.
     tags:
       - plans
 /plans/{planId}/archive:
   patch:
     summary: Archive Plan
     description: Archives the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan archived successfully.
     tags:
       - plans
 /plans/{planId}/unarchive:
   patch:
     summary: Unarchive Plan
     description: Unarchives the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan unarchived successfully.
     tags:
       - plans
 /plans/{planId}/rename:
   patch:
     summary: Rename Plan
     description: Renames the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan renamed successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/reject_all:
   patch:
     summary: Reject All Changes
     description: Rejects all changes.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: All changes rejected successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/reject_file:
   patch:
     summary: Reject File
     description: Rejects a file.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: File rejected successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/diffs:
   get:
     summary: Get Plan Diffs
     description: Gets the plan diffs.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan diffs retrieved successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/context:
   get:
     summary: List Context
     description: Lists the context.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Context listed successfully.
     tags:
       - plans
   post:
     summary: Load Context
     description: Loads the context.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Context loaded successfully.
     tags:
       - plans
   put:
     summary: Update Context
     description: Updates the context.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Context updated successfully.
     tags:
       - plans
   delete:
     summary: Delete Context
     description: Deletes the context.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Context deleted successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/convo:
   get:
     summary: List Convo
     description: Lists the conversation.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Conversation listed successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/rewind:
   patch:
     summary: Rewind Plan
     description: Rewinds the plan.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan rewinded successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/logs:
   get:
     summary: List Logs
     description: Lists the logs.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Logs listed successfully.
     tags:
       - plans
 /plans/{planId}/branches:
   get:
     summary: List Branches
     description: Lists all branches.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Branches listed successfully.
     tags:
       - plans
 /plans/{planId}/branches/{branch}:
   delete:
     summary: Delete Branch
     description: Deletes a branch.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Branch deleted successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/branches:
   post:
     summary: Create Branch
     description: Creates a new branch.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Branch created successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/settings:
   get:
     summary: Get Settings
     description: Gets the settings.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Settings retrieved successfully.
     tags:
       - plans
   put:
     summary: Update Settings
     description: Updates the settings.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Settings updated successfully.
     tags:
       - plans
 /plans/{planId}/{branch}/status:
   get:
     summary: Get Plan Status
     description: Gets the plan status.
     parameters:
       - name: planId
         in: path
         required: true
         schema:
           type: string
       - name: branch
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Plan status retrieved successfully.
     tags:
       - plans
 /custom_models:
   get:
     summary: List Custom Models
     description: Lists all custom models.
     responses:
       '200':
         description: Custom models listed successfully.
     tags:
       - models
   post:
     summary: Create Custom Model
     description: Creates a new custom model.
     responses:
       '200':
         description: Custom model created successfully.
     tags:
       - models
 /custom_models/{modelId}:
   delete:
     summary: Delete Custom Model
     description: Deletes a custom model.
     parameters:
       - name: modelId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Custom model deleted successfully.
     tags:
       - models
 /model_sets:
   get:
     summary: List Model Packs
     description: Lists all model packs.
     responses:
       '200':
         description: Model packs listed successfully.
     tags:
       - models
   post:
     summary: Create Model Pack
     description: Creates a new model pack.
     responses:
       '200':
         description: Model pack created successfully.
     tags:
       - models
 /model_sets/{setId}:
   delete:
     summary: Delete Model Pack
     description: Deletes a model pack.
     parameters:
       - name: setId
         in: path
         required: true
         schema:
           type: string
     responses:
       '200':
         description: Model pack deleted successfully.
     tags:
       - models
 /default_settings:
   get:
     summary: Get Default Settings
     description: Gets the default settings.
     responses:
       '200':
         description: Default settings retrieved successfully.
   put:
     summary: Update Default Settings
     description: Updates the default settings.
     responses:
       '200':
         description: Default settings updated successfully.

[danenania]

Thanks for this! I don't think I want to add it quite yet, but it could be a good idea in the future once development on the API is moving less quickly.