docs(openapi): document GeoDatasets append params + add/enrich other core plugin endpoints#106
Merged
tariqksoliman merged 4 commits intoJul 9, 2026
Conversation
… params - append: add group_id_prop/feature_id_prop query params, document body-level startProp/endProp/groupIdProp/featureIdProp, and note that append does not auto-reuse the fields configured at creation - get: add group_id, id, spatialFilter, format query params - aggregations: add startProp, endProp, format - search: add operator, type, last body params - recreate: add groupIdProp, featureIdProp, filename - document previously-undocumented POST /intersect and GET /bulk_aggregations Co-Authored-By: tariq.k.soliman <tariqksoliman@gmail.com>
Author
Original prompt from tariq.k.soliman
|
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
✅ Version Already UpdatedThis PR includes a manual version update to No automatic version bump needed. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Co-Authored-By: tariq.k.soliman <tariqksoliman@gmail.com>
…riptions Add previously-undocumented functional endpoints: STAC collections list and collection export, POST /api/draw/aggregations, POST /api/utils/getminmax, POST /api/utils/ll2aerll_bulk, and POST /api/configure/reference-mission/save-to-base. Enrich per-field descriptions on several thin endpoints (users login/signup/ first_signup/resetPassword, utils getprofile/getbands, configure add/ updateGeneralOptions, shortener shorten/expand, longtermtoken generate/clear), notably documenting that longtermtoken 'period' is milliseconds or 'never'. Co-Authored-By: tariq.k.soliman <tariqksoliman@gmail.com>
devin-ai-integration
Bot
changed the title
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.
Purpose
group_id, start-time, and end-time fields that were set when the GeoDataset was created.start_time/end_time/group_id/feature_idwhen the corresponding prop names are re-supplied on the append request. The*_fieldconfig stored at creation is read only to decide which columns exist, and is never used to compute per-feature values on append. Without the props, appended features getNULLfor those columns and won't match temporal/group_idqueries.docs/mmgis-openapi.json, served at/api-docs) and the GeoDatasets API markdown doc to document those params, then extends the audit to the rest of the core backend plugins — adding the remaining undocumented functional endpoints and enriching thin/undescribed field docs. No runtime code changed — docs only.Proposed Changes
GeoDatasets (original scope)
POST /append/{name}:group_id_propandfeature_id_propquery params; documented body-levelstartProp/endProp/groupIdProp/featureIdProp; prominent note that append does not auto-reuse the fields configured at creation.POST /append/{name}&/append/{name}/{start_end_prop}: request body IS the GeoJSON FeatureCollection, not a{ geojson: ... }wrapper.GET /get&/get/{layer}:group_id,id,spatialFilter,format.GET /aggregations:startProp,endProp,format.POST /search:operator,type,last.POST /recreate:groupIdProp,featureIdProp,filename+actiondescription. DocumentedPOST /intersectandGET /bulk_aggregations.tests/e2e/api/geodatasets-append-fields.spec.jscovering create-with-fields → append-with-props → temporal + group_id queries, plus the append-without-props NULL gotcha.Other core backend plugins (follow-up scope)
GET /api/stac/collections,GET /api/stac/collections/{collection}/export(new STAC tag)POST /api/draw/aggregationsPOST /api/utils/getminmax,POST /api/utils/ll2aerll_bulkPOST /api/configure/reference-mission/save-to-baseuserslogin/signup/first_signup/resetPassword,utilsgetprofile/getbands,configureadd/updateGeneralOptions,shortenershorten/expand,longtermtokengenerate/clear.longtermtokenperiodis milliseconds from creation (or the stringnever) — a unit string like"1d"parses to1msand the token is immediately expired.testwebhooksstubs, andPOST /api/configure/rename(empty no-op handler in code).Issues
Testing
node -e "require('./docs/mmgis-openapi.json')"confirms the OpenAPI JSON stays valid (92 paths).swagger-cli validate: the 26 pre-existing structural warnings are unchanged and the additions introduce no new validation errors.plugins/core/backend/*.test (local)andtest (off)green.Link to Devin session: https://nasa-jpl-demo.devinenterprise.com/sessions/9fa34356618548b4a5ccf8a9af883a37
Requested by: @tariqksoliman