Skip to content

Restructure UpdateConnector documentation - #204

Merged
Heimmot24 merged 6 commits into
mainfrom
updateconnector-documentatie
Nov 17, 2026
Merged

Heimmot24 merged 6 commits into
mainfrom
updateconnector-documentatie

Conversation

@Heimmot24

@Heimmot24 Heimmot24 commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Restructures the UpdateConnector page (markdownpages/profit/nl/update-connector.md and markdownpages/profit/en/update-connector.md). The EN page is a translation of the NL page.

  • Message structure: new section explaining Element, Fields and Objects, with a journal entry example. It also notes that the top-level object name can differ from the connector name (connector FiEntries has main object FiEntryPar).
  • Determining the operation: three ways, from simple to flexible:
    1. HTTP method on the connector (POST, PUT, DELETE), keeping the existing validation, field-clearing and delete content
    2. POST on a subobject URL (KnOrganisation/KnBankAccount, plus the existing HrMobility example). The OpenAPI specs only document POST for these routes, so the text points to PUT on the main connector for updates and to the DELETE route with keys in the URL for deletes.
    3. @Action per element, with a new FbAssembly example next to the existing employee example
  • New @Action guidance: how elements without @Action are handled, and common pitfalls (placement, capitalisation, attribute order, nested levels).
  • New sections on key fields and SOAP (Action attribute on Fields).
  • Security: the real AfasToken in the POST example is replaced with a Bearer {token} placeholder.
  • Date in the frontmatter set to 2026-11-17.

The endpoints used in the examples (FiEntries, KnOrganisation/KnBankAccount, HrMobility/HrEmployeeMobilityRegistration) were checked against the OpenAPI specs in OpenApiSpecs/profit/nl.

To check

  • The page has not been previewed in rendered form.

🤖 Generated with Claude Code

Reorganise the NL and EN UpdateConnector pages around message structure and
the three ways to determine the operation (HTTP method, subobject URL,
@action). Add guidance on elements without @action and common pitfalls,
replace the real AfasToken with a Bearer placeholder, and update the date.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings November 17, 2026 09:37
@Heimmot24
Heimmot24 enabled auto-merge November 17, 2026 09:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Both language versions contain incorrect connector URLs, schema-invalid payload examples, and conflicting guidance on supported methods and nested-object behavior that could lead readers to send invalid requests.

5 open issues
What changed in this PR

review nodig: ja
labels: 📚 leerzaam

Deze PR herstructureert de Nederlandse en Engelse UpdateConnector-documentatie voor Profit. De stapsgewijze uitleg van berichtopbouw en bewerkingen maakt de pagina leerzaam voor integratieontwikkelaars.

Changes:

  • Ordent bewerkingen via HTTP-methoden, subobject-URL’s en @Action per element.
  • Voegt voorbeelden en uitleg toe over sleutelvelden, SOAP en valkuilen bij geneste objecten.
  • Vervangt het concrete token door een placeholder en actualiseert de documentatiedatum.
File Description
markdownpages/​profit/​nl/​update-connector.md Herstructureert en breidt de Nederlandse uitleg en voorbeelden uit.
markdownpages/​profit/​en/​update-connector.md Voert dezelfde herstructurering en aanvullingen door in het Engels.

Review effort: Balanced

Tom Klute and others added 5 commits November 17, 2026 10:49
The connector URL is /connectors/FiEntries; FiEntryPar is its main object in
the payload. Clarify that the top-level object name can differ from the
connector name.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The OpenAPI specs only document POST for /connectors/{connector}/{subobject}
routes. Point to PUT on the main connector for updates and to the DELETE
route with keys in the URL for deletes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
AfasFbOrderCompLines has no UnCd or FxQu field in the FbAssembly schema; the
unit field is BiUn.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The FbAssembly insert schema requires BaNu, BiUn and QuUn on
FbOrderBatchLines. Use the unit and quantity of the parent component line.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Elements outside the URL path get the update operation; whether deeper
nested objects are still created differs per connector. Explain when an
explicit "@action": "insert" is needed and make both passages consistent.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Heimmot24
Heimmot24 merged commit 5375554 into main Nov 17, 2026
7 checks passed
@Heimmot24
Heimmot24 deleted the updateconnector-documentatie branch November 17, 2026 12:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants