Fix API endpoint URLs and documentation structure - #105
Merged
Merged
Conversation
- Update `src/commons/plantdb/commons/api_endpoints.py` to group **filesets** under a dedicated section with clear GET listing and nested `{scan_id}/{fileset_id}` routes
- Introduce separate top‑level **files** section with `{scan_id}/{fileset_id}/{file_id}` hierarchy
- Simplify method annotations: use `(GET)` for list operations and `(POST)`/`(GET, POST)` for create and metadata actions
- Adjust comment layout to reflect new endpoint organization and improve readability.
- Remove redundant `/scans` prefix from fileset and file endpoint paths in `docs/rest_api/rest_api_endpoints.md`
- Standardize routes to ` /filesets/{scan_id}/{fileset_id}` and ` /files/{scan_id}/{fileset_id}/{file_id}` for all CRUD and metadata operations
- Add a dedicated **Filesets** section header and restructure related endpoint listings
- Adjust markdown formatting (section dividers, headings) to reflect the new organization
- Update example request/response descriptions to match the revised URLs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/scansprefix from fileset and file endpoint paths in the REST API documentation./filesets/{scan_id}/{fileset_id}/files/{scan_id}/{fileset_id}/{file_id}src/commons/plantdb/commons/api_endpoints.py:{scan_id}/{fileset_id}routes.{scan_id}/{fileset_id}/{file_id}hierarchy.(GET)for list operations,(POST)/(GET, POST)for create and metadata actions).