DOI-USGS / DOI-USGS/dataretrieval-python

Apply term ownership to NLDI, NGWMN, and WQP prose

Abierto
#408 0 comentarios 0 reacciones 0 asignados Ver en GitHub
ready-for-agent
Lenguaje dominante
Python
Estrellas
265
Forks
63
Merge medio
1 d 20 h
PR fusionados (30 d)
19

Descripción

## Parent

#406

## Ownership rule

ADR 0013 separates package-owned core vocabulary from service-owned domain vocabulary:

- `getter` is a dataretrieval core term. It applies only to public functions returning `(DataFrame, metadata)` and binds package prose and tests.
- `collection` is a domain concept. Adapter prose should accurately translate the service's own vocabulary, while public parameters and wire spellings remain native to that service.

Primary sources settle the three adapters differently:

- [NLDI's official documentation](https://api.water.usgs.gov/docs/nldi/) calls its operations **navigation functions**. The Python adapter returns GeoDataFrames or JSON directly, without a metadata tuple, so calling these functions getters is a package vocabulary defect.
- [NGWMN's live OGC collections document](https://api.waterdata.usgs.gov/ngwmn/ogcapi/collections) publishes `sites`, `providers`, `waterLevelObs`, and the other record sets as **collections**. Prose calling those collection identifiers services is upstream-inaccurate; NGWMN itself remains the service.
- [WQP's official Web Services Guide](https://www.waterqualitydata.us/webservices_documentation/) calls these endpoints the **Station Web Service**, **Result Service**, and **profile services**. `dataProfile` is a separate request parameter. WQP's public `service` vocabulary is therefore native domain language and must not be normalized away.

## What to build

Apply those ownership decisions consistently without changing public behavior:

1. Describe NLDI's direct-return operations as navigation functions rather than getters, including package and test prose.
2. Describe NGWMN OGC collection identifiers as collections in prose and comments, while continuing to call the external NGWMN system a service.
3. Correct the shared glossary so it distinguishes WQP's Result/Station/Activity services from the separate `dataProfile` values.
4. Preserve WQP's public `service` parameters, URL-builder documentation, exported names, wire paths, and other service-oriented public prose.

## Acceptance criteria

- [ ] NLDI prose and test comments no longer call direct GeoDataFrame or dictionary-returning functions getters.
- [ ] NLDI is described as navigation functions, matching both its return contract and official API documentation.
- [ ] NGWMN prose and comments use collection for identifiers exposed by its OGC `/collections` document.
- [ ] References to the external NGWMN system continue to use service.
- [ ] The glossary accurately records that WQP exposes Result, Station, and Activity services and treats `dataProfile` as a separate concept.
- [ ] WQP's public `service` terminology and service-oriented URL-builder documentation remain unchanged.
- [ ] Deprecated NWIS vocabulary, Samples resource/code-service terms, the deprecated CQL keyword, and permanent aliases remain unchanged.
- [ ] No public name, signature, return shape, exported value, wire parameter, URL, or runtime behavior changes.
- [ ] Documentation, offline adapter tests, lint, and architecture checks pass.

## Blocked by

None — can start immediately.

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza con ADR 0013 y la documentación oficial de NLDI, NGWMN y WQP enlazada en el issue. Busca los términos afectados en el texto de los adaptadores, los comentarios de las pruebas y el glosario compartido; después, ejecuta las pruebas offline de los adaptadores, el lint y las comprobaciones de arquitectura. Se considera terminado cuando los cambios de terminología coinciden con cada servicio, mientras que los nombres públicos, los parámetros, las URLs, las formas de retorno y el comportamiento en tiempo de ejecución permanecen sin cambios.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
python
Área
documentation
Tipo de issue
Documentación
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Activo
Claridad
Bien especificado
Aptitud para principiantes
68/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.