feat: ALTER PUBLISHED REST SERVICE (#161)

Adds incremental editing of published REST services so users can change
properties or swap individual resources without dropping and recreating
the whole service via CREATE OR REPLACE. Three action forms are
supported and may be combined in a single statement:

  - SET Path|Version|ServiceName = '...' [, ...]
  - ADD RESOURCE 'name' { ... }   (reuses CREATE syntax)
  - DROP RESOURCE 'name'

Mirrors the existing ALTER ODATA SERVICE pattern: the executor mutates
the in-memory model, then a new UpdatePublishedRestService writer
re-serializes the document via updateUnit.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>

Author: ako

cmd/mxcli/help_topics/rest.txt

@@ -38,6 +38,22 @@ CREATE / DROP PUBLISHED REST SERVICE
   Properties: Path (required), Version, ServiceName, Folder
   HTTP methods: GET, POST, PUT, DELETE, PATCH
 
+ALTER PUBLISHED REST SERVICE
+----------------------------
+
+  -- Change properties (Path, Version, ServiceName)
+  ALTER PUBLISHED REST SERVICE Module.MyAPI SET Version = '2.0.0';
+  ALTER PUBLISHED REST SERVICE Module.MyAPI
+    SET Path = 'rest/api/v2', ServiceName = 'My API v2';
+
+  -- Add a new resource block
+  ALTER PUBLISHED REST SERVICE Module.MyAPI ADD RESOURCE 'orders/{id}/items' {
+    GET '' MICROFLOW Module.GetOrderItems;
+  };
+
+  -- Drop a resource by name
+  ALTER PUBLISHED REST SERVICE Module.MyAPI DROP RESOURCE 'legacy';
+
 GRANT / REVOKE ACCESS
 ---------------------
 

docs/01-project/MDL_QUICK_REFERENCE.md

@@ -444,6 +444,9 @@ CREATE OR REPLACE NAVIGATION Responsive
 | Describe service | `DESCRIBE PUBLISHED REST SERVICE Module.Name;` | Re-executable CREATE statement |
 | Create service | See below | |
 | Create or replace | `CREATE OR REPLACE PUBLISHED REST SERVICE ...` | Replaces existing service |
+| Alter service | `ALTER PUBLISHED REST SERVICE Module.Name SET Path = '...', Version = '...';` | SET supports Path, Version, ServiceName |
+| Add resource | `ALTER PUBLISHED REST SERVICE Module.Name ADD RESOURCE 'name' { ... };` | Operation block uses CREATE syntax |
+| Drop resource | `ALTER PUBLISHED REST SERVICE Module.Name DROP RESOURCE 'name';` | |
 | Drop service | `DROP PUBLISHED REST SERVICE Module.Name;` | |
 | Grant access | `GRANT ACCESS ON PUBLISHED REST SERVICE Module.Name TO Module.Role, ...;` | Adds module roles to AllowedRoles |
 | Revoke access | `REVOKE ACCESS ON PUBLISHED REST SERVICE Module.Name FROM Module.Role, ...;` | |

mdl-examples/doctype-tests/22-published-rest-service-examples.mdl

@@ -140,7 +140,25 @@ REVOKE ACCESS ON PUBLISHED REST SERVICE PrsTest.OrderAPI FROM PrsTest.User;
 DESCRIBE PUBLISHED REST SERVICE PrsTest.OrderAPI;
 
 -- ############################################################################
--- PART 7: DROP
+-- PART 7: ALTER
+-- ############################################################################
+--
+-- Modify properties or add/remove resources without recreating the service.
+
+ALTER PUBLISHED REST SERVICE PrsTest.OrderAPI SET Version = '1.1.0';
+ALTER PUBLISHED REST SERVICE PrsTest.OrderAPI
+  SET Path = 'rest/orders/v1', ServiceName = 'Order API';
+
+ALTER PUBLISHED REST SERVICE PrsTest.OrderAPI ADD RESOURCE 'shipments' {
+  GET '' MICROFLOW PrsTest.PRS_GetAllOrders;
+};
+
+DESCRIBE PUBLISHED REST SERVICE PrsTest.OrderAPI;
+
+ALTER PUBLISHED REST SERVICE PrsTest.OrderAPI DROP RESOURCE 'shipments';
+
+-- ############################################################################
+-- PART 8: DROP
 -- ############################################################################
 
 DROP PUBLISHED REST SERVICE PrsTest.OrderAPI;

mdl/ast/ast_rest.go

@@ -103,3 +103,42 @@ type DropPublishedRestServiceStmt struct {
 }
 
 func (s *DropPublishedRestServiceStmt) isStatement() {}
+
+// AlterPublishedRestServiceStmt represents:
+//
+//	ALTER PUBLISHED REST SERVICE Module.Name <action>+
+//
+// where each action is one of: SET key = 'value' [, ...], ADD RESOURCE
+// 'name' { ... }, or DROP RESOURCE 'name'.
+type AlterPublishedRestServiceStmt struct {
+	Name    QualifiedName
+	Actions []PublishedRestAlterAction
+}
+
+func (s *AlterPublishedRestServiceStmt) isStatement() {}
+
+// PublishedRestAlterAction is one of the alter operations.
+type PublishedRestAlterAction interface {
+	isPublishedRestAlterAction()
+}
+
+// PublishedRestSetAction represents: SET key = 'value' [, ...]
+type PublishedRestSetAction struct {
+	Changes map[string]string
+}
+
+func (a *PublishedRestSetAction) isPublishedRestAlterAction() {}
+
+// PublishedRestAddResourceAction represents: ADD RESOURCE 'name' { ops... }
+type PublishedRestAddResourceAction struct {
+	Resource *PublishedRestResourceDef
+}
+
+func (a *PublishedRestAddResourceAction) isPublishedRestAlterAction() {}
+
+// PublishedRestDropResourceAction represents: DROP RESOURCE 'name'
+type PublishedRestDropResourceAction struct {
+	Name string
+}
+
+func (a *PublishedRestDropResourceAction) isPublishedRestAlterAction() {}

mdl/executor/cmd_published_rest.go

@@ -269,3 +269,83 @@ func (e *Executor) execDropPublishedRestService(s *ast.DropPublishedRestServiceS
 
 	return fmt.Errorf("published REST service %s.%s not found", s.Name.Module, s.Name.Name)
 }
+
+// astResourceDefToModel converts an AST PublishedRestResourceDef to the
+// runtime model type used by the writer.
+func astResourceDefToModel(def *ast.PublishedRestResourceDef) *model.PublishedRestResource {
+	resource := &model.PublishedRestResource{Name: def.Name}
+	for _, opDef := range def.Operations {
+		resource.Operations = append(resource.Operations, &model.PublishedRestOperation{
+			HTTPMethod: opDef.HTTPMethod,
+			Path:       opDef.Path,
+			Microflow:  opDef.Microflow.String(),
+			Deprecated: opDef.Deprecated,
+		})
+	}
+	return resource
+}
+
+// execAlterPublishedRestService applies SET / ADD RESOURCE / DROP RESOURCE
+// actions to an existing published REST service.
+func (e *Executor) execAlterPublishedRestService(s *ast.AlterPublishedRestServiceStmt) error {
+	if e.writer == nil {
+		return fmt.Errorf("not connected to a project in write mode")
+	}
+
+	svc, err := e.findPublishedRestService(s.Name.Module, s.Name.Name)
+	if err != nil {
+		return fmt.Errorf("published REST service %s.%s not found", s.Name.Module, s.Name.Name)
+	}
+
+	for _, action := range s.Actions {
+		switch a := action.(type) {
+		case *ast.PublishedRestSetAction:
+			for key, val := range a.Changes {
+				switch strings.ToLower(key) {
+				case "path":
+					svc.Path = val
+				case "version":
+					svc.Version = val
+				case "servicename":
+					svc.ServiceName = val
+				default:
+					return fmt.Errorf("unknown published REST service property: %s (allowed: Path, Version, ServiceName)", key)
+				}
+			}
+
+		case *ast.PublishedRestAddResourceAction:
+			// Reject duplicate resource names
+			for _, existing := range svc.Resources {
+				if existing.Name == a.Resource.Name {
+					return fmt.Errorf("resource '%s' already exists on %s.%s", a.Resource.Name, s.Name.Module, s.Name.Name)
+				}
+			}
+			svc.Resources = append(svc.Resources, astResourceDefToModel(a.Resource))
+
+		case *ast.PublishedRestDropResourceAction:
+			idx := -1
+			for i, existing := range svc.Resources {
+				if existing.Name == a.Name {
+					idx = i
+					break
+				}
+			}
+			if idx == -1 {
+				return fmt.Errorf("resource '%s' not found on %s.%s", a.Name, s.Name.Module, s.Name.Name)
+			}
+			svc.Resources = append(svc.Resources[:idx], svc.Resources[idx+1:]...)
+
+		default:
+			return fmt.Errorf("unsupported alter action: %T", action)
+		}
+	}
+
+	if err := e.writer.UpdatePublishedRestService(svc); err != nil {
+		return fmt.Errorf("failed to alter published REST service: %w", err)
+	}
+
+	if !e.quiet {
+		fmt.Fprintf(e.output, "Altered published REST service %s.%s\n", s.Name.Module, s.Name.Name)
+	}
+	return nil
+}

mdl/executor/executor_dispatch.go

@@ -200,6 +200,8 @@ func (e *Executor) executeInner(stmt ast.Statement) error {
 		return e.execCreatePublishedRestService(s)
 	case *ast.DropPublishedRestServiceStmt:
 		return e.execDropPublishedRestService(s)
+	case *ast.AlterPublishedRestServiceStmt:
+		return e.execAlterPublishedRestService(s)
 	case *ast.CreateExternalEntityStmt:
 		return e.execCreateExternalEntity(s)
 	case *ast.CreateExternalEntitiesStmt:

mdl/grammar/MDLParser.g4

@@ -119,6 +119,17 @@ alterStatement
     | ALTER PAGE qualifiedName LBRACE alterPageOperation+ RBRACE
     | ALTER SNIPPET qualifiedName LBRACE alterPageOperation+ RBRACE
     | ALTER WORKFLOW qualifiedName alterWorkflowAction+ SEMICOLON?
+    | ALTER PUBLISHED REST SERVICE qualifiedName alterPublishedRestServiceAction (COMMA? alterPublishedRestServiceAction)*
+    ;
+
+alterPublishedRestServiceAction
+    : SET publishedRestAlterAssignment (COMMA publishedRestAlterAssignment)*
+    | ADD publishedRestResource
+    | DROP RESOURCE STRING_LITERAL
+    ;
+
+publishedRestAlterAssignment
+    : identifierOrKeyword EQUALS STRING_LITERAL
     ;
 
 /**