BlueBrain / BlueBrain/nexus-python-sdk

Take decision on whether / how the nexus-python-sdk checks Nexus API specific constraints

Aperta
#50 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
6
Fork
10
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

This is feedback provided after a first usage of the nexus-python-sdk and its documentation to perform basic operations in a Nexus V1 deployment.

Regarding propagating specifics from the Nexus API, the following questions were noted:

* Should constraints given by the Nexus API be checked / explicitely stated in the nexus-python-sdk, e.g. should the parameter `org_label` in `nexussdk.organizations.create` be checked to not contain upper case letters or spaces?
* Should terms like `vocab` and `base` be further described in the docstrings of the nexus-python-sdk?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia esaminando l'entry point nexussdk.organizations.create e i docstring di nexus-python-sdk, quindi confronta le domande con i vincoli della Nexus V1 API. Il lavoro è completato quando il progetto ha registrato una decisione sulla necessità di convalidare o documentare le restrizioni di org_label e sulla necessità di definire vocab e base.

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

Valutazione

Stack tecnologico
python
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.