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

Open
#817 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
yaml
Domain
api, documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

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

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

Dominant language
C#
Stars
448
Forks
247
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Azure/apiops

All issues in Azure/apiops

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.