Update documentation for parasha topic calendar endpoint

[saengel]

Description

The calendars/topics/parasha endpoint has a diaspora parameter that was not documented. This PR adds it to the OpenAPI.json file so it will populate on the interactive API reference.

Code Changes

• Adding documentation to the right place in the OpenAPI.json file
• Fixing an outdated comment in the push pipeline

Notes

• Current docs (missing the diaspora param) - https://developers.sefaria.org/reference/get-calendar-parasha-topic
• Code confirming the diaspora param -

  Sefaria-Project/reader/views.py

  Line 2898 in ce3aaab

  def parasha_data_api(request):

[gitvelocity-reviewer]

📊 Code Quality Score: 3/100

11 × 0.25 = 2.75, rounded to 3

Category	Score	Factors
🔭 Scope	3/20	Two files modified: readme-openapi-docs-sync.yml (one comment line) and docs/openAPI.json (one new parameter block). Both are documentation and configuration artifacts; no production source files are touched.
🏗️ Architecture	1/20	No module boundary changed. The workflow trigger branch was already prod; only the inline comment is updated. The OpenAPI spec gains one parameter entry under an existing endpoint definition.
⚙️ Implementation	2/20	The diaspora parameter block in openAPI.json follows the existing OpenAPI 3.x pattern: name, description, schema with type: integer, enum: [0, 1], default: 1, in: query, and required: false. No branching logic or algorithmic work is present.
⚠️ Risk	2/20	The workflow comment change carries no operational risk. The OpenAPI spec addition is not executable, but if the documented default (1) does not match the server-side default for the parasha endpoint, API consumers reading the generated ReadMe.io docs will receive incorrect guidance.
✅ Quality	3/15	No tests apply to these file types. The parameter definition is complete per OpenAPI 3.x conventions. No example field is included, which ReadMe.io renders prominently in generated docs.
🔒 Perf / Security	0/5	No performance or security work is present in this diff.

Was this score accurate? 👍 Yes · 👎 No

How this was scored →

_{Scored by GitVelocity · How are scores calculated?}

[Copilot]

🟡 Changes recommended

The new OpenAPI parameter schema is inconsistent with existing diaspora parameter typing in the same spec (string vs integer), which can break client generation/validation.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

Updates the public OpenAPI specification so the interactive API reference correctly documents the diaspora query parameter supported by GET /api/calendars/topics/parasha, and corrects a misleading GitHub Actions workflow comment.

Changes:

• Added a diaspora query parameter to the OpenAPI entry for GET /api/calendars/topics/parasha.
• Updated the GitHub Actions workflow comment to reflect the actual prod branch trigger.

File summaries

File	Description
docs/openAPI.json	Documents the diaspora query parameter for the parasha topic calendar endpoint in the OpenAPI spec.
.github/workflows/readme-openapi-docs-sync.yml	Updates an outdated comment to match the workflow’s prod branch trigger.

Review details

• Files reviewed: 2/2 changed files
• Comments generated: 1
• Review effort level: Lite

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[gitvelocity-reviewer]

📊 Code Quality Score: 3/100

10 × 0.25 = 2.5, rounded to 3

Category	Score	Factors
🔭 Scope	3/20	Two files modified: .github/workflows/readme-openapi-docs-sync.yml (one comment line changed) and docs/openAPI.json (one parameter block added to one endpoint). Both changes are localized with no cross-subsystem reach.
🏗️ Architecture	1/20	No module boundary changed. The workflow branch trigger was already set to 'prod'; only the inline comment was inconsistent. The OpenAPI spec addition follows the existing parameter schema pattern already present in the file.
⚙️ Implementation	2/20	The diaspora parameter block in docs/openAPI.json uses the standard OpenAPI parameter structure with name, description, schema (type string, enum ['0','1'], default '1'), in: query, and required: false. No control flow or algorithmic logic is involved.
⚠️ Risk	2/20	The comment fix in the workflow carries no operational risk. The OpenAPI spec change documents an existing API behavior without altering backend logic; a misdescribed default or enum would mislead API consumers reading the published docs but would not affect runtime behavior.
✅ Quality	2/15	No test accompanies either change. The diaspora parameter description is specific about the Israel-vs-diaspora distinction and the default value. No automated validation of docs/openAPI.json schema correctness is present in the diff.
🔒 Perf / Security	0/5	No performance or security work is present in this diff.

Was this score accurate? 👍 Yes · 👎 No

How this was scored →

_{Scored by GitVelocity · How are scores calculated?}