Vector35 / Vector35/binaryninja-api

Publish JSON schema for activity configuration

Aperta
#6,782 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Component: Core Effort: Medium Impact: Medium
Lingua principale
C++
Stelle
1.3k
Fork
298
Merge medio
5g 5h
PR unite (30g)
19

Descrizione

I've seen from errors I've made while writing activity configurations that the provided activity configuration is validated against a JSON schema. Having the schema available would be useful for understanding the structure of the configurations, for times when it's hard to find details in the narrative documentation at http://docs.binary.ninja/dev/workflows.html.

Additionally, if the schema were checked into this repository it would be possible to leverage tools such as cargo typify to generate strongly-typed representations of the configuration. I have my own hand-rolled version of this at https://github.com/bdash/bn-bdash-extras/blob/dev/src/activity.rs because I'd rather lean on autocomplete to get the configuration structure right than have to re-read the documentation again.

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.

Direzione di ricerca

Start with the activity configuration details in the workflows documentation at docs.binary.ninja/dev/workflows.html and locate the schema currently used for validation. Check how it can be represented in this repository and confirm that the published schema supports tools such as cargo typify; done means contributors can find and use the schema alongside the existing documentation.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.