Skip to main content

Employee Domain Foundation APIs

Summary​

Three internal endpoints return static foundation metadata. They do not read or mutate employee records, and the foundation response explicitly reports CRUD disabled for that foundation surface.

Audience​

  • Employee Service developers
  • QA engineers and solution architects

Reference Content​

The following inventory and endpoint sections define the internal foundation surface.

API inventory​

MethodRoutePurposeAuthenticationTenantRequestResponseMaturitySource path
GET/api/employee-domain/Report domain foundationRequires confirmationNot usedNoneEmployeeDomainFoundationResponseInternalmicroservices/src/employee-service/Api/Endpoints.cs
GET/api/employee-domain/policiesList policy placeholdersRequires confirmationNot usedNonestring[]Internalmicroservices/src/employee-service/Api/Endpoints.cs
GET/api/employee-domain/cqrsReport CQRS folder foundationRequires confirmationNot usedNoneAnonymous objectInternalmicroservices/src/employee-service/Api/Endpoints.cs

Get domain foundation​

  • Operation / purpose: GetEmployeeDomainFoundation; reports service stage, foundation aggregate/value-object names, event names without payloads, and policy placeholders.
  • Method / route: GET /api/employee-domain/.
  • Authentication / authorization: no route policy attached; Requires confirmation. Tenant: not consumed.
  • Parameters/body/validation: none.
  • Response: service, stage, crudApisEnabled, aggregates, valueObjects, outboxEvents, and policyPlaceholders.
  • Statuses: 200 confirmed; other statuses Requires confirmation. Side effects: none.
  • Compatibility: internal foundation metadata, not a compatibility or CRUD endpoint.
GET /api/employee-domain/
{"service":"employee-service","stage":"domain-foundation","crudApisEnabled":false,"aggregates":["Employee"],"valueObjects":["EmployeeCode"],"outboxEvents":["EmployeeCreated"],"policyPlaceholders":["Employee.View"]}

Example error response: no endpoint-specific error response is implemented; Requires confirmation.

Get policy placeholders​

  • Operation / purpose: GetEmployeePolicyPlaceholders; returns the registered Employee policy-name set.
  • Method / route: GET /api/employee-domain/policies.
  • Authentication / authorization: no route policy attached; Requires confirmation. Tenant: not consumed.
  • Parameters/body/validation: none.
  • Response: string array. Success: 200. Other errors Requires confirmation.
  • Side effects: none. Compatibility: internal metadata; it does not prove policies are attached to endpoints.
GET /api/employee-domain/policies
["Employee.View","Employee.Create","Employee.Update","Employee.Delete","Department.Manage","Designation.Manage"]

Example error response: no endpoint-specific error response is implemented; Requires confirmation.

Get CQRS foundation​

  • Operation / purpose: GetEmployeeCqrsFoundation; reports expected folder names and a foundation note.
  • Method / route: GET /api/employee-domain/cqrs.
  • Authentication / authorization: no route policy attached; Requires confirmation. Tenant: not consumed.
  • Parameters/body/validation: none.
  • Response: folders: string[], note: string. Success: 200. Other errors Requires confirmation.
  • Side effects: none. Compatibility: internal static metadata; it is not runtime handler discovery.
GET /api/employee-domain/cqrs
{"folders":["Commands","Queries","Validators","Mappings","Behaviors"],"note":"Structure placeholder only; operational handlers are not exposed in Sprint 3 Epic 1."}

Example error response: no endpoint-specific error response is implemented; Requires confirmation.

Source References​

  • microservices/src/employee-service/Api/Endpoints.cs
  • microservices/src/employee-service/Program.cs

See Also​

Keywords​

  • Domain foundation
  • Internal API
  • Policy placeholders

Revision Information​

  • Status: Draft
  • Last reviewed: 2026-07-15
  • Review cycle: Quarterly