Skip to content

Clarify JSON handling approach in deprecations docs - #319

Merged
oblomov-dev merged 1 commit into
mainfrom
claude/tender-clarke-am5979
Sep 14, 2026
Merged

oblomov-dev merged 1 commit into
mainfrom
claude/tender-clarke-am5979

Conversation

@oblomov-dev

Copy link
Copy Markdown
Member

Updates the deprecations documentation to provide clearer guidance on the recommended JSON handling approach for applications using z2ui5.

Summary
Replaces vague reference to a released JSON parser with explicit documentation of the intended JSON handling pattern: manual string composition in ABAP using _bind() for output, and simple string operations (find/substring_before) for input parsing.

Key changes

  • Removed reference to z2ui5_cl_ui5_json as a recommended parser
  • Added explicit guidance that JSON should be built and read by hand
  • Documented the output pattern: compose as string and bind with json = abap_true
  • Documented the input pattern: use find/substring_before to extract needed fields
  • Clarified that framework-generated payloads are flat, eliminating need for a complex parser

Implementation details
This change reflects the framework's design philosophy of keeping JSON handling simple and explicit rather than providing abstraction layers. The documentation now accurately represents the intended usage pattern for applications.

https://claude.ai/code/session_019rmo8XKoBEpBRZ2TZMUQrF

…ader

The utility-classes warning pointed at `z2ui5_cl_ui5_json` as the reader an app
should use. That class was removed from abap2UI5 `src/02` on 2026-09-14 without
ever having shipped in a release, so the sentence named an object no reader can
find.

What replaces it is what the apps already do: compose JSON as a string in ABAP
and bind it with `_bind( val = ... json = abap_true )` outbound, read the one
field you need with `find` / `substring_before` inbound. The payloads that
reach an app are written by the framework and are flat, so that is the whole
job - there is deliberately no released parser, and the page now says so rather
than pointing somewhere.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019rmo8XKoBEpBRZ2TZMUQrF
@oblomov-dev
oblomov-dev merged commit 5e9a782 into main Sep 14, 2026
1 check failed
@oblomov-dev
oblomov-dev deleted the claude/tender-clarke-am5979 branch September 14, 2026 15:00
oblomov-dev added a commit that referenced this pull request Sep 14, 2026
…efacts (#321)

abap2UI5/samples#843 promoted fourteen samples out of src/00/97 into src/01,
and the links published here point at that repository's main - check.yml pins
the checkout to it on purpose - so every one of those paths moved when it
merged. Eight generated sample blocks are regenerated (npm run link:samples),
and the two links resources/deprecations.md writes by hand, to
Z2UI5_CL_SMP_APP_507 and _509, are repointed: no generator touches those.

Two generated artefacts that were already stale on main come along: the
cs_event-store_data paragraph missing from api.md and client-api.json, and the
retitled Z2UI5_CL_SMP_APP_059 row in cookbook/model/tables. The commit carrying
them was pushed to #319's branch minutes after that pull request had merged, so
it did not go in with it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants