Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Provide convenience method for adding a client-id header

Aperta
#49 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

@Sharvin-M ci sta già lavorando.

Dal 14/1/2025.

  • #97 di @Sharvin-M — aperta

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
45/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
api

Direzione di ricerca

Inizia nella classe Query, accanto ai metodi token e bearer_token esistenti, quindi verifica come viene esposta la versione del pacchetto python_cmr. Il lavoro è completato quando un metodo di convenienza client_id imposta Client-Id con il comportamento richiesto per il valore predefinito o il suffisso di versione, con una copertura sia per gli ID forniti dall’utente sia per gli ID predefiniti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement good first issue

The Headers section of the CMR Search API documentation describes the Client-Id header as follows:

Client-Id - Indicates a name for the client using the CMR API. Specifying this helps Operations monitor query performance per client. It can also make it easier for them to identify your requests if you contact them for assistance.

Given that there are token and bearer_token methods in the Query class for conveniently setting the Authorization header, providing a client_id method would be convenient for supplying the Client-Id header.

Further, I recommend the following:

  • When the user does not invoke the client_id method to specify their own chosen ID for identification for assistance, a default should be set. I recommend something like this: python_cmr-vX.Y.Z, where X.Y.Z is the version of python_cmr
  • When the user does invoke the client_id method, the following suffix should be added to the value specified by the user: (python_cmr-vX.Y.Z), with a space character between the user-supplied value and the suffix.
Lingua principale
Python
Stelle
29
Fork
32
Merge medio
19h 6m
PR unite (30g)
1

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di nasa/python_cmr

Tutte le issue di nasa/python_cmr

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.