supabase / supabase-flutter / 32953044755
89%

DEFAULT BRANCH: main
Ran
Jobs 10
Files 120
Run time 1min
Badge
Embed ▾
README BADGES
x

If you need to use a raster PNG badge, change the '.svg' to '.png' in the link

Markdown

Textile

RDoc

HTML

Rst
coverage: 88.552%. Remained the same
32953044755

push

github

web-flow 
docs(postgrest): enable public_member_api_docs (#1772)

## Summary
- Enables `public_member_api_docs` for `postgrest`.
- Documents `PostgrestClient` and its fields, the builder hierarchy
(`PostgrestBuilder`, `RawPostgrestBuilder`, `ResponsePostgrestBuilder`,
`PostgrestFilterBuilder`, `PostgrestTransformBuilder`,
`PostgrestRpcBuilder`), and the typedefs/data classes in `types.dart`
(`PostgrestApiException`, `PostgrestResponse`, `ExplainFormat`).

## Context
Continues the package-by-package rollout for
[SDK-1449](https://linear.app/supabase/issue/SDK-1449/enable-public-member-api-docs-and-document-the-public-api).

## Test plan
- [x] `dart analyze` reports no issues
- [x] `dart format .` produces no diff
- [x] `dart test` passes aside from pre-existing failures needing a live
PostgREST/Postgres instance and a known-flaky timing test in
`retry_test.dart` (passes in isolation; confirmed these are unrelated to
this change and reproduce on `main`)

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Documentation**
* Expanded API documentation for client configuration, HTTP behavior,
retries, timeouts, and JSON codec ownership.
  * Clarified request header handling and transformation APIs.
* Added documentation for response fields, error details, type aliases,
and explain formats.
  * No runtime behavior or public API functionality changed.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

6049 of 6831 relevant lines covered (88.55%)

4.57 hits per line

Jobs
ID Job ID Ran Files Coverage
3 supabase - 32953044755.3 14
93.49
 GitHub Action Run
4 supabase_auth - 32953044755.4 30
90.57
 GitHub Action Run
5 supabase_realtime - 32953044755.5 13
90.27
 GitHub Action Run
6 iceberg - 32953044755.6 6
68.52
 GitHub Action Run
7 supabase_storage - 32953044755.7 9
97.35
 GitHub Action Run
8 supabase_flutter - 32953044755.8 11
82.22
 GitHub Action Run
9 supabase_functions - 32953044755.9 4
93.81
 GitHub Action Run
10 postgrest - 32953044755.10 11
84.59
 GitHub Action Run
10 yet_another_json_isolate - 32948304016.10 1
98.44
 GitHub Action Run
9 supabase_common - 32951661159.9 21
86.96
 GitHub Action Run
Source Files on build 32953044755