docs: document replace and upsert serializer actions for the upload API#14164
Closed
docs: document replace and upsert serializer actions for the upload API#14164
replace and upsert serializer actions for the upload API#14164Conversation
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @Copilot on file. In order for us to review and merge your code, please contact the project maintainers to get yourself added. |
Agent-Logs-Url: https://github.com/GeoNode/geonode/sessions/15c7a126-f36b-49cf-8f8c-a7e0b77591d3 Co-authored-by: nrjadkry <41701707+nrjadkry@users.noreply.github.com>
|
Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have the users @Copilot on file. In order for us to review and merge your code, please contact the project maintainers to get yourself added. |
Copilot
AI
changed the title
[WIP] Update API usage documentation for GeoNode focusing on datasets
docs: document Apr 24, 2026
replace and upsert serializer actions for the upload API
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
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.
The upload API documentation was missing coverage of the
replaceandupsertactions exposed byOverwriteImporterSerializerandUpsertImporterSerializer, and the "Overwriting a dataset" section referenced a non-existentoverwrite_existing_layerparameter.Changes
overwrite_existing_layerdescription with the actualaction=replace+resource_pkfields, including Python and cURL examples.action=upsertwithresource_pkandupsert_key(defaults tofid), explaining the insert-or-update semantics, with Python and cURL examples.skip_existing_layers=True.Replace example
Upsert example
Original prompt
did you look at the different actions from the serializer ? There are more action
[Chronological Review: The conversation began with the user requesting a review and enhancement of the API usage documentation for GeoNode, specifically focusing on various sections related to datasets and metadata. The user then inquired about the different actions from the serializer, indicating a need for deeper exploration of the API's capabilities. The user subsequently canceled a command to delegate tasks to a cloud agent, suggesting a desire to maintain control over the documentation process.][Intent Mapping:
[Technical Inventory:
[Code Archaeology:
[Progress Assessment:
[Context Validation: All critical information regarding the user's goals for enhancing the API documentation and the specific sections to be updated is captured.]
[Recent Commands Analysis:
1. Conversation Overview: - Primary Objectives: "Review and enhance API usage docs for GeoNode #5989" and "did you look at the different actions from the serializer?" - Session Context: The user is focused on improving the API documentation for GeoNode, specifically targeting sections related to datasets and metadata, while also exploring the capabilities of the serializer. - User Intent Evolution: The user started with a clear request for documentation enhancement and then sought clarification on the serializer's actions, indicating a deeper engagement with the API's functionality.- Technical Foundation:
- GeoNode API: The API being documented, which has limitations in its current OpenAPI generation.
- Django REST Framework: Implied usage for handling API serialization.
- Codebase Status:
- File Name: /home/niraj/GeoSolutions/geonode/geonode/upload/api/views.py
- Purpose: This file is crucial for defining the API views and handling dataset uploads.
- Current State: The user is currently reviewing the file to enhance API documentation.
- Key Code Segments: Specific actions related to dataset uploads and metadata handling were mentioned but not detailed.
- Dependencies: This file interacts with the overall API structure and documentation efforts.
- Problem Resolution:
- Issues Encountered: The user is addressing the limitations of the current API documentation and serializer actions.
- Solutions Implemented: The user is actively working on reviewing and enhancing the documentation.
- Debugging Context: No specific debugging efforts were mentioned, but the user is clarifying the serializer's capabilities.
- Lessons Learned: The need for comprehensive documentation and understanding of the API's actions.
- Progress Tracking:
- Completed Tasks: The user has identified sections for documentation enhancement.
- Partially Complete Work: The user is in the process of reviewing serializer actions.
- Validated Outcomes: No specific outcomes have been validated yet.
- Active Work State:
- Current Focus: The user is reviewing the actions from the serializer to ensure all are documented.
- Recent Context: The user has been discussing the need for a thorough understanding of the serializer's actions.
- Working Code: The user is focused on the fil...
Created from VS Code.