Sign in
Modules

Create a module in a project

Changed on

Member-only (role >= member). Auto-derives a per-parent-unique path segment from the name. Modules nest up to 6 levels; depth >= 5 returns a soft warning, depth > 6 is rejected. Duplicate sibling path returns 409; non-members return 403.

post/api/v1/projects/{id}/modules

Request

  • Base URL: http://localhost:3000
  • URL: http://localhost:3000/api/v1/projects/{id}/modules
  • Auth: one of:
    • API key in cookie sb-fmbpikzpkafptqximhxn-auth-token
    • HTTP bearer

Path parameters

idstring uuid required

Request body

namestring required

2–80 chars, at least one alphanumeric. Path segment is auto-derived.

descriptionstring

Optional Markdown, max 500 chars.

parent_module_idstring uuid

Parent module id; omit for a root module. Must belong to the same project.

Response

Module created.

warningstring

Present only when the resulting nesting depth is >= 5.

Changes

  • 4528999528c6Revision changes
    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

    • warning

      added the new test_outside_plan_project enum value to the / response property for the response status

  • 2ca74ff5fec5Revision changes
    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status

    • info

      removed the test_outside_plan_project enum value from the / response property for the response status