Skip to content

Fix CDCS REST API compatibility with NexusLIMS-CDCS 3.20.x#92

Merged
jat255 merged 1 commit intomainfrom
update_cdcs_version
Mar 24, 2026
Merged

Fix CDCS REST API compatibility with NexusLIMS-CDCS 3.20.x#92
jat255 merged 1 commit intomainfrom
update_cdcs_version

Conversation

@jat255
Copy link
Copy Markdown
Contributor

@jat255 jat255 commented Mar 24, 2026

Closes #91

Summary

  • Add trailing slashes to all CDCS REST API endpoint URLs (cdcs.py, CDCSDestination, and integration tests), required by NexusLIMS-CDCS 3.20.x (Django APPEND_SLASH=True returns 500 on DELETE/PATCH without trailing slash)
  • Wrap legacy HyperSpy sig_to_thumbnail call in try/except to fall back to a placeholder image on failure rather than raising
  • Add docs/reference/compatibility.md with a NexusLIMS / NexusLIMS-CDCS version matrix and explanation of the -nx{n} tag format; cross-reference from the frontend guide overview, production, and configuration pages
  • Exclude macOS resource fork files (._*) from Sphinx doc builds to fix spurious toc.not_included warnings
  • Add changelog fragment 91.misc.md

Test plan

  • Unit test test_create_preview_hyperspy_sig_to_thumbnail_raises covers the new fallback path (lines 688-694 of extractors/__init__.py)
  • Integration tests updated to use trailing-slash endpoints — verify against a running NexusLIMS-CDCS 3.20.x instance
  • Docs build cleanly with no toc.not_included warnings for ._* files

…sion matrix

- Add trailing slashes to all CDCS REST API endpoint URLs in cdcs.py,
  CDCSDestination, and integration tests (required by NexusLIMS-CDCS 3.20.x)
- Wrap legacy HyperSpy sig_to_thumbnail call in try/except to fall back
  to placeholder image on failure; add test covering the new except branch
- Add docs/reference/compatibility.md with NexusLIMS / NexusLIMS-CDCS
  version compatibility matrix and explanation of the -nx{n} tag format
- Cross-reference the compatibility page from the frontend guide overview,
  production deployment, and configuration docs
- Exclude macOS resource fork files (._*) from Sphinx doc builds
@jat255 jat255 added bug Something isn't working tech-debt Technical debt that needs to be addressed labels Mar 24, 2026
@jat255 jat255 enabled auto-merge (squash) March 24, 2026 05:24
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@jat255 jat255 merged commit 53d7616 into main Mar 24, 2026
12 checks passed
@jat255 jat255 deleted the update_cdcs_version branch March 24, 2026 05:25
@github-actions
Copy link
Copy Markdown
Contributor

📚 Documentation Preview

The documentation for this PR has been deployed to:

This preview will be updated on each push to this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working tech-debt Technical debt that needs to be addressed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix tests and code to be compatible with NexusLIMS-CDCS 3.20

1 participant