+Core
A shared foundation for accountable municipal work.
Operating manual →Townlight Access API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Access API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Access 0.5.0. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/code.html b/docs/beta-1/api/code.html index fcab814..6c86a44 100644 --- a/docs/beta-1/api/code.html +++ b/docs/beta-1/api/code.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Code API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Code API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Code 1.0.9. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/core.html b/docs/beta-1/api/core.html index 07dc8dd..ad9db42 100644 --- a/docs/beta-1/api/core.html +++ b/docs/beta-1/api/core.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Core API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Core API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Core 1.3.0.dev2. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/inspections.html b/docs/beta-1/api/inspections.html index 91ede31..415710f 100644 --- a/docs/beta-1/api/inspections.html +++ b/docs/beta-1/api/inspections.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Inspections API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Inspections API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Inspections 0.3.0+dev.2. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/meetings.html b/docs/beta-1/api/meetings.html index a0337ea..c2817c1 100644 --- a/docs/beta-1/api/meetings.html +++ b/docs/beta-1/api/meetings.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Meetings API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Meetings API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Meetings 1.0.5. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/notice.html b/docs/beta-1/api/notice.html index 275a264..c9e3b8f 100644 --- a/docs/beta-1/api/notice.html +++ b/docs/beta-1/api/notice.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Notice API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Notice API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Notice 0.3.0. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/permitting.html b/docs/beta-1/api/permitting.html index 9b8dc83..9e64463 100644 --- a/docs/beta-1/api/permitting.html +++ b/docs/beta-1/api/permitting.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Permitting API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Permitting API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Permitting 0.3.0+dev.2. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/planning.html b/docs/beta-1/api/planning.html index 39ab819..dacbe93 100644 --- a/docs/beta-1/api/planning.html +++ b/docs/beta-1/api/planning.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Planning API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Planning API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Planning 0.4.0.dev2. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/records.html b/docs/beta-1/api/records.html index 5bba24d..88a8201 100644 --- a/docs/beta-1/api/records.html +++ b/docs/beta-1/api/records.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Records API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Records API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Records 1.8.0.dev2. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/station-service-openapi.json b/docs/beta-1/api/station-service-openapi.json new file mode 100644 index 0000000..0df0b54 --- /dev/null +++ b/docs/beta-1/api/station-service-openapi.json @@ -0,0 +1,1962 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "Townlight Station", + "version": "0.3.0" + }, + "paths": { + "/health": { + "get": { + "summary": "Health", + "operationId": "health_health_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/v1/identity": { + "get": { + "summary": "Identity", + "operationId": "identity_v1_identity_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/recordings": { + "post": { + "summary": "Capture", + "operationId": "capture_v1_recordings_post", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Capture" + } + } + } + }, + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "summary": "List Records", + "operationId": "list_records_v1_recordings_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/recordings/{identity}": { + "get": { + "summary": "Get Record", + "operationId": "get_record_v1_recordings__identity__get", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/recordings/{identity}/content": { + "get": { + "summary": "Content", + "operationId": "content_v1_recordings__identity__content_get", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/recordings/{identity}/retry": { + "post": { + "summary": "Retry", + "operationId": "retry_v1_recordings__identity__retry_post", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/live-sources": { + "get": { + "summary": "Live Sources", + "operationId": "live_sources_v1_live_sources_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/recordings/{identity}/stop": { + "post": { + "summary": "Stop Live", + "operationId": "stop_live_v1_recordings__identity__stop_post", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/civiccast-feeds": { + "get": { + "summary": "Catalog", + "operationId": "catalog_v1_civiccast_feeds_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/recordings/{identity}/youtube": { + "post": { + "summary": "Upload", + "operationId": "upload_v1_recordings__identity__youtube_post", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Upload" + } + } + } + }, + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/youtube-uploads": { + "get": { + "summary": "List Uploads", + "operationId": "list_uploads_v1_youtube_uploads_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/youtube-uploads/{identity}/retry": { + "post": { + "summary": "Retry", + "operationId": "retry_v1_youtube_uploads__identity__retry_post", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/schedules": { + "post": { + "summary": "Create Schedule", + "operationId": "create_schedule_v1_schedules_post", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ScheduleRequest" + } + } + } + }, + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "summary": "List Schedules", + "operationId": "list_schedules_v1_schedules_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/schedules/{identity}/cancel": { + "post": { + "summary": "Cancel Schedule", + "operationId": "cancel_schedule_v1_schedules__identity__cancel_post", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/playouts": { + "post": { + "summary": "Create Playout", + "operationId": "create_playout_v1_playouts_post", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PlayoutRequest" + } + } + } + }, + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + }, + "get": { + "summary": "List Playouts", + "operationId": "list_playouts_v1_playouts_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/playouts/{identity}": { + "get": { + "summary": "Get Playout", + "operationId": "get_playout_v1_playouts__identity__get", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/on-air": { + "get": { + "summary": "On Air", + "operationId": "on_air_v1_on_air_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/on-air/live": { + "post": { + "summary": "Live Override", + "description": "Put a configured live input on air, in place of the scheduled program.", + "operationId": "live_override_v1_on_air_live_post", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LiveOverrideRequest" + } + } + } + }, + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/on-air/return-to-schedule": { + "post": { + "summary": "Return To Schedule", + "operationId": "return_to_schedule_v1_on_air_return_to_schedule_post", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/playouts/{identity}/approve": { + "post": { + "summary": "Approve", + "operationId": "approve_v1_playouts__identity__approve_post", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ApprovalRequest" + } + } + } + }, + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/playouts/{identity}/publish": { + "post": { + "summary": "Publish", + "operationId": "publish_v1_playouts__identity__publish_post", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "202": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/public/playback/{identity}": { + "get": { + "summary": "Public Playback", + "operationId": "public_playback_v1_public_playback__identity__get", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/public/playback/{identity}/captions": { + "get": { + "summary": "Public Captions", + "operationId": "public_captions_v1_public_playback__identity__captions_get", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/public/playback/{identity}/program": { + "get": { + "summary": "Public Program", + "operationId": "public_program_v1_public_playback__identity__program_get", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/v1/operator-ticket": { + "post": { + "summary": "Issue", + "operationId": "issue_v1_operator_ticket_post", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/operator/session": { + "post": { + "summary": "Exchange", + "operationId": "exchange_operator_session_post", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Ticket" + } + } + }, + "required": true + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/operator/logout": { + "post": { + "summary": "Logout", + "operationId": "logout_operator_logout_post", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/operator/catalog": { + "get": { + "summary": "Catalog", + "operationId": "catalog_operator_catalog_get", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/operator/meeting/{identity}": { + "get": { + "summary": "Meeting", + "operationId": "meeting_operator_meeting__identity__get", + "parameters": [ + { + "name": "identity", + "in": "path", + "required": true, + "schema": { + "type": "string", + "format": "uuid", + "title": "Identity" + } + }, + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/operator/handoff": { + "post": { + "summary": "Handoff", + "operationId": "handoff_operator_handoff_post", + "parameters": [ + { + "name": "X-Townlight-Session", + "in": "header", + "required": false, + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "X-Townlight-Session" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Handoff" + } + } + } + }, + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, + "422": { + "description": "Validation Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + } + } + }, + "/": { + "get": { + "summary": "Page", + "operationId": "page__get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/operator.js": { + "get": { + "summary": "Script", + "operationId": "script_operator_js_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + }, + "/operator.css": { + "get": { + "summary": "Style", + "operationId": "style_operator_css_get", + "responses": { + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + } + } + } + } + }, + "components": { + "schemas": { + "ApprovalRequest": { + "properties": { + "note": { + "type": "string", + "maxLength": 500, + "minLength": 3, + "title": "Note" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "note" + ], + "title": "ApprovalRequest" + }, + "Capture": { + "properties": { + "meeting_id": { + "type": "string", + "format": "uuid", + "title": "Meeting Id" + }, + "agenda_ids": { + "items": { + "type": "string", + "format": "uuid" + }, + "type": "array", + "maxItems": 100, + "title": "Agenda Ids" + }, + "source_file": { + "anyOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,180}$" + }, + { + "type": "null" + } + ], + "title": "Source File" + }, + "live_source_id": { + "anyOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,64}$" + }, + { + "type": "null" + } + ], + "title": "Live Source Id" + }, + "civiccast_feed_id": { + "anyOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,64}$" + }, + { + "type": "null" + } + ], + "title": "Civiccast Feed Id" + }, + "captions_file": { + "anyOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,180}\\.srt$" + }, + { + "type": "null" + } + ], + "title": "Captions File" + }, + "idempotency_key": { + "type": "string", + "maxLength": 100, + "minLength": 1, + "title": "Idempotency Key" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "meeting_id", + "idempotency_key" + ], + "title": "Capture" + }, + "HTTPValidationError": { + "properties": { + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "type": "array", + "title": "Detail" + } + }, + "type": "object", + "title": "HTTPValidationError" + }, + "Handoff": { + "properties": { + "request_id": { + "type": "string", + "format": "uuid", + "title": "Request Id" + }, + "recording_id": { + "type": "string", + "format": "uuid", + "title": "Recording Id" + }, + "expected_sha256": { + "type": "string", + "pattern": "^[0-9a-f]{64}$", + "title": "Expected Sha256" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "request_id", + "recording_id", + "expected_sha256" + ], + "title": "Handoff" + }, + "LiveOverrideRequest": { + "properties": { + "live_source_id": { + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,64}$", + "title": "Live Source Id" + }, + "reason": { + "type": "string", + "maxLength": 200, + "minLength": 3, + "title": "Reason" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "live_source_id", + "reason" + ], + "title": "LiveOverrideRequest", + "description": "An on-air override naming an administrator-configured live input." + }, + "PlayoutRequest": { + "properties": { + "recording_id": { + "type": "string", + "format": "uuid", + "title": "Recording Id" + }, + "mode": { + "type": "string", + "pattern": "^(dry-run|commit)$", + "title": "Mode" + }, + "idempotency_key": { + "type": "string", + "maxLength": 100, + "minLength": 1, + "title": "Idempotency Key" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "recording_id", + "mode", + "idempotency_key" + ], + "title": "PlayoutRequest" + }, + "ScheduleRequest": { + "properties": { + "meeting_id": { + "type": "string", + "format": "uuid", + "title": "Meeting Id" + }, + "agenda_ids": { + "items": { + "type": "string", + "format": "uuid" + }, + "type": "array", + "maxItems": 100, + "title": "Agenda Ids" + }, + "source_file": { + "anyOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,180}$" + }, + { + "type": "null" + } + ], + "title": "Source File" + }, + "live_source_id": { + "anyOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,64}$" + }, + { + "type": "null" + } + ], + "title": "Live Source Id" + }, + "captions_file": { + "anyOf": [ + { + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,180}\\.srt$" + }, + { + "type": "null" + } + ], + "title": "Captions File" + }, + "start_at": { + "type": "string", + "format": "date-time", + "title": "Start At" + }, + "idempotency_key": { + "type": "string", + "maxLength": 100, + "minLength": 1, + "title": "Idempotency Key" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "meeting_id", + "start_at", + "idempotency_key" + ], + "title": "ScheduleRequest" + }, + "Ticket": { + "properties": { + "ticket": { + "type": "string", + "maxLength": 128, + "minLength": 32, + "title": "Ticket" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "ticket" + ], + "title": "Ticket" + }, + "Upload": { + "properties": { + "title": { + "type": "string", + "maxLength": 100, + "minLength": 1, + "pattern": "^[^<>\\x00-\\x1f]+$", + "title": "Title" + }, + "privacy": { + "type": "string", + "enum": [ + "private", + "unlisted", + "public" + ], + "title": "Privacy", + "default": "private" + }, + "approval_note": { + "type": "string", + "maxLength": 500, + "minLength": 3, + "title": "Approval Note" + }, + "idempotency_key": { + "type": "string", + "maxLength": 100, + "minLength": 1, + "title": "Idempotency Key" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "title", + "approval_note", + "idempotency_key" + ], + "title": "Upload" + }, + "ValidationError": { + "properties": { + "loc": { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, + "type": "array", + "title": "Location" + }, + "msg": { + "type": "string", + "title": "Message" + }, + "type": { + "type": "string", + "title": "Error Type" + }, + "input": { + "title": "Input" + }, + "ctx": { + "type": "object", + "title": "Context" + } + }, + "type": "object", + "required": [ + "loc", + "msg", + "type" + ], + "title": "ValidationError" + } + } + } +} \ No newline at end of file diff --git a/docs/beta-1/api/station.html b/docs/beta-1/api/station.html index 1d46cc3..256edf1 100644 --- a/docs/beta-1/api/station.html +++ b/docs/beta-1/api/station.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Station API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Station API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Station 0.3.0. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/suite.html b/docs/beta-1/api/suite.html index 7afab04..ca630ec 100644 --- a/docs/beta-1/api/suite.html +++ b/docs/beta-1/api/suite.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Suite API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Suite API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Desktop source 1.7.0-1; townlight-runtime 0.2.0. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/api/zoning.html b/docs/beta-1/api/zoning.html index e5ee5ce..5db5871 100644 --- a/docs/beta-1/api/zoning.html +++ b/docs/beta-1/api/zoning.html @@ -7,8 +7,8 @@ @page{size:Letter;margin:.7in .65in .75in} @media print{html{scroll-behavior:auto}body{font:10.5pt/1.45 Arial,sans-serif;color:#172f39}header,footer,.search-area,.screen-only{display:none}.doclayout{display:block;padding:0;max-width:none}.toc{position:static;max-height:none;overflow:visible;font-size:10pt;break-after:page}.toc>h2{border:0}.toc ul{columns:2;column-gap:.3in}.toc li{break-inside:avoid}.docbody h1{font-size:30pt}.docbody h2{font-size:19pt;break-after:avoid;padding-top:.15in;margin-top:.35in}.docbody h3{font-size:12pt;break-after:avoid}.docbody h4{break-after:avoid}p{orphans:3;widows:3}pre{font-size:8.2pt;line-height:1.4;padding:.1in;break-inside:auto}table{font-size:8.4pt;line-height:1.35}th,td{padding:.06in .07in}tr{break-inside:avoid}.flow{max-height:6in;object-fit:contain;break-inside:avoid}a{color:#172f39;text-decoration:underline}.cover{break-after:page;padding-top:1in}.cover .edition{font-size:11pt}.cover h1{font-size:32pt}.cover .lead{font-size:14pt}.api-entry{break-inside:auto}.api-entry h3{break-after:avoid}.index-columns{columns:2}} -pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Zoning API reference
-Prepared source candidate, November 2, 2026. New signed Windows installed acceptance and publication remain pending.
+pre{white-space:pre-wrap;overflow-wrap:anywhere}summary{cursor:pointer;padding:.6rem;font-weight:600}details{margin:.5rem 0}Skip to contentTownlight Zoning API reference
+Windows Beta 1 · source reference. The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. This schema describes source contracts. The Windows acceptance summary identifies the installed checks.
Townlight Zoning 0.2.3. The HTTP host is Townlight Records 1.8.0.dev2. Component package versions and the host API version are separate identities.
Generated from the actual native inspections-preview composition without application lifespan, migrations or database/network access. It describes route and validation contracts; it does not establish endpoint behavior, individual authorization or installed acceptance. Standalone product applications have separate deployment boundaries.
Machine-readable OpenAPI schema · Operating manual and limits
diff --git a/docs/beta-1/assets/code-architecture.svg b/docs/beta-1/assets/code-architecture.svg new file mode 100644 index 0000000..a61123b --- /dev/null +++ b/docs/beta-1/assets/code-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/core-architecture.svg b/docs/beta-1/assets/core-architecture.svg new file mode 100644 index 0000000..d31cb59 --- /dev/null +++ b/docs/beta-1/assets/core-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/inspections-architecture.svg b/docs/beta-1/assets/inspections-architecture.svg new file mode 100644 index 0000000..03a2f1a --- /dev/null +++ b/docs/beta-1/assets/inspections-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/meetings-architecture.svg b/docs/beta-1/assets/meetings-architecture.svg new file mode 100644 index 0000000..013fcaf --- /dev/null +++ b/docs/beta-1/assets/meetings-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/permitting-architecture.svg b/docs/beta-1/assets/permitting-architecture.svg new file mode 100644 index 0000000..f0ea848 --- /dev/null +++ b/docs/beta-1/assets/permitting-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/planning-architecture.svg b/docs/beta-1/assets/planning-architecture.svg new file mode 100644 index 0000000..7ade4b3 --- /dev/null +++ b/docs/beta-1/assets/planning-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/portal-architecture.svg b/docs/beta-1/assets/portal-architecture.svg new file mode 100644 index 0000000..5b3849c --- /dev/null +++ b/docs/beta-1/assets/portal-architecture.svg @@ -0,0 +1 @@ + diff --git a/docs/beta-1/assets/portal-home.png b/docs/beta-1/assets/portal-home.png new file mode 100644 index 0000000..c99e299 Binary files /dev/null and b/docs/beta-1/assets/portal-home.png differ diff --git a/docs/beta-1/assets/portal-meeting.png b/docs/beta-1/assets/portal-meeting.png new file mode 100644 index 0000000..524e104 Binary files /dev/null and b/docs/beta-1/assets/portal-meeting.png differ diff --git a/docs/beta-1/assets/records-architecture.svg b/docs/beta-1/assets/records-architecture.svg new file mode 100644 index 0000000..4577fb7 --- /dev/null +++ b/docs/beta-1/assets/records-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/station-architecture.svg b/docs/beta-1/assets/station-architecture.svg new file mode 100644 index 0000000..ce93434 --- /dev/null +++ b/docs/beta-1/assets/station-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/station-delivery-architecture.svg b/docs/beta-1/assets/station-delivery-architecture.svg new file mode 100644 index 0000000..bb1f02d --- /dev/null +++ b/docs/beta-1/assets/station-delivery-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/assets/suite-architecture.svg b/docs/beta-1/assets/suite-architecture.svg new file mode 100644 index 0000000..5206ca7 --- /dev/null +++ b/docs/beta-1/assets/suite-architecture.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/beta-1/docx/Townlight-Access-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Access-Manual-Beta-1.docx index 2edaf64..bd2a640 100644 Binary files a/docs/beta-1/docx/Townlight-Access-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Access-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Code-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Code-Manual-Beta-1.docx index 54b01ed..8eb808d 100644 Binary files a/docs/beta-1/docx/Townlight-Code-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Code-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Core-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Core-Manual-Beta-1.docx index 529355c..1ac2765 100644 Binary files a/docs/beta-1/docx/Townlight-Core-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Core-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Inspections-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Inspections-Manual-Beta-1.docx index a801881..51f752f 100644 Binary files a/docs/beta-1/docx/Townlight-Inspections-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Inspections-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Meetings-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Meetings-Manual-Beta-1.docx index 7182d23..bf6d04d 100644 Binary files a/docs/beta-1/docx/Townlight-Meetings-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Meetings-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Notice-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Notice-Manual-Beta-1.docx index 3c63383..df4c5df 100644 Binary files a/docs/beta-1/docx/Townlight-Notice-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Notice-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Permitting-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Permitting-Manual-Beta-1.docx index 390e03b..a631a99 100644 Binary files a/docs/beta-1/docx/Townlight-Permitting-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Permitting-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Planning-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Planning-Manual-Beta-1.docx index 6754f2d..f130233 100644 Binary files a/docs/beta-1/docx/Townlight-Planning-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Planning-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Portal-Guide-Beta-1.docx b/docs/beta-1/docx/Townlight-Portal-Guide-Beta-1.docx new file mode 100644 index 0000000..d9196e3 Binary files /dev/null and b/docs/beta-1/docx/Townlight-Portal-Guide-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Records-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Records-Manual-Beta-1.docx index 7802795..3caa12c 100644 Binary files a/docs/beta-1/docx/Townlight-Records-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Records-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Station-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Station-Manual-Beta-1.docx index bb4e7a9..11f05b6 100644 Binary files a/docs/beta-1/docx/Townlight-Station-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Station-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Suite-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Suite-Manual-Beta-1.docx index cda568e..ed79d05 100644 Binary files a/docs/beta-1/docx/Townlight-Suite-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Suite-Manual-Beta-1.docx differ diff --git a/docs/beta-1/docx/Townlight-Zoning-Manual-Beta-1.docx b/docs/beta-1/docx/Townlight-Zoning-Manual-Beta-1.docx index 8e7b61c..24abe7e 100644 Binary files a/docs/beta-1/docx/Townlight-Zoning-Manual-Beta-1.docx and b/docs/beta-1/docx/Townlight-Zoning-Manual-Beta-1.docx differ diff --git a/docs/beta-1/index.html b/docs/beta-1/index.html index faa792b..3ab5ae2 100644 --- a/docs/beta-1/index.html +++ b/docs/beta-1/index.html @@ -1 +1 @@ -The connected municipal suite · Townlight Beta 1
Municipal work with a clear record.
Connected municipal products help staff prepare, review and retain municipal work. Start with a controlled private beta, keep original evidence, and make each official decision deliberately.
Suite candidate 1.7.0.1; installed acceptance pendingAGPL-3.0-onlyBeta evaluation · Windows fresh-install scope
The product family
The kept products and their connected workflows.
Records
From request intake to a deliberate release.
Operating manual →Meetings
Keep the agenda, decisions and evidence connected.
Operating manual →Code
Trace every section to its source and history.
Operating manual →Access
Retain reviewed source, advice and draft provenance for human review.
Operating manual →Notice
Review, approve and retain actual posting proof and a verified archive.
Operating manual →Zoning
Bring parcel context and cited rules into one review.
Operating manual →Planning
Connect policy, analysis and municipal progress.
Operating manual →Permitting
Prepare a complete, cited intake for staff review.
Operating manual →Inspections
Preserve evidence and review every draft finding.
Operating manual →Station
Capture the meeting and preserve its evidence.
Operating manual →Designed around the record
Prepare, review, hand off.
Keep source versions and original hashes connected to staff work. Select the intended audience, review the saved revision, and explicitly attach the resulting evidence. Records retains the final response and release decisions.
A practical beta deployment
The selected Townlight desktop composition includes Access and Notice staff workspaces alongside the existing municipal workflows. Station is a separately configured capture and media service. Standalone CivicCast keeps its own product, installation and data.
The changed candidate still requires a new signed installer and exact installed acceptance before distribution. This documentation site does not provision a hosted city portal.
Architecture
The suite and its boundaries
Native staff workspaces use canonical Python/PostgreSQL services. Station has a separate database, media store and explicit Townlight authority.
Evidence rather than promises
Candidate installed acceptance remains pending.
Earlier releases have their own first-run and synthetic Windows Sandbox evidence. This changed source candidate requires a new signed installer and installed acceptance. This is not a claim that every screen, vendor, upgrade or city equipment configuration has been certified.
Read the exact acceptance and limits →Ready to evaluate?
Begin with the current manual; obtain this candidate only after its exact installer and acceptance are identified. Configure the chosen test site and have its staff review source applicability and run the existing workflows.
Station delivery update
Live cable coverage and recorded video delivery
Station offers an encrypted live SRT feed to separate CivicCast while recording. The PEG operator controls cable broadcast. Completed recordings can be explicitly uploaded to YouTube with a reviewed title and chosen visibility. The private Records original stays intact.
The connected municipal suite · Townlight Beta 1
Municipal work with a clear record.
Connected municipal products help staff prepare, review and retain municipal work. Start with a controlled beta evaluation, keep original evidence, and make each official decision deliberately.
Signed Windows x64 MSI 1.7.0.1AGPL-3.0-onlyBeta evaluation · Windows fresh-install scope
The product family
The kept products and their connected workflows.
Core
A shared foundation for accountable municipal work.
Operating manual →Records
From request intake to a deliberate release.
Operating manual →Meetings
Keep the agenda, decisions and evidence connected.
Operating manual →Code
Trace every section to its source and history.
Operating manual →Access
Retain reviewed source, advice and draft provenance for human review.
Operating manual →Notice
Review, approve and retain actual posting proof and a verified archive.
Operating manual →Zoning
Bring parcel context and cited rules into one review.
Operating manual →Planning
Connect policy, analysis and municipal progress.
Operating manual →Permitting
Prepare a complete, cited intake for staff review.
Operating manual →Inspections
Preserve evidence and review every draft finding.
Operating manual →Station
Capture the meeting and preserve its evidence.
Operating manual →Designed around the record
Prepare, review, hand off.
Keep source versions and original hashes connected to staff work. Select the intended audience, review the saved revision, and explicitly attach the resulting evidence. Records retains the final response and release decisions.
A practical beta deployment
The selected Townlight desktop composition includes Access and Notice staff workspaces alongside the existing municipal workflows. Station is a separately configured capture and media service. Standalone CivicCast keeps its own product, installation and data.
Download the Windows x64 beta 1.7.0.1, matching source and checksums from GitHub.
Architecture
The suite and its boundaries
Native staff workspaces use canonical Python/PostgreSQL services. Station has a separate database, media store and explicit Townlight authority.
Evidence rather than promises
Windows Sandbox acceptance passed.
The Windows acceptance summary records the workflows exercised with synthetic data on the released MSI. This is not a claim that every screen, vendor, upgrade or city equipment configuration has been certified.
Read the exact acceptance and limits →Ready to evaluate?
Begin with the current manual and download the Windows x64 beta 1.7.0.1. Configure the chosen test site and have its staff review source applicability and run the existing workflows.
Station delivery update
Live cable coverage and recorded video delivery
Station offers an encrypted live SRT feed to separate CivicCast while recording. The PEG operator controls cable broadcast. Completed recordings can be explicitly uploaded to YouTube with a reviewed title and chosen visibility. The private Records original stays intact.
See the Townlight Portal Guide for the separately deployed resident portal.
Townlight Beta 1
Townlight +Portal +Guide
Staff guide and technical reference
Townlight Portal guide
+Townlight Beta 1 · separately deployed portal beta
+The portal is a separately deployed suite capability for city pages +and public meeting archives. It brings together a public Meetings +archive, a completed Station recording and a Records release copy +selected for publication. It does not add a tenth product. The existing +signed Beta 1 installer and prior Sandbox evidence predate this local +portal integration; they do not demonstrate that it is installed or +publicly deployed. CivicCast remains separate.
+For staff: prepare and +publish
+-
+
- In Meetings, publish the intended non-closed meeting archive. Review +its title, scheduled time, agenda, packet, minutes and summary for +public use. +
- Complete the corresponding Station recording and the Records request +and release workflow. Records must have a current approved response, +completed verified artifacts, a fulfilled request and an eligible +managed release copy with verified lineage to that recording. Keep the +original private. +
- Obtain the Records request UUID from the trusted staff workflow. A +fulfilled request or prepared copy is not consent to publish. +
- A Wagtail superuser opens Townlight publication in
+
/admin/, enters the request UUID, selects Find +approved releases, and chooses the intended result. The form +fills the archive, meeting, recording, request and release-copy IDs and +expected SHA-256; approval remains unchecked. Review the selection and +public content, select Publish or update, and +explicitly approve. Confirm the resulting meeting page and approved file +as a resident would. Ordinary Wagtail editors cannot use this +publisher.
+ - To remove it from the public archive, use the same selection and +hash, choose Withdraw, and explicitly approve. Verify +that the meeting and file are no longer accessible. Withdrawal hides the +projection; retain source records and follow local retention +policy. +
An unsuccessful synchronization leaves the previous publication +intact. Repeating a successful publication updates the same archive +identity. If source records change, review and explicitly publish again; +do not assume a source error withdraws a prior version.
+Residents
+
+
+The meeting archive is at /meetings/. A published
+meeting page at /meetings/<pk>/ presents the approved
+public meeting text and links to its release at
+/meetings/<pk>/release/. The approved release bytes
+are served with the selected MIME type and support byte ranges for video
+playback. Public text is filtered; requester contact information,
+internal notes, raw payloads, local paths and session proof are not
+public fields. This integration is for completed release copies, not
+live YouTube streaming. Station’s separate CivicCast and YouTube
+workflows retain their own controls.
The city-branded homepage presents a resident task finder, service +information and the latest published playable recording when one is +available. The archive offers upcoming, past and all dates, title +search, a meeting-series selector and 20 results per page. Meeting +series uses the actual public title: the source contract does not supply +a separate board taxonomy. Each date uses that meeting’s configured IANA +time zone. Cancelled entries remain identifiable, with no offered +playback or documents.
+
+
+On a native Townlight meeting, open Agenda, +Meeting packet or Approved minutes to +read the actual approved text in a separate printable page. These are +text documents, not invented PDF attachments. Video controls play the +approved release; Download approved release retrieves +the same checked bytes. Expand About this public record +for provenance IDs, hashes and precise timestamps. PrimeGov fixtures +instead identify their links as synthetic references; they do not imply +live vendor downloads or playable media.
+Search matches published service-page titles and +published meeting titles only, with at most 50 results of each type. It +excludes drafts, restricted city pages, withdrawn meetings and private +staff content. It does not search the bodies of documents, external +systems or private Records requests. Service buttons name the +destination host before taking a resident to the city’s configured +existing service. Applications, requests and payments stay in that +designated system. Navigation, the task finder and filters work without +JavaScript; JavaScript enhances the mobile menu.
+City editors: +branding and service content
+-
+
- Open the home page in Wagtail. Set Brand name,
+Brand prefix, the optional city Logo
+and Hero image, the Hero title,
+introduction, address and hours. Uploaded imagery must be approved for
+public use. With no uploaded images, the original generic civic emblem
+and illustrations are used. The page title is the fallback brand name;
+
TOWNLIGHT_BRANDremains the administrative +site-name/fallback setting. Existing versions stay unchanged and the +suite label is Townlight Beta 1.
+ - Create or edit a Service page under the home page. +Set its title, kind, summary, section heading and body. Enter one next +step per line. Optional question/answer blocks become expandable common +questions. Set the department and public contact details where +relevant. +
- For a handoff, enter the designated HTTPS Destination +URL and clear Destination label. Addresses +containing credentials and non-HTTPS schemes are rejected. The resident +sees the destination host. This field is a link, not a vendor connector +or new portal transaction. Verify it against the city’s authorized +service before use. +
- Page kinds determine icons and shared links.
records, +permits,code,planningand +contactare resident service entries. +governmentsupplies the government navigation link; +privacyandaccessibilitysupply +footer/utility links. Only live, public pages appear. Use Wagtail’s +existing editor submission and moderator approval workflow; editing a +draft does not update public pages.
+ - Review the public home, service page and phone layout after +publishing. Unpublishing or restricting a page removes it from +navigation, the task finder and title search. Configure city-approved +privacy, accessibility and contact content; the fictional +demonstration’s notices are examples, not an adopted city’s +policies. +
setup_demo creates the fictional Juniper
+Falls homepage and eight information pages on a fresh portal.
+The persistent synthetic notice is controlled by the home page’s
+Synthetic demo field. Example service destinations use
+reserved .example domains and do not operate real services.
+Repeating the command preserves any existing Townlight home and its
+editorial content; it does not replace a city’s website. Existing
+deployments receive additive fields through migrate; no
+existing text is overwritten. Configure their home and service pages
+through Wagtail after migration.
No resident account framework, official fee calculation, payment +processor, live-stream host or new vendor integration is introduced by +this interface.
+Deployment and setup
+The portal is a separate Wagtail deployment with its own database. +Keep the native desktop runtime bound to loopback; do not expose it to +the internet. Arrange a trusted private connection between the portal +service and native runtime. The bridge accepts HTTPS origins or loopback +HTTP origins; it does not follow redirects or use environment proxies. +Restrict the server-side proof file to the portal service account and +provision a native principal with both Meetings and Records permissions. +Never put the proof in a browser, selection file, log or public +document.
+From the portal directory, use Python 3.13, install
+python -m pip install --require-hashes -r requirements.lock,
+run python manage.py migrate,
+python manage.py setup_demo, and
+python manage.py createsuperuser. For local evaluation run
+python manage.py runserver 127.0.0.1:8000. Set a unique
+TOWNLIGHT_SECRET_KEY, TOWNLIGHT_DEBUG=0,
+allowed hosts, TLS and appropriate static and media service before
+deployment. TOWNLIGHT_DB selects the database path;
+TOWNLIGHT_BRAND selects the site name. Protect the database
+and the private release directory together.
+TOWNLIGHT_RELEASE_ROOT is an absolute private directory
+outside public media; by default it is private-releases
+under the portal directory. These setup steps do not commission a hosted
+site or alter the already released installer.
Set TOWNLIGHT_NATIVE_ORIGIN to the trusted native origin
+and TOWNLIGHT_NATIVE_PROOF_FILE to an absolute private
+proof-file path. Sign in to the active native desktop with an account
+authorized for both modules. The active profile’s
+config/local-session.json contains
+session_hash; this is an active session proof, not a
+durable service token. Copy it without displaying it into an absolute
+file in a directory already restricted to the portal service account.
+Replace both placeholders in this PowerShell command with the actual
+private paths:
[System.IO.File]::WriteAllText('<protected-absolute-path>\portal-proof.txt', (Get-Content -LiteralPath '<active-profile>\config\local-session.json' -Raw | ConvertFrom-Json).session_hash, [System.Text.UTF8Encoding]::new($false))Refresh the protected proof after session expiry, sign-out, account
+change or credential change. Do not print or publish it.
+TOWNLIGHT_DISPLAY_TIMEZONE is an IANA time zone, defaulting
+to UTC. A private selection file can drive the same
+operation from the portal directory:
{"action":"publish","approve_publication":true,"archive_id":"00000000-0000-4000-8000-000000000001","meeting_id":"00000000-0000-4000-8000-000000000002","recording_id":"00000000-0000-4000-8000-000000000003","request_id":"00000000-0000-4000-8000-000000000004","release_copy_id":"00000000-0000-4000-8000-000000000005","expected_release_sha256":"0000000000000000000000000000000000000000000000000000000000000000"}These IDs and hash are placeholders. Run
+python manage.py sync_townlight selection.json. For
+withdrawal change action to withdraw, retain
+the selection fields and explicit approval, and verify removal. Restrict
+the selection file because it contains internal identifiers.
Prepare the candidate +native runtime
+The existing signed installer predates the portal bridge and does not +include its native endpoints. Prepare a separate matching native runtime +with the compatible Records, Meetings, Core, Access and Notice +dependencies, normal activation, profile and database contracts. Do not +patch the installed host runtime. From the suite source root, build the +candidate wheel into a chosen output directory:
+python -m pip wheel --no-deps --wheel-dir '<wheel-output>' desktop/runtime/python-servicesIn the separately prepared matching runtime, use its Python
+executable to install the built
+townlight_runtime-0.2.0-py3-none-any.whl with
+python -m pip install --no-deps --force-reinstall '<wheel-output>\townlight_runtime-0.2.0-py3-none-any.whl'.
+Preserve the intended profile, activation and database configuration;
+use meetings-beta or a higher applicable product profile.
+With that runtime’s Python, start
+python -m townlight_runtime.services; it binds
+127.0.0.1:15480 by default, or the port selected by
+TOWNLIGHT_RUNTIME_PORT. Keep this private and provide the
+portal’s server-side active proof and trusted origin as described above.
+Verify the authenticated selections endpoint with a real eligible
+request in the prepared environment before relying on publication. See
+verification and test inputs for the
+isolated acceptance runner and its explicit flags. These instructions do
+not upgrade the old installer or establish installed or public
+deployment acceptance.
Production service and +reverse proxy
+runserver is for local demonstration only. For
+deployment set TOWNLIGHT_DEBUG=0, a unique
+TOWNLIGHT_SECRET_KEY of at least 50 characters,
+TOWNLIGHT_ALLOWED_HOSTS to the canonical host,
+TOWNLIGHT_BASE_URL to the HTTPS origin,
+TOWNLIGHT_CSRF_TRUSTED_ORIGINS to that HTTPS origin, and
+TOWNLIGHT_STATIC_ROOT to the private deployment’s
+collected-static directory. Run python manage.py migrate,
+then python manage.py collectstatic, and start
+python serve.py --port 8000 under a supervised service
+account. Waitress binds only 127.0.0.1; stop the supervised
+service cleanly before backup or maintenance. In production Django
+enables secure cookies, HTTPS redirect and HSTS.
Terminate TLS in a reverse proxy on the same host. Set
+TOWNLIGHT_TRUST_TLS_PROXY=1 only when the proxy removes
+client-supplied forwarded headers and sets its own HTTPS scheme and
+canonical Host. Never expose the native desktop port. Replace the
+example hostname, certificate and static directory with deployment
+values; serve only collected static files directly. The application
+handles all other routes, including approved release files:
server {
+ listen 443 ssl;
+ server_name town.example.gov;
+ ssl_certificate /etc/ssl/town/fullchain.pem;
+ ssl_certificate_key /etc/ssl/town/privkey.pem;
+ location /static/ { alias /srv/townlight/static/; }
+ location /media/images/ { alias /srv/townlight/media/images/; }
+ location / {
+ proxy_pass http://127.0.0.1:8000;
+ proxy_set_header Host town.example.gov;
+ proxy_set_header X-Forwarded-Proto https;
+ proxy_set_header X-Forwarded-For "";
+ proxy_set_header X-Forwarded-Host "";
+ proxy_set_header Forwarded "";
+ }
+}Keep the release directory outside every public static or media +alias. Test the deployed HTTPS origin, admin, archive, range playback +and explicit withdrawal using an approved synthetic record before +use.
+TOWNLIGHT_MEDIA_ROOT selects Wagtail’s uploaded-media
+storage (default portal/media). The image alias above
+serves generated branding renditions from that root’s
+images directory. Set the actual path for the deployment.
+Do not alias the entire media root: Wagtail document downloads may have
+their own access restrictions, and private releases must never be placed
+there. Back up the full media root privately, including originals, with
+the database.
Architecture and API
+
+
+The server calls POST /desktop/v1/portal/bundle with the
+selection JSON and the X-Townlight-Session header. The
+native principal must have both townlight_meetings and
+townlight_records permissions. The returned ZIP contains
+manifest.json and, for publication,
+release.bin; the portal validates identity, hashes, sizes
+and allowable fields before an atomic update. Withdrawal carries a
+manifest without release bytes. The public projection includes meeting
+text and ID/hash provenance, not the private source payload. The bridge
+streams bundles and release bytes through private files. Set
+TOWNLIGHT_PORTAL_MAX_BYTES consistently on both services;
+the default is 8 GiB and the maximum is 64 GiB. Allow private disk space
+for the bundle, staged copy and retained releases. The portal serves MP4
+or octet-stream releases. This transport limit is not the end-to-end
+recording limit: the inherited Records managed-file receipt limits both
+originals and release copies to 2,147,483,647 bytes. At Station’s
+default 6,000 kbps video rate, approximately 47 minutes reaches 2 GiB
+before accounting for audio and container overhead. Plan capture
+duration and bitrate before recording: for example, 2,000 kbps video
+plus audio for two hours is roughly 1.9 GB, depending on actual rates
+and overhead. Measure the resulting files and leave margin. The portal
+does not automatically transcode recordings. Consult the checked-in
+bridge and portal source for the exact contract and errors; do not log
+session proofs.
python manage.py export_public <empty-directory>
+exports published pages, metadata and approved release bytes with
+hashes. Secure the export as appropriate. Stop the portal and any
+synchronization before taking a consistent backup of the SQLite database
+and private release directory together; preserve private configuration
+and proof separately. Restore the matched database and releases to an
+isolated environment, set permissions and paths, then verify public
+pages, approved file hashes and withdrawal state before resuming
+service. A failed source sync preserves the prior projection;
+investigate permissions, source eligibility, IDs, expected hash,
+connection and proof-file access before retrying. An explicit withdrawal
+is necessary to remove a previously published item.
The export also includes city branding fields, all published service +guidance, destinations, contact details, question/answer blocks and the +original uploaded logo/hero files referenced by the published home, with +hashes. It excludes draft/restricted page content and unreferenced +uploads. Back up Wagtail’s media directory with its database as well as +the private approved releases; city-uploaded branding is stored in media +and its generated renditions must be served by the deployment. The +public export is a portable content bundle, not a replacement for a +consistent full backup or a one-command restore.
+Public presentation routes
+| Route | +Behavior and example | +
|---|---|
GET / |
+City home, live/public service navigation and latest published +playable recording | +
GET /find-service/?service=meetings |
+Task finder redirects to the archive; a numeric ID selects a +live/public service under this site’s home; arbitrary redirect +destinations are refused | +
GET /meetings/?period=past&q=Council&series=Council%20Meeting&page=1 |
+Published-title filters; period is
+upcoming, past or all; series
+matches a full public title; pages contain at most 20 results |
+
GET /meetings/<pk>/ |
+Published meeting and available public materials; unpublished +identity returns 404 | +
GET /meetings/<pk>/documents/agenda/ |
+Approved native agenda text; packet and
+minutes select the other approved text documents;
+unavailable, cancelled, non-native or unpublished material returns
+404 |
+
GET /meetings/<pk>/release/ |
+Existing integrity-checked approved release route with byte ranges; +publication status is checked on every request | +
GET /search/?q=records |
+Live/public service title and published meeting title search; no +private or external search | +
GET /<service-slug>/ |
+Wagtail-published guidance and any configured service handoff | +
GET /source/ |
+Allowlisted corresponding portal source, including deployed CSS, +JavaScript, SVG illustrations, templates and native bridge source when +present | +
These resident routes create no records or accounts. The private +native API and explicit publication approval contract below are +unchanged. There is no new portal MCP endpoint.
+Editable data and +presentation specifications
+| Model | +Additional presentation fields | +
|---|---|
| HomePage | +Brand name (120 characters), prefix (40), hero title (160), +introduction, address, hours, synthetic notice flag and optional Wagtail +logo/hero image references | +
| ServicePage | +Kind (20), summary (300), heading (180), body and next-step text, +destination URL and label (120), department (120), public contact text +and Wagtail question/answer blocks | +
| Meeting | +Existing public identity, timestamps/time zone, +cancellation/publication status, agenda/document projection and approved +release/provenance fields; no invented board metadata | +
The layouts reuse the approved civic navy/teal, warm white and gold
+design with local fonts and original local illustrations. CSS and a
+small menu script ship in portal/website/static/website/;
+there are no remote fonts, analytics or client-side vendor calls.
+Existing Wagtail permissions, revisions, media storage and static
+collection are reused. Focus styles, skip navigation, semantic headings,
+phone layouts, reduced-motion handling and printable document styling
+are included. Accessible source material, captions/transcripts where
+applicable and the adopting city’s assistance contact remain part of its
+content responsibilities; no accessibility certification is claimed.
Bundle contract and errors
+For discovery, the trusted portal server can call
+GET /desktop/v1/portal/selections?request_id=<UUID>
+with X-Townlight-Session. The native actor must have both
+module permissions. The JSON response is
+{"selections":[{"title":"<public archive title>","selection":{...}}]};
+each selection has all publication request fields, with
+action set to publish and
+approve_publication set to false. The Wagtail
+lookup uses this endpoint. Selecting a result supplies
+request_id, release_copy_id and
+archive_id as query parameters and fills the form without
+granting approval. An empty list means no eligible choice was returned;
+review source readiness and the request.
The JSON request requires action (publish
+or withdraw), boolean approve_publication set
+to true, UUIDs archive_id,
+meeting_id, recording_id,
+request_id, release_copy_id, and a
+64-character lowercase expected_release_sha256. No extra
+request fields are accepted. Send it only from the trusted portal server
+with X-Townlight-Session containing its private session
+proof. For example, the supported operator command
+python manage.py sync_townlight selection.json reads the
+selection illustrated above and supplies that header from the protected
+proof file.
A successful publish returns application/zip with
+manifest.json and release.bin. Manifest
+version 1 contains version, action,
+archive_id, meeting_id,
+recording_id, request_id,
+release_copy_id, original_sha256,
+title, timezone-aware scheduled_start,
+agenda, packet, minutes,
+summary, and release. The release
+object contains path (release.bin),
+sha256, size, and media_type.
+Withdrawal returns a ZIP containing only manifest.json with
+version, action and archive_id.
+The portal validates the selection, manifest and bytes before changing
+its projection.
Invalid input or missing explicit approval is rejected; authorization
+failures are rejected by the native identity layer. Unavailable or
+changed source data produces HTTP 409 with
+Publication sources unavailable or changed; the portal
+command reports synchronization failure and retains the existing
+publication. Resolve the underlying staff-side source, identity, hash or
+connectivity issue before retrying. Do not publish error logs containing
+proof or private source details.
Source, license and +demonstration data
+The synthetic PrimeGov transport is for demonstration and does not
+contact a real tenant. Townlight-owned portal code is AGPL-3.0-only;
+vendored CivicCast code retains its Apache-2.0 notices.
+/source/ offers allowlisted portal source and the native
+bridge from a repository checkout. Operators must provide the exact
+deployed corresponding source, modifications and dependencies as
+required by their license obligations. See the repository licenses,
+portal/UPSTREAM.md, and the existing terms and license; no city-specific
+legal terms are supplied here.
Subject index
+-
+
- Approval and selection: For staff: prepare and publish +
- Database and recovery: Deployment and setup; Architecture and +API +
- Proof and permissions: Deployment and setup; Architecture and +API +
- Resident pages and file: Residents +
- Branding and city service guidance: City editors: branding and +service content +
- Search, filtering and document routes: Public presentation +routes +
- Data fields and responsive design: Editable data and presentation +specifications +
- Source and license: Source, license and demonstration data +
- Withdrawal: For staff: prepare and publish; Architecture and +API +
Rebuild this guide
+From the suite repository root, install the repository’s Node
+dependencies (including Playwright), install a Playwright Chromium
+browser and make Python and Pandoc available on PATH. Run
+node scripts/docs/build_portal_guide.cjs. This rebuilds the
+portal guide HTML, editable Word, PDF and architecture PNG, and the
+portal verification reference HTML, from the checked-in Markdown, SVG,
+template and Word reference. To use an existing Playwright installation
+or Chromium executable, set PLAYWRIGHT_MODULE or
+CHROMIUM_EXECUTABLE; PYTHON selects a Python
+executable. The sibling product repositories are not needed to rebuild
+this
+guide.
Townlight Beta 1
Townlight -Zoning -README
Staff guide and technical reference
Townlight Beta -1 · Existing component versions retained · AGPL-3.0-only
-Zoning combines local parcel geometry, cited zoning rules and staff -review. It retains questions, corrections and snapshots with provenance -so downstream staff can identify the precise evidence used.
-Start here
-Staff should use the operating manual. Administrators should read -first-run, configuration and recovery before changing a deployment. -Developers should read the exact API/schema reference and matching -source companion. This is a private candidate documentation update; it -neither changes public downloads nor publishes a release.
--
-
- Operating manual · Printable PDF · Editable Word -manual -
- API and data dictionary · OpenAPI JSON -
- Product and suite directory · Terms and full license -
Exact version and candidate
-| Identity | -Value | -
|---|---|
| Public documentation identity | -Townlight Beta 1 | -
| Installer version | -1.6.0.1 | -
| Product component | -townlight_zoning 0.2.2 | -
| Native desktop source version | -1.6.0-1 | -
| Candidate MSI SHA256 | -98bcdef11ebdf5c767f620c904ff49f85115fde3b5c23f62703b111e645aaf86 |
-
| Corresponding-source SHA256 | -84a23e1297e42d17b16cfc9e51b2dd78bc46414c0de8ad7ebd2466c1a409d06b |
-
| Current owned software license | -AGPL-3.0-only | -
| Supported acceptance profile | -Windows x64 fresh install; inspections-preview; separate Station -configuration | -
“Townlight Beta 1” identifies this coordinated beta delivery. It does -not renumber the installer, native binary, Python packages or historical -receipts. Component versions may differ. This documentation is a later -companion to unchanged signed bytes, not a rebuilt installer. Historical -release pages and manuals describe their own versions and are not the -download instructions for this private candidate.
-What staff can do
--
-
- Prepare parcel data: Use the complete supported -bundle, including jurisdiction, dataset metadata and original hashes. -The coordinates must be EPSG:4326. A loose geometry file is not the full -source envelope. -
- Import and inspect: Check the complete source -envelope before selecting Import parcel dataset. That control submits -directly; inspect the saved validation/provenance result afterward. -Correct a refused source bundle and preserve the evidence. Do not force -acceptance by editing SQL. -
- Register cited rules: Associate the zone, rule -kind/key and value with the relevant public Code section. Inspect -overlays and effective context. Leave missing authority visible for -planner review. -
- Ask a parcel question: Look up the intended parcel -and ask the supported question. Read the returned citation, -applicability and disclaimer. Do not present an uncertain answer as an -official decision. -
- Record review and context: Record a correction and -its reason when needed. Select permitted Meetings history explicitly. -Preserve the question/review history and distinguish staff-only -precedent from public material. -
- Create a snapshot: Review the audience and exact -content before creating the immutable snapshot. A public snapshot must -satisfy its permitted-source contract; choosing a public label does not -sanitize private notes. -
- Use it downstream: Select the exact snapshot for -Records or the permitted provider path. The receiving workflow rechecks -visibility, source identity and hash before retaining or exporting -it. -
Operating procedures and -examples
-The operating manual now includes these existing procedures, with -synthetic inputs, readback and limits. Follow the actual app boundary -identified there; a standalone source capability is not automatically a -desktop screen.
--
-
- Discretionary -processes and staff review. -
- Explain -the cited process. -
- Keep -parcel import and inspection in the right order. -
- Use -the existing specialist review contracts. -
Architecture and data
-Runtime and storage
-The accepted package targets Windows x64 fresh -installation. Its native shell uses Rust 2021, Tauri 2 -and Microsoft WebView2; browser assets are JavaScript built -with Vite 8.1.6. This describes the native desktop -frontend; Station has a separate React operator, specified below or in -its product manual. Canonical business workflows use bundled -CPython 3.13.5, FastAPI, Pydantic, SQLAlchemy and -Alembic, with PostgreSQL 17 / PostGIS and -managed original files. The installed runtime tested here contains -FastAPI 0.162.0. Package minimum Python requirements can differ from the -bundled executable; the metadata reference preserves both. No stack -rewrite is implied by the beta label.
-The native transport is fixed to loopback
-127.0.0.1:15480; PostgreSQL uses the configured local
-runtime port (default 15432). Optional local model service
-defaults to 127.0.0.1:15434. Those are deployment defaults,
-not internet endpoints. The runtime has health, module and readiness
-endpoints; readiness is stronger than process existence. The task queue
-is the existing local Core task infrastructure, not an assertion that a
-separate Redis service is required for this desktop composition.
The default native profile is %LOCALAPPDATA%\CivicSuite;
-the historical directory name remains part of compatibility. Do not
-rename it to Townlight. A configured TOWNLIGHT_PROFILE_ROOT
-must be absolute. Local configuration and secrets live under that
-profile; protected managed files and database state must be backed up
-coherently. Source/runtime identity is distinct from a product’s display
-label.
Data and consistency
-GeoJSON import datasets; parcels and zone/overlay context; cited -rules; questions and answers; review events; selected Meetings history; -immutable snapshots.
-Versioned saves use expected prior revision identifiers where -defined. Reopen and reconcile on conflict. Exact exports and handoffs -use source IDs, current visibility, revision and SHA256. Review belongs -to the saved revision and does not transfer silently to edited text. -Database changes use the owning product’s migrations; a request or -readiness check is not an authorization to mutate schema.
-Capacity and platform -statements
-This beta has synthetic single-profile workflow evidence. It does not -have a published benchmark for concurrent staff capacity, minimum -RAM/CPU, large-source limits or a field SLA. Do not turn a developer -machine’s specification into a supported minimum. Installer size is -2,092,122,112 bytes before installation; allow additional disk for -extracted runtime, database, originals, exports, media and backups. -Select equipment/storage after sizing those actual workloads.
-The exact runtime -payload lock records pinned files, sizes and hashes. The component metadata -records shipped dependency declarations. These references are more -precise than a manually copied dependency list. Third-party and -historical license notices must accompany their matching payloads.
-| Data contract | -Description | -
|---|---|
| Input | -A supported EPSG:4326 GeoJSON envelope, jurisdiction and dataset -metadata, public Code authority and permitted meeting evidence. | -
| Retained records | -GeoJSON import datasets; parcels and zone/overlay context; cited -rules; questions and answers; review events; selected Meetings history; -immutable snapshots. | -
| Output | -Source-backed parcel context, informational answers, recorded human -corrections and reviewed snapshots with stable hashes. | -
| Connections | -Consumes Code authority and permitted Meetings evidence. Supplies -permitted snapshots to Records and context to Planning and -Permitting. | -
Setup and operation
--
-
- Obtain the identified signed private candidate and its -corresponding-source companion from the beta coordinator. The landing -pages in this documentation are not an installer download service. -
- On the intended fresh Windows test installation, verify the MSI hash -and publisher signature before installing. Preserve unrelated profiles -and recovery material. This candidate has fresh-install acceptance; -historical in-place upgrades are unverified. -
- Launch Townlight under the intended named Windows account. Choose
-the storage folders. Select Townlight Inspections
-candidate (
inspections-preview) for all eight -desktop products. A narrower default selection will not expose all -workspaces.
- - Enter the city profile, time zone and contacts. Create the first -named local administrator, sign in and choose protected backup storage. -Continue without local AI is valid for the -deterministic workflows. -
- Run Health Check and wait for readiness. Open Townlight. In System -Health select Finish Records Migration to activate the -canonical Python/PostgreSQL runtime. Do not fabricate migration receipts -or seed accounts. -
- Create named staff through Settings. Import authorized sources using -each product’s source library. All examples in this package are -synthetic; they are not municipal authority. -
- Provision Station separately if it is part of the beta exercise. -Selecting the desktop composition does not start or configure Station. -Configure vision explicitly only if automatic photo drafting is -selected. -
Configuration
-Native deployment -configuration
-Use Setup, Settings and System Health for supported staff operation.
-Administrators provision folders, backup storage, named accounts and the
-city profile. Select inspections-preview for the full
-eight-workspace desktop. Station remains a separate service boundary. Do
-not use a standalone product’s demo server as a substitute for the
-installed workspace.
Technical deployments use TOWNLIGHT_PRODUCT_PROFILE,
-TOWNLIGHT_PROFILE_ROOT, DATABASE_URL,
-TOWNLIGHT_RUNTIME_PORT, PORTAL_MODE and the
-runtime-managed secret files. Treat database URLs and native session
-proofs as secrets. The installed native domain runtime explicitly
-refuses non-loopback binding. PORTAL_MODE=private is the
-accepted posture; changing it does not by itself commission an internet
-portal, authentication provider or reverse proxy.
The isolated documentation exporter sets a fictional profile and -unusable synthetic database origin only to read schemas; those values -are not deployment configuration. Keep deployment values in the intended -process/account scope. An already-running process does not automatically -inherit later environment edits.
-API usage
-Native command example
-The following JavaScript belongs in the existing trusted Townlight
-frontend/development environment with invoke imported from
-@tauri-apps/api/core. It is not a command for an arbitrary
-web page or an instruction for nontechnical staff. IDs must come from
-records created in an isolated synthetic exercise.
import { invoke } from '@tauri-apps/api/core';
-const result = await invoke('zoning_domain_request', {request: {operation: 'history', id: questionId}});
-console.log(result);Trusted local HTTP example
-An administrator/developer can inspect an already-configured isolated -runtime from a trusted local process. This PowerShell example reads the -signed-in synthetic profile’s existing proof into memory; it does not -create a user, seed a session, reveal the proof in output or bypass a -permission check. Do not use real city data in development examples. A -read response does not prove approval or publication.
-$profilePath = Join-Path $env:LOCALAPPDATA 'Townlight'
-$sessionPath = Join-Path $profilePath 'config\local-session.json'
-$session = Get-Content -LiteralPath $sessionPath -Raw | ConvertFrom-Json
-$headers = @{ 'X-Townlight-Session' = $session.session_hash }
-Invoke-RestMethod -Uri 'http://127.0.0.1:15480/desktop/v1/zoning/workspace' -Headers $headers
-Remove-Variable session, headersComplete synthetic source -bundle
-The synthetic Zoning
-bundle is the retained fixture used by the beta staff exercise. It
-includes the complete supported source envelope rather than a shortened
-pseudo-payload. Keep its fictional source labels. For Planning, wrap it
-as {"bundle": BUNDLE, "expected_previous_revision": null};
-for Permitting use
-{"bundle": BUNDLE, "expected_revision": null}. Code and
-Zoning take their own complete import envelopes. Replace null with the
-current expected revision when revising an existing source, as the
-applicable schema requires. These are import examples, not legal
-authority or permission to load them into a live city profile.
A synthetic write -with subsequent readback
-This example demonstrates the existing Meetings HTTP contract in an -isolated exercise. It is intentionally fictional. It does not start a -service. Its authentication setup is included so it can be run -independently under the signed-in synthetic account. If a write times -out, inspect current records before repeating it.
-$profilePath = Join-Path $env:LOCALAPPDATA 'Townlight'
-$sessionPath = Join-Path $profilePath 'config/local-session.json'
-$session = Get-Content -LiteralPath $sessionPath -Raw | ConvertFrom-Json
-$headers = @{ 'X-Townlight-Session' = $session.session_hash }
-$body = @{
- title = 'Synthetic documentation exercise'
- scheduled_start = '2026-11-05T18:00:00-07:00'
- location = 'Synthetic room'
- meeting_type = 'regular'
-} | ConvertTo-Json
-$meeting = Invoke-RestMethod -Method Post `
- -Uri 'http://127.0.0.1:15480/desktop/v1/meetings/meetings' `
- -Headers $headers -ContentType 'application/json' -Body $body
-Invoke-RestMethod `
- -Uri ('http://127.0.0.1:15480/desktop/v1/meetings/meetings/' + $meeting.id) `
- -Headers $headers
-Remove-Variable session, headersThis write requires Meetings to be enabled and the signed-in staff -role to permit it. It is a cross-suite integration example; for this -product’s request models, use the complete technical reference -below.
-MCP status
-No direct product MCP server is exposed by the accepted Townlight
-desktop or Station boundary. Do not configure an invented
-townlight mcp command or assume an AI client has staff
-permissions. The integration surfaces for this beta are native IPC, the
-documented HTTP APIs, source bundle imports, exact exports and the
-existing Station CLI.
The bundled transcription code includes a TextFlowKit MCP
-adapter as a separate source capability. It offers job-based
-transcribe_media, get_transcript,
-list_jobs, get_job_status and
-export_transcript, and additional tools declared in that
-adapter. It uses stdio first and optional Streamable HTTP, with the MCP
-SDK as an optional extra. It is not automatically launched,
-authenticated as Townlight staff or accepted as a Townlight product MCP
-deployment. This documentation does not add such a service.
For a transcription client already provisioned separately, an -illustrative tool call is:
-{"name":"get_job_status","arguments":{"job_id":"synthetic-existing-job-id"}}Use a job ID returned by that transcription service. This example -does not create a Townlight record or bypass its review/Records handoff. -The exact optional adapter tool signatures are supplied in the MCP source reference. Station meeting -capture does not become live speech recognition because this optional -donor adapter exists.
-Verification and known -limits
-| Product | -Recorded result | -Precisely exercised | -
|---|---|---|
| Zoning | -PASS | -GeoJSON/PostGIS import, cited dimensional rule, parcel answer, staff -review/history/snapshot and native workspace. | -
These results come from the identified signed candidate’s fresh -normal-profile Sandbox exercise: real native IPC/HTTP/PostgreSQL and -selected headless controls. All accounts, source bundles and media were -synthetic. The guest install/uninstall and recovery passed, and the -owned Sandbox stopped. No host installed application or standalone -CivicCast was changed. This documentation task reuses those receipts; it -does not claim a new software acceptance run.
-The workflow matrix -identifies raw receipt filenames. The evidence index -retains their original hashes; raw receipts remain in the private beta -handoff rather than being silently republished with the documentation -site.
-The limits remain: actual city field acceptance and equipment/network -commissioning; Station automatic provisioning/SCM commissioning; every -UI/role combination; field recognition accuracy; and historical in-place -upgrades are not certified. They are not five invented feature -requirements. Fresh-install controlled beta handoff remains the accepted -scope. This package makes no city-deployment, publication or -general-availability claim.
-The accepted path is local GeoJSON/PostGIS. It does not establish -every ArcGIS, assessor or CKAN connector. Answers and process -explanations are informational and do not issue an entitlement or an -official zoning determination.
-Development and repository -map
-Use the corresponding source for the candidate rather than assuming
-the public default branch matches it. The source companion contains
-installed-owned-source, product build inputs, desktop
-Rust/browser sources, locks and BUILD.md. It excludes
-credentials and third-party binary/model payloads. Use the recorded
-runtime lock when reproducing packaging.
Relevant source contracts:
--
-
townlight_zoning/geo_import.py
-townlight_zoning/discretionary.py
-townlight_runtime/zoning_bridge.py
-townlight_runtime/zoning_records.py
-
The desktop package defines npm run build,
-npm test, npm run test:browser and its Tauri
-command. Python products retain their own pyproject.toml,
-tests and migrations; use the matching checkout’s declared dependencies
-and test configuration. Do not run a sample server against a production
-profile. This documentation build validates documentation only and
-reuses the separately identified installed acceptance; it does not claim
-a new complete application CI run.
Recovery and support
-Save work and use Core’s canonical Backup Now before -maintenance. That operation stops writers. Preserve the coherent -profile/database/document backup and its receipt, then use -Start to resume. A source export is not a full -backup.
-Use Restore Latest Backup through the supported -controls. If the result says Restore needs service -start, use Start, then Check, -and reopen a known record. Do not repeat restore merely because services -need to start. The fresh-profile acceptance verified that a fulfilled -request survived restore and a post-backup marker did not.
-Keep Station’s dedicated database and media evidence together in its -own backup. Core’s native-profile backup must not be assumed to include -an external Station data directory. Stop writers during a coordinated -backup. Preserve failed media attempts and logs.
-On failure, record the time, selected composition, -component/installer versions and exact message. Check System Health for -stopped, starting, ready or failed dependencies. Use the existing Retry -control after readiness; do not create duplicate business records to -refresh a stale view. Share only a redacted diagnostic bundle. Preserve -secrets, original evidence, recovery material and unrelated -installations.
-License and responsible use
-Current owned code is AGPL-3.0-only. Preserve full license, matching -corresponding source, dependency notices and historical grants. Terms of -use do not remove license rights. Source imports do not confer -permission to publish third-party material. Review all automatic drafts -and use the separate owning-product decision before official action. -CivicCast remains -independent.
Townlight Zoning documentation
Read the current Zoning manual for the Windows x64 beta 1.7.0.1.
See component versions and release evidence for exact installed versions.
Current candidate technical reference
Prepared November 2, 2026. Build, signing, exact installed acceptance and publication remain pending.
The API pages describe the actual native composition; standalone applications and the separate Station service have their documented boundaries.
Complete native domain API · Current source inventory and SHA-256 values · Component versions
| Product | Contract | Inventory |
|---|---|---|
| Townlight Core | API reference | 114 source files |
| Townlight Records | API reference | 126 source files |
| Townlight Meetings | API reference | 59 source files |
| Townlight Code | API reference | 49 source files |
| Townlight Zoning | API reference | 30 source files |
| Townlight Planning | API reference | 31 source files |
| Townlight Permitting | API reference | 18 source files |
| Townlight Inspections | API reference | 20 source files |
| Townlight Access | API reference | 10 source files |
| Townlight Notice | API reference | 16 source files |
| Townlight Station | API reference | 21 source files |
| Townlight Runtime | API reference | 101 source files |
AST route declarations alone do not prove mounting or runtime behavior. The inventory marks source companion assembly as pending until an actual built companion is supplied; it makes no signed-installer claim.
Windows beta technical reference
The signed Windows x64 beta 1.7.0.1 passed the documented fresh Windows Sandbox checks with synthetic data. See the Windows acceptance summary.
The API pages describe the actual native composition; standalone applications and the separate Station service have their documented boundaries.
Complete native domain API · Windows release source pins and archive hashes · Component versions
| Product | Contract | Inventory |
|---|---|---|
| Townlight Core | API reference | 114 source files |
| Townlight Records | API reference | 126 source files |
| Townlight Meetings | API reference | 59 source files |
| Townlight Code | API reference | 49 source files |
| Townlight Zoning | API reference | 30 source files |
| Townlight Planning | API reference | 31 source files |
| Townlight Permitting | API reference | 18 source files |
| Townlight Inspections | API reference | 20 source files |
| Townlight Access | API reference | 10 source files |
| Townlight Notice | API reference | 16 source files |
| Townlight Station | API reference | 21 source files |
| Townlight Runtime | API reference | 101 source files |
The corresponding source archive and its repository pins identify the released Windows build. The earlier source inventory documents a preparation snapshot. Source declarations describe contracts. The Windows acceptance summary records installed behavior.
The resident portal is deployed separately. See the Townlight Portal Guide for its workflow and acceptance limits.
Townlight Beta 1
MCP
+Skip to contenttownlightTownlight Beta 1
+Historical MCP reference for Windows 1.6.0.1. For Windows 1.7.0.1, use the matching source archive and technical reference index.
Townlight Beta 1MCP
and Transcription Source
Reference
Staff guide and technical reference
Historical MCP reference for Windows 1.6.0.1. For Windows 1.7.0.1, use the matching source archive and technical reference index.
Townlight Beta 1
MCP and Transcription Source Reference
Staff guide and technical reference