Skip to content

Commit 39e0ce7

Browse files
author
Anonymous Committer
committed
2 parents aaf1e75 + 1e765de commit 39e0ce7

1 file changed

Lines changed: 0 additions & 43 deletions

File tree

README.md

Lines changed: 0 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -102,49 +102,6 @@ client.close()
102102
- `timeout`: default request timeout injected into high-level methods
103103
- `retries`: `urllib3` retry configuration; defaults to a conservative retry strategy for the high-level client
104104

105-
## OpenAPI Control Plane
106-
107-
This repository only owns the Python SDK. The canonical OpenAPI document plus the Python-specific control-plane files in `config/`, `scripts/`, and `overlays/python/` drive generation and validation.
108-
109-
- If `openapi/justserpapi.openapi.json` is committed, local generation is fully reproducible.
110-
- If it is not committed, CI can fetch and cache it by running `python scripts/sdkctl.py fetch-spec` with `JUSTSERPAPI_API_KEY` configured.
111-
112-
If the API changes, update these files:
113-
114-
- `openapi/justserpapi.openapi.json`: the current canonical spec used to validate and generate the SDK
115-
- `openapi/baseline/justserpapi.openapi.json`: the previous released spec snapshot used only for breaking-change checks
116-
117-
Typical maintenance flow after an API change:
118-
119-
```bash
120-
cp /path/to/latest-openapi.json openapi/justserpapi.openapi.json
121-
python scripts/sdkctl.py validate-examples
122-
python scripts/sdkctl.py validate-spec
123-
python scripts/sdkctl.py breaking-check
124-
python scripts/sdkctl.py generate --clean
125-
```
126-
127-
If this new spec is the one you are about to release, update the baseline after validation:
128-
129-
```bash
130-
cp openapi/justserpapi.openapi.json openapi/baseline/justserpapi.openapi.json
131-
```
132-
133-
## Release
134-
135-
Official releases are tag-driven:
136-
137-
```bash
138-
python scripts/sdkctl.py validate-examples
139-
python scripts/sdkctl.py verify-release --tag vX.Y.Z
140-
python -m build
141-
git push origin vX.Y.Z
142-
```
143-
144-
- The package version comes from `justserpapi/_version.py`
145-
- If `openapi/justserpapi.openapi.json` is committed, its `info.version` must match the tag and package version
146-
- GitHub Actions publishes tagged releases to PyPI through Trusted Publishing
147-
148105
## Service Overview
149106

150107
The API list below is generated from OpenAPI and shows the current public API categories and endpoint names. See the [online API documentation](https://docs.justserpapi.com/?utm_source=github.com&utm_medium=referral&utm_campaign=justserpapi_justserpapi_python&utm_content=repo_readme_api_list) for full request and response details.

0 commit comments

Comments
 (0)