Skip to content

SB 8.1 docs - #193

Merged
Eric Zwaal (ezw2000) merged 4 commits into
mainfrom
sb/sb-8.1-docs
Oct 20, 2026
Merged

Eric Zwaal (ezw2000) merged 4 commits into
mainfrom
sb/sb-8.1-docs

Conversation

@reindejager

Copy link
Copy Markdown
Contributor

Documentatie-update voor SB 8.1.

Spec

  • release-spec.json bijgewerkt naar 8.1 (stable, 14 oktober). Geen functionele API-wijzigingen ten opzichte van 8.0.
  • Nieuw: scripts/sb_spec_fixes.py. Past de handmatige correcties uit eerdere releases opnieuw toe na elke download: het response-schema van ledgeraccounts 2.0, de typefouten in salesinvoice (VatType, ToBeInvoiced) en de documentatie van ReadKey en chunked upload op /api/blob/{uuid}. Voor ledgeraccounts en salesinvoice zijn POA's ingestuurd om het bij de bron op te lossen.
  • nl/8-1-0.json en en/8-1-0.json: release-spec met de voorbeelden uit OpenApiSpecs/sb/files (via merge_openapi_examples.py). Alle voorbeelden uit 8.0 zijn aanwezig.
  • Menu: 8.1.0 is de huidige versie. De labels "vorige/oudere versie" zijn in NL en EN gelijkgetrokken.

Blobs-pagina (NL en EN)

  • Downloaden met de ReadKey: header of query, geldigheid en foutmeldingen.
  • Uploaden in chunks met Content-Range en x-blob-completed, met C#-voorbeeld.

Geen release notes voor 8.1: er zijn geen API-wijzigingen.

🤖 Generated with Claude Code

The generated spec loses the hand edits from earlier releases on every
download. scripts/sb_spec_fixes.py re-applies them: the ledgeraccounts 2.0
response schema, the salesinvoice VatType/ToBeInvoiced texts, and the
ReadKey and chunked upload documentation on /api/blob/{uuid}.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Explains how to download a blob with the ReadKey header, how long a
ReadKey is valid and which errors to expect, and how to upload a file in
chunks with Content-Range and x-blob-completed. Adds C# examples for both.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
8-1-0.json is release-spec.json with the examples from OpenApiSpecs/sb/files
merged in by merge_openapi_examples.py. Also aligns the previous/older
labels so the four versions before the current one are 'previous' in both
languages.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 19, 2026 13:01
The frontmatter date check expects '---' on the first line and reports
'No frontmatter found' when the file starts with a BOM.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

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

De verplichte voorbereidingsheader in het schema conflicteert met de beschreven upload- en afrondingsrequests.

2 open issues
What changed in this PR

Deze PR actualiseert de SB-documentatie naar versie 8.1 en verduidelijkt het downloaden en uploaden van blobs.

review nodig: ja
labels: 🏗️ infra

Changes:

  • Werkt de releasespecificatie en versiemenu’s bij naar 8.1.
  • Voegt een script toe om handmatige specificatiecorrecties opnieuw toe te passen.
  • Breidt beide blobhandleidingen uit met ReadKey-uitleg en chunkuploads.
File Description
scripts/​sb_spec_fixes.py Automatiseert specificatiecorrecties.
OpenApiSpecs/​sb/​nl/​release-spec.json Actualiseert versie en blobdocumentatie.
menustructures/​sb_openapi_specs_menu.json Markeert 8.1.0 als huidige versie.
markdownpages/​sb/​nl/​blobs.md Breidt Nederlandse uitleg en C#-voorbeelden uit.
markdownpages/​sb/​en/​blobs.md Breidt Engelse uitleg en C#-voorbeelden uit.

Review effort: Balanced

Comment thread scripts/sb_spec_fixes.py
Comment thread markdownpages/sb/nl/blobs.md
@ezw2000
Eric Zwaal (ezw2000) merged commit 57a3255 into main Oct 20, 2026
7 checks passed
@ezw2000
Eric Zwaal (ezw2000) deleted the sb/sb-8.1-docs branch October 20, 2026 08:59
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