Microsoft/bcquality
1
0
Fork 0
mirror of https://github.com/microsoft/BCQuality.git synced 2026-10-05 06:36:55 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
bcquality/microsoft/knowledge/style/api-page-camelcase-properties.md
Jesper Schulz-Wedde 2b5550c346
Some checks failed
Validate knowledge index / validate-index (push) Has been cancelled
Details
Validate AL review fixtures / validate-review-fixtures (push) Has been cancelled
Details
Validate frontmatter and structure / validate (push) Has been cancelled
Details
Improve partner onboarding and documentation navigation (#174) 
Lead with a complete plugin quick start and add task-oriented usage, troubleshooting, customization, and contribution guides. Preserve the broader plugin framing, correct conflicting contract guidance, support Agents folder reviews, and align repository validation. Convert existing sample references to clickable links without changing knowledge rules.

Co-authored-by: Jesper Schulz-Wedde <jesper.schulzwedde@microsoft.com>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
2026-09-09 17:31:03 +02:00

1.6 KiB
Raw Blame History

bc-version domain keywords technologies countries application-area
all
style
api-page
camelcase
apipublisher
apigroup
entityname
entitysetname
al
w1
all

API pages use camelCase, alphanumeric-only values for API properties

Description

API pages — pages declared with PageType = API — surface as OData/JSON endpoints. The strings that appear in the URL (APIPublisher, APIGroup, EntityName, EntitySetName) and the JSON payload field names follow different naming rules from the rest of AL. They must be camelCase and use only alphanumeric characters: no hyphens, no underscores, no spaces, no punctuation. 'Contoso-App', 'contoso_app', and 'contoso.app' are all rejected. The same rule applies to page field names exposed via Name = '…' on API page controls — those names appear verbatim in the JSON keys.

Best Practice

Pick camelCase identifiers up front: APIPublisher = 'contoso', APIGroup = 'app1', EntityName = 'customer', field Name = 'displayName'. Keep them short — they end up in URL paths and JSON keys that every consumer types.

See sample: api-page-camelcase-properties.good.al.

Anti Pattern

APIPublisher = 'Contoso-App' (hyphen rejected, capitalization wrong for camelCase), EntityName = 'sales_order' (underscore rejected), or fields exposed with Name = 'Display Name' (space rejected). The compiler usually catches these, but the failure mode is opaque and the rename cost on a deployed API is high.

See sample: api-page-camelcase-properties.bad.al.