ui5-middleware-fe-mockserver - Missing documentation for unbound actions/function imports

SAP / open-ux-odata

Enable community collaboration to jointly promote and facilitate best in class framework and tooling capabilities when working with OData services.

Apache License 2.0

51 stars 12 forks source link

ui5-middleware-fe-mockserver - Missing documentation for unbound actions/function imports #662

Closed jonaszuberbuehler closed 1 year ago

jonaszuberbuehler commented 1 year ago

Issue Description

From the examples on function imports it's unclear how to mock unbound actions. After debugging the mock server I've found out about the EntityContainer.js file (DataAccess#performAction). Some official documentation and/or examples about it would be helpful.

Issue Type

[ ] Documentation is unclear
[ ] Documentation is incorrect
[X] Documentation is missing
[ ] Other

helencorrigan commented 1 year ago

FYI @nlunets

nlunets commented 1 year ago

https://github.com/SAP/open-ux-odata/blob/main/docs/EntityContainerAPI.md

Referred to from

https://github.com/SAP/open-ux-odata/tree/main/packages/ui5-middleware-fe-mockserver

-> https://github.com/SAP/open-ux-odata/blob/main/docs/DefiningMockdata.md

nlunets commented 1 year ago

@jonaszuberbuehler the documentation exists already, and can be accessed rather easily from the readme of the mockserver middleware, so i'm not sure what else we can do here.

jonaszuberbuehler commented 1 year ago

@nlunets Thanks, must have missed that somehow.