@salesforce/b2c-tooling-sdk / project-index / IndexedCustomApiEndpoint
Interface: IndexedCustomApiEndpoint
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:155
A Custom API endpoint from rest-apis/<api>/api.json, joined with its schema.yaml operation.
Properties
api
api:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:156
apiType
apiType:
"unknown"|"admin"|"shopper"
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:171
shopper (ShopperToken), admin (AmOAuth2), or unknown.
cartridge
cartridge:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:159
endpoint
endpoint:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:158
Endpoint name in api.json; matches the schema's operationId and the exported function.
implementation?
optionalimplementation:string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:161
implementationFile?
optionalimplementationFile:object
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:173
Implementation script relative to the cartridge, and the exported function's line.
line?
optionalline:number
relPath
relPath:
string
method?
optionalmethod:string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:163
HTTP method from schema.yaml (GET).
path?
optionalpath:string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:165
Path from schema.yaml (/loyalty-info).
problems
problems:
string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:177
Problems found while joining api.json, schema.yaml, and the script.
public?
optionalpublic:boolean
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:175
Whether the exported function is marked .public = true (required).
schema?
optionalschema:string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:160
scopes?
optionalscopes:string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:169
Scopes required by the security requirement (c_loyalty).
security?
optionalsecurity:string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:167
Security schemes that apply (ShopperToken, AmOAuth2).