refactor(api): fix sonar S1192 in snapshot endpoint

[Ontiomacer]

Proposed change

Resolves #3039

This PR fixes a SonarCloud code smell (rule python:S1192) in
backend/apps/api/rest/v0/snapshot.py by removing duplicated string literals
and extracting them into a shared constant.

Summary of changes

• Introduced a shared constant for the ordering field description
• Removed duplicated string literals
• Improved readability and maintainability
• Preserved existing behavior

Motivation

The duplicated literal was flagged by SonarCloud as a maintainability issue.
This refactor aligns the code with OWASP Nest quality standards and makes future
changes easier and safer.

Testing

• Verified module compiles successfully using python -m compileall
• Verified backend checks via make check-test
• Frontend formatting step failed due to missing pnpm in local environment

Checklist

• Required: I read and followed the contributing guidelines
• Required: I ran make check-test locally and all tests passed
• I used AI for code, documentation, or tests in this PR

[coderabbitai]

Summary by CodeRabbit

• Refactor
  • Improved internal code organization for API descriptions across multiple endpoints.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

Extracted the repeated string "Ordering field" into a new public constant ORDERING_FIELD_DESCRIPTION and replaced literal occurrences with that constant across Snapshot API query parameter definitions; no logic or behavior changes.

Changes

Cohort / File(s)	Summary
Snapshot API — constant extraction backend/apps/api/rest/v0/snapshot.py	Added ORDERING_FIELD_DESCRIPTION = "Ordering field" and replaced repeated literal "Ordering field" usages in query parameter description arguments for endpoints: list_snapshots, list_snapshot_chapters, list_snapshot_issues, list_snapshot_members, list_snapshot_projects, list_snapshot_releases.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

• kasya

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the main change: fixing SonarCloud rule S1192 by deduplicating string literals in the snapshot endpoint, which directly matches the changeset.
Description check	✅ Passed	The description is well-related to the changeset, explaining the removal of duplicated string literals and extraction into a shared constant, with motivation from SonarCloud compliance.
Linked Issues check	✅ Passed	The PR directly addresses issue #3039 by extracting the duplicated 'Ordering field' string literal into a shared constant (ORDERING_FIELD_DESCRIPTION) and replacing all occurrences, fully meeting the refactor-only objective.
Out of Scope Changes check	✅ Passed	All changes are in-scope: only the introduction of ORDERING_FIELD_DESCRIPTION constant and replacement of duplicated literals in snapshot.py, with no modifications to unrelated files or functionality.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5b2004c and 7521e8a.

📒 Files selected for processing (1)

• backend/apps/api/rest/v0/snapshot.py

🚧 Files skipped from review as they are similar to previous changes (1)

• backend/apps/api/rest/v0/snapshot.py

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Ontiomacer]

Hi @arkid15r @kasya

This PR addresses SonarCloud issue python:S1192 by extracting the duplicated ordering field description into a shared constant in snapshot.py.
Please let me know if you’d like me to split anything further or adjust the approach. Thanks for the review.

[arkid15r]

Why disabling this?

[Ontiomacer]

Thanks @arkid15r for pointing this out. It wasn’t intentional
I likely left the default unchecked when opening the PR.
I have enabled it now.

[Ontiomacer]

Branch is now up to date with main, and maintainer edits are enabled.
Let me know if you’d like me to adjust anything, or if I should wait for workflow approval.
@arkid15r @kasya

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud