Azure / Azure/apiops

[Question] Why are some configuration keys changed to snake_case while others are still camelCase?

Offen
#817 7 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
C#
Sterne
448
Forks
247
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

### Release version

v7.0.0-alpha.3.0.0

### Question Details

Since v7alpha3 _some_ configuration keys use snake_case, like named_values, service_policies, version_sets. However many keys still use camelCase, like apimServiceName, displayName, loggerId etc.

Why are some snake_case and others still camelCase? I find this personally super confusing and inconsistent.

For example below the new [configuration.extractor.yaml](https://github.com/Azure/apiops/blob/v7/configuration.extractor.yaml) example, why is workspaceName1 camelCase and then further below named_values is snake_case? To me this seems strange to mix naming conventions like this.

```yaml
workspaces:
- workspaceName1:
apis:
- workspaceApiName1:
operations: []
diagnostics: []
schemas: []
releases:
- workspaceReleaseName1
backends:
- workspaceBackendName1
diagnostics: []
groups: []
loggers:
- workspaceLoggerName1
named_values:
- workspaceNamedValueName1
policy_fragments:
- workspacePolicyFragmentName1
products:
- workspaceProductName1
subscriptions: []
tags:
- workspaceTagName1
version_sets:
- workspaceVersionSetName1
```

### Expected behavior

Either all keys should use camelCase as it previous was or all keys should use snake_case.

### Actual behavior

Some keys are camelCase, some are snake_case.

### Reproduction Steps

None

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Start with the linked configuration.extractor.yaml example and compare its key naming with the v7alpha3 configuration rules. Trace where the example or configuration schema is documented or generated; done means the naming convention and the reason for any mixed keys are made consistent or clearly documented.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
yaml
Bereich
api, documentation
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.