Skip to content

Commit 6c151b2

Browse files
author
Mateusz Smektała
committed
docs: refresh KSeF 2.5 compatibility wording
1 parent 8c0bbf7 commit 6c151b2

4 files changed

Lines changed: 9 additions & 16 deletions

File tree

README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,11 @@ Projekt odwzorowuje oficjalne przepływy KSeF i zapewnia spójny model pracy w d
1212

1313
## 🔄 Kompatybilność
1414

15-
Aktualna kompatybilność: **KSeF API `v2.4.0`** ([api-changelog.md](https://github.com/CIRFMF/ksef-docs/blob/2.4.0/api-changelog.md#wersja-240)).
15+
Aktualna kompatybilność: **KSeF API `v2.5.0`** ([api-changelog.md](https://github.com/CIRFMF/ksef-docs/blob/2.5.0/api-changelog.md#wersja-250)).
1616

1717
Od tej wersji publiczne payloady requestów SDK są **typed-only**. Do metod klientów przekazuj
1818
obiekty `ksef_client.models.*`, a nie surowe `dict`.
1919

20-
> [!WARNING]
21-
> **Breaking change:** domyślna gałąź repo zawiera już zmianę publicznego kontraktu SDK.
22-
> Request payloady do klientów są `typed-only`, a wiele odpowiedzi jest teraz zwracanych jako modele
23-
> zamiast surowych `dict`. Jeśli integracja buduje requesty jako słowniki albo czyta odpowiedzi przez
24-
> `response["field"]`, wymaga migracji. Szczegóły i przykłady: [`docs/migration-typed-model-api.md`](docs/migration-typed-model-api.md).
25-
2620
## 🧭 Spis treści
2721

2822
- [Zakres funkcjonalny](#zakres-funkcjonalny)

docs/README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@ Dokumentacja opisuje **publiczne API** biblioteki `ksef-client-python` (import:
44

55
Opis kontraktu API (OpenAPI) oraz dokumenty procesowe i ograniczenia systemu znajdują się w `ksef-docs/`.
66

7-
Kompatybilność SDK: **KSeF API `v2.4.0`**.
7+
Kompatybilność SDK: **KSeF API `v2.5.0`**.
88

9-
> [!WARNING]
10-
> Publiczny kontrakt SDK na domyślnej gałęzi repo używa typowanych modeli `ksef_client.models`.
11-
> Payloady requestów są `typed-only`, a wiele metod klientów zwraca modele odpowiedzi zamiast surowych
12-
> `dict`. Jeśli migrujesz starszą integrację, zobacz [`migration-typed-model-api.md`](migration-typed-model-api.md).
9+
Publiczny kontrakt SDK używa typowanych modeli `ksef_client.models`. Payloady requestów są
10+
`typed-only`, a wiele metod klientów zwraca modele odpowiedzi zamiast surowych `dict`. Jeśli
11+
migrujesz starszą integrację, zobacz [`migration-typed-model-api.md`](migration-typed-model-api.md).
1312

1413
## Wymagania
1514

docs/api/tokens.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Tworzy nowy token. Operacja jest asynchroniczna – odpowiedź zawiera numer ref
1212

1313
Endpoint: `GET /tokens`
1414

15-
Od KSeF API 2.4.0 endpoint zwraca też informacje o tokenie użytym do bieżącego uwierzytelnienia,
15+
Od KSeF API 2.5.0 endpoint zwraca też informacje o tokenie użytym do bieżącego uwierzytelnienia,
1616
nawet jeśli nie ma on uprawnień `CredentialsManage` / `CredentialsRead`.
1717

1818
Parametry:
@@ -24,14 +24,14 @@ Parametry:
2424

2525
Endpoint: `GET /tokens/{referenceNumber}`
2626

27-
Od KSeF API 2.4.0 można pobrać status tokenu użytego do bieżącego uwierzytelnienia także bez
27+
Od KSeF API 2.5.0 można pobrać status tokenu użytego do bieżącego uwierzytelnienia także bez
2828
dodatkowych uprawnień do zarządzania tokenami.
2929

3030
## `revoke_token(reference_number, access_token)`
3131

3232
Endpoint: `DELETE /tokens/{referenceNumber}` (204)
3333

34-
Od KSeF API 2.4.0 można unieważnić token użyty do bieżącego uwierzytelnienia bez uprawnienia
34+
Od KSeF API 2.5.0 można unieważnić token użyty do bieżącego uwierzytelnienia bez uprawnienia
3535
`CredentialsManage`.
3636

3737
W CLI odpowiada temu komenda `ksef auth revoke-self-token`, która w pierwszej kolejności używa

docs/errors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Specjalny przypadek dla `429 Too Many Requests`.
3232

3333
## Problem Details i `exc.problem`
3434

35-
KSeF API 2.4.0 rozszerza odpowiedzi błędów o format `application/problem+json`.
35+
KSeF API 2.5.0 rozszerza odpowiedzi błędów o format `application/problem+json`.
3636

3737
SDK mapuje `exc.problem` do jednego z modeli:
3838

0 commit comments

Comments
 (0)