DOI-USGS / DOI-USGS/dataretrieval-python

Apply term ownership to NLDI, NGWMN, and WQP prose

Ouverte
#408 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
ready-for-agent
Langage dominant
Python
Étoiles
265
Forks
63
Merge moyen
1 j 20 h
PR mergées (30 j)
19

Description

## 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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par ADR 0013 et la documentation officielle de NLDI, NGWMN et WQP liée dans l’issue. Recherchez les termes concernés dans le texte des adaptateurs, les commentaires des tests et le glossaire partagé, puis exécutez les tests offline des adaptateurs, le lint et les vérifications d’architecture. Le travail est considéré comme terminé lorsque les changements de terminologie correspondent à chaque service, tandis que les noms publics, les paramètres, les URLs, les formes de retour et le comportement à l’exécution restent inchangés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Documentation
Difficulté
4/5
Temps estimé
3-5 jours
Activité
Active
Clarté
Clairement spécifiée
Accessibilité débutants
68/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.