diff --git a/.claude/skills/scalar-api-python-sdk/SKILL.md b/.claude/skills/scalar-api-python-sdk/SKILL.md new file mode 100644 index 0000000..fd18c2a --- /dev/null +++ b/.claude/skills/scalar-api-python-sdk/SKILL.md @@ -0,0 +1,70 @@ +--- +name: scalar-api-python-sdk +description: "Python SDK for Scalar API. Use when writing Python code that calls Scalar API with the scalar-sdk package: installing it, constructing and authenticating the client, and calling API operations." +--- + +# Scalar API Python SDK + +Generated Python client for Scalar API, published as `scalar-sdk`. Use the generated client instead of hand-writing HTTP requests. + +## Install + +```sh +pip install scalar-sdk +``` + +## Client setup and authentication + +```python +import os + +from scalar_sdk import Scalar + +client = Scalar( + bearer_auth=os.environ.get("BEARER_AUTH"), +) +``` + +Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them: + +- `bearer_auth` (env: `BEARER_AUTH`) — Credential for the BearerAuth scheme. + +## Calling operations + +```python +import os + +from scalar_sdk import Scalar + +client = Scalar( + bearer_auth=os.environ.get("BEARER_AUTH"), +) + +registry = client.registry.list_all_api_documents() +print(registry) +``` + +Method names, parameter shapes, and response types are generated from the API description — do not guess them. Look up the exact call signature in [api.md](../../../api.md) before writing a call. + +## Error handling + +Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it. + +```python +from scalar_sdk import APIStatusError + +try: + registry = client.registry.list_all_api_documents() +except APIStatusError as err: + print(err.status_code, err.message) + raise +``` + +## Requirements + +- Python 3.8 or newer + +## Reference files + +- [README.md](../../../README.md) — full feature tour: client options, request options, retries and timeouts, logging. +- [api.md](../../../api.md) — complete catalogue of every operation with request and response types. diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml index 8196776..73f93b0 100644 --- a/.github/workflows/release-please.yml +++ b/.github/workflows/release-please.yml @@ -20,6 +20,10 @@ jobs: runs-on: ubuntu-latest outputs: release_created: ${{ steps.release.outputs.release_created }} + # Consumed by the publish job's dispatch: without this mapping the dispatch ref would + # be empty, and `gh workflow run --ref ""` silently falls back to the default branch + # instead of the released tag. + tag_name: ${{ steps.release.outputs.tag_name }} steps: - uses: googleapis/release-please-action@45996ed1f6d02564a971a2fa1b5860e934307cf7 # v5.0.0 id: release @@ -54,9 +58,27 @@ jobs: publish: needs: release-please if: ${{ !cancelled() && needs.release-please.outputs.release_created == 'true' }} + runs-on: ubuntu-latest permissions: - contents: write - id-token: write - packages: write - uses: ./.github/workflows/sdk-release.yml - secrets: inherit + actions: write + steps: + - name: Publish via the release workflow at the released tag + env: + GH_TOKEN: ${{ github.token }} + TAG: ${{ needs.release-please.outputs.tag_name }} + # Dispatch, then watch the run to completion: the dispatch API does not return the run + # it created, so the newest workflow_dispatch run on the tag is polled into view (the + # tag is unique per release, so it can only be this dispatch or an identical manual + # re-publish) and a failed or missing run fails this job loudly. + run: | + gh workflow run sdk-release.yml --repo "${GITHUB_REPOSITORY}" --ref "${TAG}" + for _ in $(seq 1 12); do + sleep 5 + run_id="$(gh run list --repo "${GITHUB_REPOSITORY}" --workflow sdk-release.yml --event workflow_dispatch --branch "${TAG}" --json databaseId --jq '.[0].databaseId // empty')" + [ -n "${run_id}" ] && break + done + if [ -z "${run_id}" ]; then + echo "::error::sdk-release.yml was dispatched for ${TAG} but no run appeared." + exit 1 + fi + gh run watch "${run_id}" --repo "${GITHUB_REPOSITORY}" --exit-status diff --git a/.github/workflows/sdk-release.yml b/.github/workflows/sdk-release.yml index 9744659..c4dac16 100644 --- a/.github/workflows/sdk-release.yml +++ b/.github/workflows/sdk-release.yml @@ -3,10 +3,11 @@ name: Python SDK Release on: release: types: [published] + # Dispatched by release-please.yml at the released tag (the trigger a default-GITHUB_TOKEN + # release can still reach), and available for manual re-publishes. A dispatched run is + # top-level, keeping the OIDC trusted-publisher claims on this file; never add a + # workflow_call trigger here — registries reject publishes from called (reusable) workflows. workflow_dispatch: - # Called by release-please.yml at the released commit; the trigger the default - # GITHUB_TOKEN can actually reach (token-created releases never fire `release`). - workflow_call: permissions: contents: read diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 2be9c43..0ee8c01 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.2.0" + ".": "0.3.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index c6e6c6d..8b2bb5e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,332 @@ # Changelog +## [0.3.0](https://github.com/scalar/scalar-python/compare/v0.2.0...v0.3.0) (2026-07-23) + + +### ⚠ BREAKING CHANGES + +* **api:** 316 breaking changes to the SDK surface. + - `400` error response of `registry.listAllApiDocuments` changed from `_400` to `400`. + - `401` error response of `registry.listAllApiDocuments` changed from `_401` to `401`. + - `403` error response of `registry.listAllApiDocuments` changed from `_403` to `403`. + - `404` error response of `registry.listAllApiDocuments` changed from `_404` to `404`. + - `422` error response of `registry.listAllApiDocuments` changed from `_422` to `422`. + - `500` error response of `registry.listAllApiDocuments` changed from `_500` to `500`. + - `400` error response of `registry.listApiDocuments` changed from `_400` to `400`. + - `401` error response of `registry.listApiDocuments` changed from `_401` to `401`. + - `403` error response of `registry.listApiDocuments` changed from `_403` to `403`. + - `404` error response of `registry.listApiDocuments` changed from `_404` to `404`. + - `422` error response of `registry.listApiDocuments` changed from `_422` to `422`. + - `500` error response of `registry.listApiDocuments` changed from `_500` to `500`. + - `400` error response of `registry.createApiDocument` changed from `_400` to `400`. + - `401` error response of `registry.createApiDocument` changed from `_401` to `401`. + - `403` error response of `registry.createApiDocument` changed from `_403` to `403`. + - `404` error response of `registry.createApiDocument` changed from `_404` to `404`. + - `422` error response of `registry.createApiDocument` changed from `_422` to `422`. + - `500` error response of `registry.createApiDocument` changed from `_500` to `500`. + - `400` error response of `registry.updateApiDocument` changed from `_400` to `400`. + - `401` error response of `registry.updateApiDocument` changed from `_401` to `401`. + - `403` error response of `registry.updateApiDocument` changed from `_403` to `403`. + - `404` error response of `registry.updateApiDocument` changed from `_404` to `404`. + - `422` error response of `registry.updateApiDocument` changed from `_422` to `422`. + - `500` error response of `registry.updateApiDocument` changed from `_500` to `500`. + - `400` error response of `registry.deleteApiDocument` changed from `_400` to `400`. + - `401` error response of `registry.deleteApiDocument` changed from `_401` to `401`. + - `403` error response of `registry.deleteApiDocument` changed from `_403` to `403`. + - `404` error response of `registry.deleteApiDocument` changed from `_404` to `404`. + - `422` error response of `registry.deleteApiDocument` changed from `_422` to `422`. + - `500` error response of `registry.deleteApiDocument` changed from `_500` to `500`. + - `400` error response of `registry.retrieveApiDocumentVersion` changed from `_400` to `400`. + - `401` error response of `registry.retrieveApiDocumentVersion` changed from `_401` to `401`. + - `403` error response of `registry.retrieveApiDocumentVersion` changed from `_403` to `403`. + - `404` error response of `registry.retrieveApiDocumentVersion` changed from `_404` to `404`. + - `422` error response of `registry.retrieveApiDocumentVersion` changed from `_422` to `422`. + - `500` error response of `registry.retrieveApiDocumentVersion` changed from `_500` to `500`. + - `400` error response of `registry.updateApiDocumentVersion` changed from `_400` to `400`. + - `401` error response of `registry.updateApiDocumentVersion` changed from `_401` to `401`. + - `403` error response of `registry.updateApiDocumentVersion` changed from `_403` to `403`. + - `404` error response of `registry.updateApiDocumentVersion` changed from `_404` to `404`. + - `422` error response of `registry.updateApiDocumentVersion` changed from `_422` to `422`. + - `500` error response of `registry.updateApiDocumentVersion` changed from `_500` to `500`. + - `400` error response of `registry.deleteApiDocumentVersion` changed from `_400` to `400`. + - `401` error response of `registry.deleteApiDocumentVersion` changed from `_401` to `401`. + - `403` error response of `registry.deleteApiDocumentVersion` changed from `_403` to `403`. + - `404` error response of `registry.deleteApiDocumentVersion` changed from `_404` to `404`. + - `422` error response of `registry.deleteApiDocumentVersion` changed from `_422` to `422`. + - `500` error response of `registry.deleteApiDocumentVersion` changed from `_500` to `500`. + - Response of `registry.listApiDocumentVersionMetadata` changed from `ManagedDocVersion` to `managed_doc_version`. + - `400` error response of `registry.listApiDocumentVersionMetadata` changed from `_400` to `400`. + - `401` error response of `registry.listApiDocumentVersionMetadata` changed from `_401` to `401`. + - `403` error response of `registry.listApiDocumentVersionMetadata` changed from `_403` to `403`. + - `404` error response of `registry.listApiDocumentVersionMetadata` changed from `_404` to `404`. + - `422` error response of `registry.listApiDocumentVersionMetadata` changed from `_422` to `422`. + - `500` error response of `registry.listApiDocumentVersionMetadata` changed from `_500` to `500`. + - Response of `registry.createApiDocumentVersion` changed from `ManagedDocVersion` to `managed_doc_version`. + - `400` error response of `registry.createApiDocumentVersion` changed from `_400` to `400`. + - `401` error response of `registry.createApiDocumentVersion` changed from `_401` to `401`. + - `403` error response of `registry.createApiDocumentVersion` changed from `_403` to `403`. + - `404` error response of `registry.createApiDocumentVersion` changed from `_404` to `404`. + - `422` error response of `registry.createApiDocumentVersion` changed from `_422` to `422`. + - `500` error response of `registry.createApiDocumentVersion` changed from `_500` to `500`. + - `400` error response of `registry.createApiDocumentAccessGroup` changed from `_400` to `400`. + - `401` error response of `registry.createApiDocumentAccessGroup` changed from `_401` to `401`. + - `403` error response of `registry.createApiDocumentAccessGroup` changed from `_403` to `403`. + - `404` error response of `registry.createApiDocumentAccessGroup` changed from `_404` to `404`. + - `422` error response of `registry.createApiDocumentAccessGroup` changed from `_422` to `422`. + - `500` error response of `registry.createApiDocumentAccessGroup` changed from `_500` to `500`. + - `400` error response of `registry.deleteApiDocumentAccessGroup` changed from `_400` to `400`. + - `401` error response of `registry.deleteApiDocumentAccessGroup` changed from `_401` to `401`. + - `403` error response of `registry.deleteApiDocumentAccessGroup` changed from `_403` to `403`. + - `404` error response of `registry.deleteApiDocumentAccessGroup` changed from `_404` to `404`. + - `422` error response of `registry.deleteApiDocumentAccessGroup` changed from `_422` to `422`. + - `500` error response of `registry.deleteApiDocumentAccessGroup` changed from `_500` to `500`. + - `400` error response of `schemas.list` changed from `_400` to `400`. + - `401` error response of `schemas.list` changed from `_401` to `401`. + - `403` error response of `schemas.list` changed from `_403` to `403`. + - `404` error response of `schemas.list` changed from `_404` to `404`. + - `422` error response of `schemas.list` changed from `_422` to `422`. + - `500` error response of `schemas.list` changed from `_500` to `500`. + - Response of `schemas.create` changed from `Uid` to `uid`. + - `400` error response of `schemas.create` changed from `_400` to `400`. + - `401` error response of `schemas.create` changed from `_401` to `401`. + - `403` error response of `schemas.create` changed from `_403` to `403`. + - `404` error response of `schemas.create` changed from `_404` to `404`. + - `422` error response of `schemas.create` changed from `_422` to `422`. + - `500` error response of `schemas.create` changed from `_500` to `500`. + - `400` error response of `schemas.update` changed from `_400` to `400`. + - `401` error response of `schemas.update` changed from `_401` to `401`. + - `403` error response of `schemas.update` changed from `_403` to `403`. + - `404` error response of `schemas.update` changed from `_404` to `404`. + - `422` error response of `schemas.update` changed from `_422` to `422`. + - `500` error response of `schemas.update` changed from `_500` to `500`. + - `400` error response of `schemas.delete` changed from `_400` to `400`. + - `401` error response of `schemas.delete` changed from `_401` to `401`. + - `403` error response of `schemas.delete` changed from `_403` to `403`. + - `404` error response of `schemas.delete` changed from `_404` to `404`. + - `422` error response of `schemas.delete` changed from `_422` to `422`. + - `500` error response of `schemas.delete` changed from `_500` to `500`. + - `400` error response of `schemas.version.retrieveSchema` changed from `_400` to `400`. + - `401` error response of `schemas.version.retrieveSchema` changed from `_401` to `401`. + - `403` error response of `schemas.version.retrieveSchema` changed from `_403` to `403`. + - `404` error response of `schemas.version.retrieveSchema` changed from `_404` to `404`. + - `422` error response of `schemas.version.retrieveSchema` changed from `_422` to `422`. + - `500` error response of `schemas.version.retrieveSchema` changed from `_500` to `500`. + - `400` error response of `schemas.version.deleteSchema` changed from `_400` to `400`. + - `401` error response of `schemas.version.deleteSchema` changed from `_401` to `401`. + - `403` error response of `schemas.version.deleteSchema` changed from `_403` to `403`. + - `404` error response of `schemas.version.deleteSchema` changed from `_404` to `404`. + - `422` error response of `schemas.version.deleteSchema` changed from `_422` to `422`. + - `500` error response of `schemas.version.deleteSchema` changed from `_500` to `500`. + - Response of `schemas.version.createSchema` changed from `Uid` to `uid`. + - `400` error response of `schemas.version.createSchema` changed from `_400` to `400`. + - `401` error response of `schemas.version.createSchema` changed from `_401` to `401`. + - `403` error response of `schemas.version.createSchema` changed from `_403` to `403`. + - `404` error response of `schemas.version.createSchema` changed from `_404` to `404`. + - `422` error response of `schemas.version.createSchema` changed from `_422` to `422`. + - `500` error response of `schemas.version.createSchema` changed from `_500` to `500`. + - `400` error response of `schemas.accessGroup.createSchema` changed from `_400` to `400`. + - `401` error response of `schemas.accessGroup.createSchema` changed from `_401` to `401`. + - `403` error response of `schemas.accessGroup.createSchema` changed from `_403` to `403`. + - `404` error response of `schemas.accessGroup.createSchema` changed from `_404` to `404`. + - `422` error response of `schemas.accessGroup.createSchema` changed from `_422` to `422`. + - `500` error response of `schemas.accessGroup.createSchema` changed from `_500` to `500`. + - `400` error response of `schemas.accessGroup.deleteSchema` changed from `_400` to `400`. + - `401` error response of `schemas.accessGroup.deleteSchema` changed from `_401` to `401`. + - `403` error response of `schemas.accessGroup.deleteSchema` changed from `_403` to `403`. + - `404` error response of `schemas.accessGroup.deleteSchema` changed from `_404` to `404`. + - `422` error response of `schemas.accessGroup.deleteSchema` changed from `_422` to `422`. + - `500` error response of `schemas.accessGroup.deleteSchema` changed from `_500` to `500`. + - `400` error response of `loginPortals.retrieve` changed from `_400` to `400`. + - `401` error response of `loginPortals.retrieve` changed from `_401` to `401`. + - `403` error response of `loginPortals.retrieve` changed from `_403` to `403`. + - `404` error response of `loginPortals.retrieve` changed from `_404` to `404`. + - `422` error response of `loginPortals.retrieve` changed from `_422` to `422`. + - `500` error response of `loginPortals.retrieve` changed from `_500` to `500`. + - `400` error response of `loginPortals.update` changed from `_400` to `400`. + - `401` error response of `loginPortals.update` changed from `_401` to `401`. + - `403` error response of `loginPortals.update` changed from `_403` to `403`. + - `404` error response of `loginPortals.update` changed from `_404` to `404`. + - `422` error response of `loginPortals.update` changed from `_422` to `422`. + - `500` error response of `loginPortals.update` changed from `_500` to `500`. + - `400` error response of `loginPortals.delete` changed from `_400` to `400`. + - `401` error response of `loginPortals.delete` changed from `_401` to `401`. + - `403` error response of `loginPortals.delete` changed from `_403` to `403`. + - `404` error response of `loginPortals.delete` changed from `_404` to `404`. + - `422` error response of `loginPortals.delete` changed from `_422` to `422`. + - `500` error response of `loginPortals.delete` changed from `_500` to `500`. + - Response of `loginPortals.create` changed from `Uid` to `uid`. + - `400` error response of `loginPortals.create` changed from `_400` to `400`. + - `401` error response of `loginPortals.create` changed from `_401` to `401`. + - `403` error response of `loginPortals.create` changed from `_403` to `403`. + - `404` error response of `loginPortals.create` changed from `_404` to `404`. + - `422` error response of `loginPortals.create` changed from `_422` to `422`. + - `500` error response of `loginPortals.create` changed from `_500` to `500`. + - `400` error response of `loginPortals.list` changed from `_400` to `400`. + - `401` error response of `loginPortals.list` changed from `_401` to `401`. + - `403` error response of `loginPortals.list` changed from `_403` to `403`. + - `404` error response of `loginPortals.list` changed from `_404` to `404`. + - `422` error response of `loginPortals.list` changed from `_422` to `422`. + - `500` error response of `loginPortals.list` changed from `_500` to `500`. + - `400` error response of `rules.listRulesets` changed from `_400` to `400`. + - `401` error response of `rules.listRulesets` changed from `_401` to `401`. + - `403` error response of `rules.listRulesets` changed from `_403` to `403`. + - `404` error response of `rules.listRulesets` changed from `_404` to `404`. + - `422` error response of `rules.listRulesets` changed from `_422` to `422`. + - `500` error response of `rules.listRulesets` changed from `_500` to `500`. + - Response of `rules.createRuleset` changed from `Uid` to `uid`. + - `400` error response of `rules.createRuleset` changed from `_400` to `400`. + - `401` error response of `rules.createRuleset` changed from `_401` to `401`. + - `403` error response of `rules.createRuleset` changed from `_403` to `403`. + - `404` error response of `rules.createRuleset` changed from `_404` to `404`. + - `422` error response of `rules.createRuleset` changed from `_422` to `422`. + - `500` error response of `rules.createRuleset` changed from `_500` to `500`. + - `400` error response of `rules.updateRuleset` changed from `_400` to `400`. + - `401` error response of `rules.updateRuleset` changed from `_401` to `401`. + - `403` error response of `rules.updateRuleset` changed from `_403` to `403`. + - `404` error response of `rules.updateRuleset` changed from `_404` to `404`. + - `422` error response of `rules.updateRuleset` changed from `_422` to `422`. + - `500` error response of `rules.updateRuleset` changed from `_500` to `500`. + - `400` error response of `rules.deleteRuleset` changed from `_400` to `400`. + - `401` error response of `rules.deleteRuleset` changed from `_401` to `401`. + - `403` error response of `rules.deleteRuleset` changed from `_403` to `403`. + - `404` error response of `rules.deleteRuleset` changed from `_404` to `404`. + - `422` error response of `rules.deleteRuleset` changed from `_422` to `422`. + - `500` error response of `rules.deleteRuleset` changed from `_500` to `500`. + - `400` error response of `rules.retrieveRulesetDocument` changed from `_400` to `400`. + - `401` error response of `rules.retrieveRulesetDocument` changed from `_401` to `401`. + - `403` error response of `rules.retrieveRulesetDocument` changed from `_403` to `403`. + - `404` error response of `rules.retrieveRulesetDocument` changed from `_404` to `404`. + - `422` error response of `rules.retrieveRulesetDocument` changed from `_422` to `422`. + - `500` error response of `rules.retrieveRulesetDocument` changed from `_500` to `500`. + - `400` error response of `rules.createRulesetAccessGroup` changed from `_400` to `400`. + - `401` error response of `rules.createRulesetAccessGroup` changed from `_401` to `401`. + - `403` error response of `rules.createRulesetAccessGroup` changed from `_403` to `403`. + - `404` error response of `rules.createRulesetAccessGroup` changed from `_404` to `404`. + - `422` error response of `rules.createRulesetAccessGroup` changed from `_422` to `422`. + - `500` error response of `rules.createRulesetAccessGroup` changed from `_500` to `500`. + - `400` error response of `rules.deleteRulesetAccessGroup` changed from `_400` to `400`. + - `401` error response of `rules.deleteRulesetAccessGroup` changed from `_401` to `401`. + - `403` error response of `rules.deleteRulesetAccessGroup` changed from `_403` to `403`. + - `404` error response of `rules.deleteRulesetAccessGroup` changed from `_404` to `404`. + - `422` error response of `rules.deleteRulesetAccessGroup` changed from `_422` to `422`. + - `500` error response of `rules.deleteRulesetAccessGroup` changed from `_500` to `500`. + - `400` error response of `themes.list` changed from `_400` to `400`. + - `401` error response of `themes.list` changed from `_401` to `401`. + - `403` error response of `themes.list` changed from `_403` to `403`. + - `404` error response of `themes.list` changed from `_404` to `404`. + - `422` error response of `themes.list` changed from `_422` to `422`. + - `500` error response of `themes.list` changed from `_500` to `500`. + - Response of `themes.create` changed from `Uid` to `uid`. + - `400` error response of `themes.create` changed from `_400` to `400`. + - `401` error response of `themes.create` changed from `_401` to `401`. + - `403` error response of `themes.create` changed from `_403` to `403`. + - `404` error response of `themes.create` changed from `_404` to `404`. + - `422` error response of `themes.create` changed from `_422` to `422`. + - `500` error response of `themes.create` changed from `_500` to `500`. + - `400` error response of `themes.update` changed from `_400` to `400`. + - `401` error response of `themes.update` changed from `_401` to `401`. + - `403` error response of `themes.update` changed from `_403` to `403`. + - `404` error response of `themes.update` changed from `_404` to `404`. + - `422` error response of `themes.update` changed from `_422` to `422`. + - `500` error response of `themes.update` changed from `_500` to `500`. + - `400` error response of `themes.replaceDocument` changed from `_400` to `400`. + - `401` error response of `themes.replaceDocument` changed from `_401` to `401`. + - `403` error response of `themes.replaceDocument` changed from `_403` to `403`. + - `404` error response of `themes.replaceDocument` changed from `_404` to `404`. + - `422` error response of `themes.replaceDocument` changed from `_422` to `422`. + - `500` error response of `themes.replaceDocument` changed from `_500` to `500`. + - `400` error response of `themes.delete` changed from `_400` to `400`. + - `401` error response of `themes.delete` changed from `_401` to `401`. + - `403` error response of `themes.delete` changed from `_403` to `403`. + - `404` error response of `themes.delete` changed from `_404` to `404`. + - `422` error response of `themes.delete` changed from `_422` to `422`. + - `500` error response of `themes.delete` changed from `_500` to `500`. + - `400` error response of `themes.retrieve` changed from `_400` to `400`. + - `401` error response of `themes.retrieve` changed from `_401` to `401`. + - `403` error response of `themes.retrieve` changed from `_403` to `403`. + - `404` error response of `themes.retrieve` changed from `_404` to `404`. + - `422` error response of `themes.retrieve` changed from `_422` to `422`. + - `500` error response of `themes.retrieve` changed from `_500` to `500`. + - `400` error response of `teams.list` changed from `_400` to `400`. + - `401` error response of `teams.list` changed from `_401` to `401`. + - `403` error response of `teams.list` changed from `_403` to `403`. + - `404` error response of `teams.list` changed from `_404` to `404`. + - `422` error response of `teams.list` changed from `_422` to `422`. + - `500` error response of `teams.list` changed from `_500` to `500`. + - `400` error response of `scalarDocs.listGuides` changed from `_400` to `400`. + - `401` error response of `scalarDocs.listGuides` changed from `_401` to `401`. + - `403` error response of `scalarDocs.listGuides` changed from `_403` to `403`. + - `404` error response of `scalarDocs.listGuides` changed from `_404` to `404`. + - `422` error response of `scalarDocs.listGuides` changed from `_422` to `422`. + - `500` error response of `scalarDocs.listGuides` changed from `_500` to `500`. + - `400` error response of `scalarDocs.createGuide` changed from `_400` to `400`. + - `401` error response of `scalarDocs.createGuide` changed from `_401` to `401`. + - `403` error response of `scalarDocs.createGuide` changed from `_403` to `403`. + - `404` error response of `scalarDocs.createGuide` changed from `_404` to `404`. + - `422` error response of `scalarDocs.createGuide` changed from `_422` to `422`. + - `500` error response of `scalarDocs.createGuide` changed from `_500` to `500`. + - `400` error response of `scalarDocs.publishGuide` changed from `_400` to `400`. + - `401` error response of `scalarDocs.publishGuide` changed from `_401` to `401`. + - `403` error response of `scalarDocs.publishGuide` changed from `_403` to `403`. + - `404` error response of `scalarDocs.publishGuide` changed from `_404` to `404`. + - `422` error response of `scalarDocs.publishGuide` changed from `_422` to `422`. + - `500` error response of `scalarDocs.publishGuide` changed from `_500` to `500`. + - `400` error response of `namespaces.list` changed from `_400` to `400`. + - `401` error response of `namespaces.list` changed from `_401` to `401`. + - `403` error response of `namespaces.list` changed from `_403` to `403`. + - `404` error response of `namespaces.list` changed from `_404` to `404`. + - `422` error response of `namespaces.list` changed from `_422` to `422`. + - `500` error response of `namespaces.list` changed from `_500` to `500`. + - `400` error response of `authentication.exchangePersonalToken` changed from `_400` to `400`. + - `401` error response of `authentication.exchangePersonalToken` changed from `_401` to `401`. + - `403` error response of `authentication.exchangePersonalToken` changed from `_403` to `403`. + - `404` error response of `authentication.exchangePersonalToken` changed from `_404` to `404`. + - `422` error response of `authentication.exchangePersonalToken` changed from `_422` to `422`. + - `500` error response of `authentication.exchangePersonalToken` changed from `_500` to `500`. + - Response of `authentication.listCurrentUser` changed from `User` to `user`. + - `400` error response of `authentication.listCurrentUser` changed from `_400` to `400`. + - `401` error response of `authentication.listCurrentUser` changed from `_401` to `401`. + - `403` error response of `authentication.listCurrentUser` changed from `_403` to `403`. + - `404` error response of `authentication.listCurrentUser` changed from `_404` to `404`. + - `422` error response of `authentication.listCurrentUser` changed from `_422` to `422`. + - `500` error response of `authentication.listCurrentUser` changed from `_500` to `500`. + - Removed schema `_400`. + - Removed schema `_401`. + - Removed schema `_403`. + - Removed schema `_404`. + - Removed schema `_422`. + - Removed schema `_500`. + - Removed schema `ApiDocument`. + - Removed schema `Nanoid`. + - Removed schema `Version`. + - Removed schema `Slug`. + - Removed schema `Namespace`. + - Removed schema `ManagedDocVersion`. + - Removed schema `Method`. + - Removed schema `AccessGroup`. + - Removed schema `Schema`. + - Removed schema `ManagedSchemaVersion`. + - Removed schema `Timestamp`. + - Removed schema `Uid`. + - Removed schema `LoginPortalEmail`. + - Removed schema `LoginPortalPage`. + - Removed schema `LoginPortal`. + - Removed schema `Rule`. + - Removed schema `Theme`. + - Removed schema `Team`. + - Removed schema `TeamName`. + - Removed schema `TeamImage`. + - Removed schema `GithubProject`. + - Removed schema `ActiveDeployment`. + - Removed schema `GithubProjectRepository`. + - Removed schema `Email`. + - Removed schema `TeamSummary`. + - Removed schema `User`. + +### Features + +* **api:** update SDK surface (349 changes) ([9bd5002](https://github.com/scalar/scalar-python/commit/9bd50023b9158aa5846d56b749a3ea8529a4cd99)) + ## [0.2.0](https://github.com/scalar/scalar-python/compare/v0.1.0...v0.2.0) (2026-07-20) diff --git a/README.md b/README.md index 258da0c..58c0316 100644 --- a/README.md +++ b/README.md @@ -1,74 +1,8 @@ # Scalar API -Generated Python SDK for Scalar API. -API for managing Scalar platform resources. +This library provides convenient access to the Scalar API from Python. -## TypeScript SDK - -For TypeScript, we provide a SDK that makes using our API even easier. - -### Install - -```bash -npm add @scalar/sdk -``` - -### Get a Scalar API key - -Create an API key in your Scalar account: - -- Dashboard: https://dashboard.scalar.com/account -- Store it in `.env`, for example: - -```bash -SCALAR_API_KEY=your_personal_token -``` - -### Exchange your API key for an access token - -The personal token is not an access token. Exchange it first with `postv1AuthExchange`. - -If you use the personal token directly for authenticated API calls, the API returns `401 Invalid authentication token`. - -```ts -import { Scalar } from '@scalar/sdk' - -const scalar = new Scalar() - -const exchange = await scalar.auth.postv1AuthExchange({ - personalToken: process.env.SCALAR_API_KEY!, -}) - -const accessToken = exchange.accessToken -``` - -### Use the access token - -Construct a second client with bearer auth. Use this authenticated client for API calls. - -```ts -import { Scalar } from '@scalar/sdk' - -const scalar = new Scalar() - -const exchange = await scalar.auth.postv1AuthExchange({ - personalToken: process.env.SCALAR_API_KEY!, -}) - -const authedScalar = new Scalar({ - bearerAuth: exchange.accessToken, -}) -``` - -### Notes - -- The exchange request itself can be made from a client constructed with no arguments (`new Scalar()`). -- The exchanged access token is valid for 12 hours. -- Timestamps are Unix seconds. - -### Read more - -- [@scalar/sdk on npm](https://www.npmjs.com/package/@scalar/sdk) +The full API of this library can be found in [api.md](./api.md).
diff --git a/SKILL.md b/SKILL.md new file mode 100644 index 0000000..affd387 --- /dev/null +++ b/SKILL.md @@ -0,0 +1,70 @@ +--- +name: scalar-api-python-sdk +description: "Python SDK for Scalar API. Use when writing Python code that calls Scalar API with the scalar-sdk package: installing it, constructing and authenticating the client, and calling API operations." +--- + +# Scalar API Python SDK + +Generated Python client for Scalar API, published as `scalar-sdk`. Use the generated client instead of hand-writing HTTP requests. + +## Install + +```sh +pip install scalar-sdk +``` + +## Client setup and authentication + +```python +import os + +from scalar_sdk import Scalar + +client = Scalar( + bearer_auth=os.environ.get("BEARER_AUTH"), +) +``` + +Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them: + +- `bearer_auth` (env: `BEARER_AUTH`) — Credential for the BearerAuth scheme. + +## Calling operations + +```python +import os + +from scalar_sdk import Scalar + +client = Scalar( + bearer_auth=os.environ.get("BEARER_AUTH"), +) + +registry = client.registry.list_all_api_documents() +print(registry) +``` + +Method names, parameter shapes, and response types are generated from the API description — do not guess them. Look up the exact call signature in [api.md](./api.md) before writing a call. + +## Error handling + +Non-success responses throw generated API errors. Error objects expose status, headers, response body, and request metadata where the target runtime supports it. + +```python +from scalar_sdk import APIStatusError + +try: + registry = client.registry.list_all_api_documents() +except APIStatusError as err: + print(err.status_code, err.message) + raise +``` + +## Requirements + +- Python 3.8 or newer + +## Reference files + +- [README.md](./README.md) — full feature tour: client options, request options, retries and timeouts, logging. +- [api.md](./api.md) — complete catalogue of every operation with request and response types. diff --git a/VERSIONING.md b/VERSIONING.md index 558b597..b465e15 100644 --- a/VERSIONING.md +++ b/VERSIONING.md @@ -57,3 +57,10 @@ different fixes: released state back from the release workflow. - No Actions settings changes are required: the generated workflows declare their own permissions and never create pull requests. +- If this package publishes through OIDC trusted publishing (for example PyPI or npm), + register the trusted publisher on the registry against the **`sdk-release.yml`** + workflow filename — not `release-please.yml`. Merging a release PR dispatches + `sdk-release.yml` at the released tag, so every publish path (automated, manual + re-publish, human-created release) runs it as a top-level workflow whose OIDC claims + name that file. If the publish job is configured with a deployment environment, + include that environment in the registration too. diff --git a/api.md b/api.md index 7191eb6..a1f9c06 100644 --- a/api.md +++ b/api.md @@ -82,7 +82,7 @@ List all API documents across every namespace the caller can access. | Direction | Type | | --- | --- | -| Response | [`RegistryListAllApiDocumentsResponse`](./src/types/registry_list_all_api_documents_response.py) | +| Response | [`RegistryListAllAPIDocumentsResponse`](./src/types/registry_list_all_api_documents_response.py) | ```python registry = client.registry.list_all_api_documents() @@ -94,7 +94,7 @@ List API documents in a namespace. | Direction | Type | | --- | --- | -| Response | [`RegistryListApiDocumentsResponse`](./src/types/registry_list_api_documents_response.py) | +| Response | [`RegistryListAPIDocumentsResponse`](./src/types/registry_list_api_documents_response.py) | ```python registry = client.registry.list_api_documents( @@ -108,8 +108,8 @@ Create an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryCreateApiDocumentParams`](./src/types/registry_create_api_document_params.py) | -| Response | [`RegistryCreateApiDocumentResponse`](./src/types/registry_create_api_document_response.py) | +| Request | [`RegistryCreateAPIDocumentParams`](./src/types/registry_create_api_document_params.py) | +| Response | [`RegistryCreateAPIDocumentResponse`](./src/types/registry_create_api_document_response.py) | ```python registry = client.registry.create_api_document( @@ -127,8 +127,8 @@ Update metadata for an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryUpdateApiDocumentParams`](./src/types/registry_update_api_document_params.py) | -| Response | [`RegistryUpdateApiDocumentResponse`](./src/types/registry_update_api_document_response.py) | +| Request | [`RegistryUpdateAPIDocumentParams`](./src/types/registry_update_api_document_params.py) | +| Response | [`RegistryUpdateAPIDocumentResponse`](./src/types/registry_update_api_document_response.py) | ```python registry = client.registry.update_api_document( @@ -143,7 +143,7 @@ Delete an API document and all versions. | Direction | Type | | --- | --- | -| Response | [`RegistryDeleteApiDocumentResponse`](./src/types/registry_delete_api_document_response.py) | +| Response | [`RegistryDeleteAPIDocumentResponse`](./src/types/registry_delete_api_document_response.py) | ```python registry = client.registry.delete_api_document( @@ -158,7 +158,7 @@ Get a specific API document version. | Direction | Type | | --- | --- | -| Response | [`RegistryRetrieveApiDocumentVersionResponse`](./src/types/registry_retrieve_api_document_version_response.py) | +| Response | [`RegistryRetrieveAPIDocumentVersionResponse`](./src/types/registry_retrieve_api_document_version_response.py) | ```python registry = client.registry.retrieve_api_document_version( @@ -174,8 +174,8 @@ Update the registry file content for an API document version. | Direction | Type | | --- | --- | -| Request | [`RegistryUpdateApiDocumentVersionParams`](./src/types/registry_update_api_document_version_params.py) | -| Response | [`RegistryUpdateApiDocumentVersionResponse`](./src/types/registry_update_api_document_version_response.py) | +| Request | [`RegistryUpdateAPIDocumentVersionParams`](./src/types/registry_update_api_document_version_params.py) | +| Response | [`RegistryUpdateAPIDocumentVersionResponse`](./src/types/registry_update_api_document_version_response.py) | ```python registry = client.registry.update_api_document_version( @@ -192,7 +192,7 @@ Delete a specific API document version. | Direction | Type | | --- | --- | -| Response | [`RegistryDeleteApiDocumentVersionResponse`](./src/types/registry_delete_api_document_version_response.py) | +| Response | [`RegistryDeleteAPIDocumentVersionResponse`](./src/types/registry_delete_api_document_version_response.py) | ```python registry = client.registry.delete_api_document_version( @@ -208,7 +208,7 @@ Get metadata (uid, content shas, version sha, tags) for a specific API document | Direction | Type | | --- | --- | -| Response | [`RegistryListApiDocumentVersionMetadataResponse`](./src/types/registry_list_api_document_version_metadata_response.py) | +| Response | [`RegistryListAPIDocumentVersionMetadataResponse`](./src/types/registry_list_api_document_version_metadata_response.py) | ```python registry = client.registry.list_api_document_version_metadata( @@ -224,8 +224,8 @@ Create a new API document version. | Direction | Type | | --- | --- | -| Request | [`RegistryCreateApiDocumentVersionParams`](./src/types/registry_create_api_document_version_params.py) | -| Response | [`RegistryCreateApiDocumentVersionResponse`](./src/types/registry_create_api_document_version_response.py) | +| Request | [`RegistryCreateAPIDocumentVersionParams`](./src/types/registry_create_api_document_version_params.py) | +| Response | [`RegistryCreateAPIDocumentVersionResponse`](./src/types/registry_create_api_document_version_response.py) | ```python registry = client.registry.create_api_document_version( @@ -242,8 +242,8 @@ Add an access group to an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryCreateApiDocumentAccessGroupParams`](./src/types/registry_create_api_document_access_group_params.py) | -| Response | [`RegistryCreateApiDocumentAccessGroupResponse`](./src/types/registry_create_api_document_access_group_response.py) | +| Request | [`RegistryCreateAPIDocumentAccessGroupParams`](./src/types/registry_create_api_document_access_group_params.py) | +| Response | [`RegistryCreateAPIDocumentAccessGroupResponse`](./src/types/registry_create_api_document_access_group_response.py) | ```python registry = client.registry.create_api_document_access_group( @@ -259,8 +259,8 @@ Remove an access group from an API document. | Direction | Type | | --- | --- | -| Request | [`RegistryDeleteApiDocumentAccessGroupParams`](./src/types/registry_delete_api_document_access_group_params.py) | -| Response | [`RegistryDeleteApiDocumentAccessGroupResponse`](./src/types/registry_delete_api_document_access_group_response.py) | +| Request | [`RegistryDeleteAPIDocumentAccessGroupParams`](./src/types/registry_delete_api_document_access_group_params.py) | +| Response | [`RegistryDeleteAPIDocumentAccessGroupResponse`](./src/types/registry_delete_api_document_access_group_response.py) | ```python registry = client.registry.delete_api_document_access_group( diff --git a/openapi.augmented.json b/openapi.augmented.json index 0209f91..30b3d70 100644 --- a/openapi.augmented.json +++ b/openapi.augmented.json @@ -16,7 +16,7 @@ }, { "lang": "Python", - "description": "```sh\npip install scalarApi\n```" + "description": "```sh\npip install scalar-sdk\n```" }, { "lang": "Go", diff --git a/pyproject.toml b/pyproject.toml index ce00524..84f23a7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "scalar-sdk" -version = "0.2.0" # x-release-please-version +version = "0.3.0" # x-release-please-version description = "API for managing Scalar platform resources.\n\n## TypeScript SDK\n\nFor TypeScript, we provide a SDK that makes using our API even easier.\n\n### Install\n\n```bash\nnpm add @scalar/sdk\n```\n\n### Get a Scalar API key\n\nCreate an API key in your Scalar account:\n\n- Dashboard: https://dashboard.scalar.com/account\n- Store it in `.env`, for example:\n\n```bash\nSCALAR_API_KEY=your_personal_token\n```\n\n### Exchange your API key for an access token\n\nThe personal token is not an access token. Exchange it first with `postv1AuthExchange`.\n\nIf you use the personal token directly for authenticated API calls, the API returns `401 Invalid authentication token`.\n\n```ts\nimport { Scalar } from '@scalar/sdk'\n\nconst scalar = new Scalar()\n\nconst exchange = await scalar.auth.postv1AuthExchange({\n personalToken: process.env.SCALAR_API_KEY!,\n})\n\nconst accessToken = exchange.accessToken\n```\n\n### Use the access token\n\nConstruct a second client with bearer auth. Use this authenticated client for API calls.\n\n```ts\nimport { Scalar } from '@scalar/sdk'\n\nconst scalar = new Scalar()\n\nconst exchange = await scalar.auth.postv1AuthExchange({\n personalToken: process.env.SCALAR_API_KEY!,\n})\n\nconst authedScalar = new Scalar({\n bearerAuth: exchange.accessToken,\n})\n```\n\n### Notes\n\n- The exchange request itself can be made from a client constructed with no arguments (`new Scalar()`).\n- The exchanged access token is valid for 12 hours.\n- Timestamps are Unix seconds.\n\n### Read more\n\n- [@scalar/sdk on npm](https://www.npmjs.com/package/@scalar/sdk)" license = "Apache-2.0" requires-python = ">= 3.9" diff --git a/scalar-sdk.manifest.json b/scalar-sdk.manifest.json index 900180e..c7d5569 100644 --- a/scalar-sdk.manifest.json +++ b/scalar-sdk.manifest.json @@ -1,7 +1,7 @@ { "name": "ScalarApi", "slug": "scalarApi", - "generatorVersion": "0.19.1", + "generatorVersion": "0.19.4", "servers": [ "https://access.scalar.com" ], @@ -24,8 +24,8 @@ "clientHeaderParams": [], "schemas": [ { - "name": "_400", - "source": "_400", + "name": "400", + "source": "400", "publicAliases": [], "deprecated": false, "type": { @@ -56,8 +56,8 @@ } }, { - "name": "_401", - "source": "_401", + "name": "401", + "source": "401", "publicAliases": [], "deprecated": false, "type": { @@ -88,8 +88,8 @@ } }, { - "name": "_403", - "source": "_403", + "name": "403", + "source": "403", "publicAliases": [], "deprecated": false, "type": { @@ -120,8 +120,8 @@ } }, { - "name": "_404", - "source": "_404", + "name": "404", + "source": "404", "publicAliases": [], "deprecated": false, "type": { @@ -152,8 +152,8 @@ } }, { - "name": "_422", - "source": "_422", + "name": "422", + "source": "422", "publicAliases": [], "deprecated": false, "type": { @@ -184,8 +184,8 @@ } }, { - "name": "_500", - "source": "_500", + "name": "500", + "source": "500", "publicAliases": [], "deprecated": false, "type": { @@ -216,8 +216,8 @@ } }, { - "name": "ApiDocument", - "source": "ApiDocument", + "name": "api_document", + "source": "api_document", "publicAliases": [], "deprecated": false, "type": { @@ -230,7 +230,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -240,7 +240,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Version" + "name": "version" } }, { @@ -263,7 +263,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } }, { @@ -283,7 +283,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Namespace" + "name": "namespace" } }, { @@ -314,7 +314,7 @@ "kind": "array", "items": { "kind": "ref", - "name": "ManagedDocVersion" + "name": "managed_doc_version" } } } @@ -323,8 +323,8 @@ } }, { - "name": "Nanoid", - "source": "Nanoid", + "name": "nanoid", + "source": "nanoid", "publicAliases": [], "deprecated": false, "type": { @@ -336,8 +336,8 @@ } }, { - "name": "Version", - "source": "Version", + "name": "version", + "source": "version", "publicAliases": [], "deprecated": false, "type": { @@ -349,8 +349,8 @@ } }, { - "name": "Slug", - "source": "Slug", + "name": "slug", + "source": "slug", "publicAliases": [], "deprecated": false, "type": { @@ -364,8 +364,8 @@ } }, { - "name": "Namespace", - "source": "Namespace", + "name": "namespace", + "source": "namespace", "publicAliases": [], "deprecated": false, "type": { @@ -379,8 +379,8 @@ } }, { - "name": "ManagedDocVersion", - "source": "ManagedDocVersion", + "name": "managed_doc_version", + "source": "managed_doc_version", "publicAliases": [], "deprecated": false, "type": { @@ -393,7 +393,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -413,7 +413,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Version" + "name": "version" } }, { @@ -495,7 +495,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Method" + "name": "method" } }, { @@ -562,8 +562,8 @@ } }, { - "name": "Method", - "source": "Method", + "name": "method", + "source": "method", "publicAliases": [], "deprecated": false, "type": { @@ -601,8 +601,8 @@ } }, { - "name": "AccessGroup", - "source": "AccessGroup", + "name": "access_group", + "source": "access_group", "publicAliases": [], "deprecated": false, "type": { @@ -615,7 +615,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } } ], @@ -623,8 +623,8 @@ } }, { - "name": "Schema", - "source": "Schema", + "name": "schema", + "source": "schema", "publicAliases": [], "deprecated": false, "type": { @@ -637,7 +637,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -670,7 +670,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } }, { @@ -680,7 +680,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Namespace" + "name": "namespace" } }, { @@ -702,7 +702,7 @@ "kind": "array", "items": { "kind": "ref", - "name": "ManagedSchemaVersion" + "name": "managed_schema_version" } } } @@ -711,8 +711,8 @@ } }, { - "name": "ManagedSchemaVersion", - "source": "ManagedSchemaVersion", + "name": "managed_schema_version", + "source": "managed_schema_version", "publicAliases": [], "deprecated": false, "type": { @@ -725,7 +725,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -735,7 +735,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" } }, { @@ -745,7 +745,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" } }, { @@ -755,7 +755,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Version" + "name": "version" } } ], @@ -763,8 +763,8 @@ } }, { - "name": "Timestamp", - "source": "Timestamp", + "name": "timestamp", + "source": "timestamp", "publicAliases": [], "deprecated": false, "type": { @@ -774,8 +774,8 @@ } }, { - "name": "Uid", - "source": "Uid", + "name": "uid", + "source": "uid", "publicAliases": [], "deprecated": false, "type": { @@ -788,7 +788,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } } ], @@ -796,8 +796,8 @@ } }, { - "name": "LoginPortalEmail", - "source": "LoginPortalEmail", + "name": "login_portal_email", + "source": "login_portal_email", "publicAliases": [], "deprecated": false, "type": { @@ -945,8 +945,8 @@ } }, { - "name": "LoginPortalPage", - "source": "LoginPortalPage", + "name": "login_portal_page", + "source": "login_portal_page", "publicAliases": [], "deprecated": false, "type": { @@ -1112,8 +1112,8 @@ } }, { - "name": "LoginPortal", - "source": "LoginPortal", + "name": "login_portal", + "source": "login_portal", "publicAliases": [], "deprecated": false, "type": { @@ -1126,7 +1126,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -1149,7 +1149,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } } ], @@ -1157,8 +1157,8 @@ } }, { - "name": "Rule", - "source": "Rule", + "name": "rule", + "source": "rule", "publicAliases": [], "deprecated": false, "type": { @@ -1171,7 +1171,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -1204,7 +1204,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } }, { @@ -1214,7 +1214,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Namespace" + "name": "namespace" } }, { @@ -1232,8 +1232,8 @@ } }, { - "name": "Theme", - "source": "Theme", + "name": "theme", + "source": "theme", "publicAliases": [], "deprecated": false, "type": { @@ -1246,7 +1246,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -1276,7 +1276,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } } ], @@ -1284,8 +1284,8 @@ } }, { - "name": "Team", - "source": "Team", + "name": "team", + "source": "team", "publicAliases": [], "deprecated": false, "type": { @@ -1298,7 +1298,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -1308,7 +1308,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "TeamName" + "name": "team_name" } }, { @@ -1318,7 +1318,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "TeamImage" + "name": "team_image" } }, { @@ -1328,7 +1328,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } }, { @@ -1346,8 +1346,8 @@ } }, { - "name": "TeamName", - "source": "TeamName", + "name": "team_name", + "source": "team_name", "publicAliases": [], "deprecated": false, "type": { @@ -1356,8 +1356,8 @@ } }, { - "name": "TeamImage", - "source": "TeamImage", + "name": "team_image", + "source": "team_image", "publicAliases": [], "deprecated": false, "type": { @@ -1366,8 +1366,8 @@ } }, { - "name": "GithubProject", - "source": "GithubProject", + "name": "github_project", + "source": "github_project", "publicAliases": [], "deprecated": false, "type": { @@ -1380,7 +1380,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -1390,7 +1390,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" } }, { @@ -1400,7 +1400,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" } }, { @@ -1423,7 +1423,7 @@ "variants": [ { "kind": "ref", - "name": "ActiveDeployment" + "name": "active_deployment" }, { "kind": "null" @@ -1441,7 +1441,7 @@ "variants": [ { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" }, { "kind": "null" @@ -1533,7 +1533,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Slug" + "name": "slug" } }, { @@ -1566,7 +1566,7 @@ "variants": [ { "kind": "ref", - "name": "GithubProjectRepository" + "name": "github_project_repository" }, { "kind": "null" @@ -1579,8 +1579,8 @@ } }, { - "name": "ActiveDeployment", - "source": "ActiveDeployment", + "name": "active_deployment", + "source": "active_deployment", "publicAliases": [], "deprecated": false, "type": { @@ -1613,7 +1613,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" } } ], @@ -1621,8 +1621,8 @@ } }, { - "name": "GithubProjectRepository", - "source": "GithubProjectRepository", + "name": "github_project_repository", + "source": "github_project_repository", "publicAliases": [], "deprecated": false, "type": { @@ -1726,8 +1726,8 @@ } }, { - "name": "Email", - "source": "Email", + "name": "email", + "source": "email", "publicAliases": [], "deprecated": false, "type": { @@ -1740,8 +1740,8 @@ } }, { - "name": "TeamSummary", - "source": "TeamSummary", + "name": "team_summary", + "source": "team_summary", "publicAliases": [], "deprecated": false, "type": { @@ -1754,7 +1754,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -1764,7 +1764,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "TeamName" + "name": "team_name" } }, { @@ -1774,7 +1774,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "TeamImage" + "name": "team_image" } } ], @@ -1782,8 +1782,8 @@ } }, { - "name": "User", - "source": "User", + "name": "user", + "source": "user", "publicAliases": [], "deprecated": false, "type": { @@ -1796,7 +1796,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Nanoid" + "name": "nanoid" } }, { @@ -1806,7 +1806,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" } }, { @@ -1816,7 +1816,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Timestamp" + "name": "timestamp" } }, { @@ -1826,7 +1826,7 @@ "deprecated": false, "type": { "kind": "ref", - "name": "Email" + "name": "email" } }, { @@ -1876,7 +1876,7 @@ "kind": "array", "items": { "kind": "ref", - "name": "TeamSummary" + "name": "team_summary" } } } @@ -1969,7 +1969,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -1984,7 +1984,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -1999,7 +1999,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -2014,7 +2014,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -2029,7 +2029,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -2044,7 +2044,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -2123,7 +2123,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -2138,7 +2138,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -2153,7 +2153,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -2168,7 +2168,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -2183,7 +2183,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -2198,7 +2198,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -2335,7 +2335,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -2350,7 +2350,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -2365,7 +2365,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -2380,7 +2380,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -2395,7 +2395,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -2410,7 +2410,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -2537,7 +2537,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -2552,7 +2552,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -2567,7 +2567,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -2582,7 +2582,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -2597,7 +2597,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -2612,7 +2612,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -2699,7 +2699,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -2714,7 +2714,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -2729,7 +2729,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -2744,7 +2744,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -2759,7 +2759,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -2774,7 +2774,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -2869,7 +2869,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -2884,7 +2884,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -2899,7 +2899,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -2914,7 +2914,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -2929,7 +2929,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -2944,7 +2944,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -3067,7 +3067,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -3082,7 +3082,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -3097,7 +3097,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -3112,7 +3112,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -3127,7 +3127,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -3142,7 +3142,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -3237,7 +3237,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -3252,7 +3252,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -3267,7 +3267,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -3282,7 +3282,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -3297,7 +3297,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -3312,7 +3312,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -3385,7 +3385,7 @@ ] }, "responseModel": { - "name": "ManagedDocVersion", + "name": "managed_doc_version", "publicAliases": [] }, "result": { @@ -3411,7 +3411,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -3426,7 +3426,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -3441,7 +3441,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -3456,7 +3456,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -3471,7 +3471,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -3486,7 +3486,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -3591,7 +3591,7 @@ ] }, "responseModel": { - "name": "ManagedDocVersion", + "name": "managed_doc_version", "publicAliases": [] }, "result": { @@ -3617,7 +3617,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -3632,7 +3632,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -3647,7 +3647,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -3662,7 +3662,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -3677,7 +3677,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -3692,7 +3692,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -3801,7 +3801,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -3816,7 +3816,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -3831,7 +3831,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -3846,7 +3846,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -3861,7 +3861,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -3876,7 +3876,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -3985,7 +3985,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -4000,7 +4000,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -4015,7 +4015,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -4030,7 +4030,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -4045,7 +4045,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -4060,7 +4060,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -4139,7 +4139,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -4154,7 +4154,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -4169,7 +4169,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -4184,7 +4184,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -4199,7 +4199,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -4214,7 +4214,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -4323,7 +4323,7 @@ ] }, "responseModel": { - "name": "Uid", + "name": "uid", "publicAliases": [] }, "result": { @@ -4349,7 +4349,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -4364,7 +4364,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -4379,7 +4379,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -4394,7 +4394,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -4409,7 +4409,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -4424,7 +4424,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -4545,7 +4545,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -4560,7 +4560,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -4575,7 +4575,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -4590,7 +4590,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -4605,7 +4605,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -4620,7 +4620,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -4707,7 +4707,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -4722,7 +4722,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -4737,7 +4737,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -4752,7 +4752,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -4767,7 +4767,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -4782,7 +4782,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -4877,7 +4877,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -4892,7 +4892,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -4907,7 +4907,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -4922,7 +4922,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -4937,7 +4937,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -4952,7 +4952,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -5047,7 +5047,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -5062,7 +5062,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -5077,7 +5077,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -5092,7 +5092,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -5107,7 +5107,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -5122,7 +5122,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -5215,7 +5215,7 @@ ] }, "responseModel": { - "name": "Uid", + "name": "uid", "publicAliases": [] }, "result": { @@ -5241,7 +5241,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -5256,7 +5256,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -5271,7 +5271,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -5286,7 +5286,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -5301,7 +5301,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -5316,7 +5316,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -5425,7 +5425,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -5440,7 +5440,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -5455,7 +5455,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -5470,7 +5470,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -5485,7 +5485,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -5500,7 +5500,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -5609,7 +5609,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -5624,7 +5624,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -5639,7 +5639,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -5654,7 +5654,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -5669,7 +5669,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -5684,7 +5684,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -5763,7 +5763,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -5778,7 +5778,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -5793,7 +5793,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -5808,7 +5808,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -5823,7 +5823,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -5838,7 +5838,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -5939,7 +5939,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -5954,7 +5954,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -5969,7 +5969,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -5984,7 +5984,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -5999,7 +5999,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -6014,7 +6014,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -6093,7 +6093,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -6108,7 +6108,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -6123,7 +6123,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -6138,7 +6138,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -6153,7 +6153,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -6168,7 +6168,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -6254,7 +6254,7 @@ ] }, "responseModel": { - "name": "Uid", + "name": "uid", "publicAliases": [] }, "result": { @@ -6280,7 +6280,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -6295,7 +6295,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -6310,7 +6310,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -6325,7 +6325,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -6340,7 +6340,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -6355,7 +6355,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -6420,7 +6420,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -6435,7 +6435,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -6450,7 +6450,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -6465,7 +6465,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -6480,7 +6480,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -6495,7 +6495,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -6574,7 +6574,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -6589,7 +6589,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -6604,7 +6604,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -6619,7 +6619,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -6634,7 +6634,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -6649,7 +6649,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -6752,7 +6752,7 @@ ] }, "responseModel": { - "name": "Uid", + "name": "uid", "publicAliases": [] }, "result": { @@ -6778,7 +6778,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -6793,7 +6793,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -6808,7 +6808,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -6823,7 +6823,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -6838,7 +6838,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -6853,7 +6853,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -6986,7 +6986,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -7001,7 +7001,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -7016,7 +7016,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -7031,7 +7031,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -7046,7 +7046,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -7061,7 +7061,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -7148,7 +7148,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -7163,7 +7163,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -7178,7 +7178,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -7193,7 +7193,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -7208,7 +7208,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -7223,7 +7223,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -7310,7 +7310,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -7325,7 +7325,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -7340,7 +7340,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -7355,7 +7355,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -7370,7 +7370,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -7385,7 +7385,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -7494,7 +7494,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -7509,7 +7509,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -7524,7 +7524,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -7539,7 +7539,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -7554,7 +7554,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -7569,7 +7569,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -7678,7 +7678,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -7693,7 +7693,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -7708,7 +7708,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -7723,7 +7723,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -7738,7 +7738,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -7753,7 +7753,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -7818,7 +7818,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -7833,7 +7833,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -7848,7 +7848,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -7863,7 +7863,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -7878,7 +7878,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -7893,7 +7893,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -7979,7 +7979,7 @@ ] }, "responseModel": { - "name": "Uid", + "name": "uid", "publicAliases": [] }, "result": { @@ -8005,7 +8005,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -8020,7 +8020,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -8035,7 +8035,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -8050,7 +8050,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -8065,7 +8065,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -8080,7 +8080,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -8187,7 +8187,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -8202,7 +8202,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -8217,7 +8217,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -8232,7 +8232,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -8247,7 +8247,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -8262,7 +8262,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -8363,7 +8363,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -8378,7 +8378,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -8393,7 +8393,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -8408,7 +8408,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -8423,7 +8423,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -8438,7 +8438,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -8517,7 +8517,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -8532,7 +8532,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -8547,7 +8547,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -8562,7 +8562,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -8577,7 +8577,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -8592,7 +8592,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -8671,7 +8671,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -8686,7 +8686,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -8701,7 +8701,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -8716,7 +8716,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -8731,7 +8731,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -8746,7 +8746,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -8811,7 +8811,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -8826,7 +8826,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -8841,7 +8841,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -8856,7 +8856,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -8871,7 +8871,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -8886,7 +8886,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -8951,7 +8951,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -8966,7 +8966,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -8981,7 +8981,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -8996,7 +8996,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -9011,7 +9011,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -9026,7 +9026,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -9140,7 +9140,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -9155,7 +9155,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -9170,7 +9170,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -9185,7 +9185,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -9200,7 +9200,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -9215,7 +9215,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -9294,7 +9294,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -9309,7 +9309,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -9324,7 +9324,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -9339,7 +9339,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -9354,7 +9354,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -9369,7 +9369,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -9434,7 +9434,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -9449,7 +9449,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -9464,7 +9464,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -9479,7 +9479,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -9494,7 +9494,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -9509,7 +9509,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -9599,7 +9599,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -9614,7 +9614,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -9629,7 +9629,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -9644,7 +9644,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -9659,7 +9659,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -9674,7 +9674,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } @@ -9717,7 +9717,7 @@ ] }, "responseModel": { - "name": "User", + "name": "user", "publicAliases": [] }, "result": { @@ -9743,7 +9743,7 @@ } ], "model": { - "name": "_400", + "name": "400", "publicAliases": [] } }, @@ -9758,7 +9758,7 @@ } ], "model": { - "name": "_401", + "name": "401", "publicAliases": [] } }, @@ -9773,7 +9773,7 @@ } ], "model": { - "name": "_403", + "name": "403", "publicAliases": [] } }, @@ -9788,7 +9788,7 @@ } ], "model": { - "name": "_404", + "name": "404", "publicAliases": [] } }, @@ -9803,7 +9803,7 @@ } ], "model": { - "name": "_422", + "name": "422", "publicAliases": [] } }, @@ -9818,7 +9818,7 @@ } ], "model": { - "name": "_500", + "name": "500", "publicAliases": [] } } diff --git a/src/_version.py b/src/_version.py index 36918f7..deea26d 100644 --- a/src/_version.py +++ b/src/_version.py @@ -1,4 +1,4 @@ # File generated from our OpenAPI spec by Scalar. See README.md for details. __title__ = "scalarApi" -__version__ = "0.2.0" # x-release-please-version +__version__ = "0.3.0" # x-release-please-version diff --git a/src/resources/login_portals.py b/src/resources/login_portals.py index 891ac5e..4c66fa1 100644 --- a/src/resources/login_portals.py +++ b/src/resources/login_portals.py @@ -20,8 +20,8 @@ from ..types import login_portal_update_params, login_portal_create_params from ..types.login_portal_delete_response import LoginPortalDeleteResponse from ..types.login_portal_create_response import LoginPortalCreateResponse -from ..types.shared_params.login_portal_email import LoginPortalEmail -from ..types.shared_params.login_portal_page import LoginPortalPage +from ..types.login_portal_email_param import LoginPortalEmailParam +from ..types.login_portal_page_param import LoginPortalPageParam from ..types.login_portal_list_response import LoginPortalListResponse, LoginPortal __all__ = ["LoginPortalsResource", "AsyncLoginPortalsResource"] @@ -165,8 +165,8 @@ def create( *, title: str, slug: str, - email: LoginPortalEmail, - page: LoginPortalPage, + email: LoginPortalEmailParam, + page: LoginPortalPageParam, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, @@ -387,8 +387,8 @@ async def create( *, title: str, slug: str, - email: LoginPortalEmail, - page: LoginPortalPage, + email: LoginPortalEmailParam, + page: LoginPortalPageParam, # Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs. # The extra values given here take precedence over values defined on the client or passed to this method. extra_headers: Headers | None = None, diff --git a/src/resources/registry.py b/src/resources/registry.py index 67adc15..c832eee 100644 --- a/src/resources/registry.py +++ b/src/resources/registry.py @@ -15,20 +15,20 @@ async_to_streamed_response_wrapper, ) from .._base_client import make_request_options -from ..types.registry_list_all_api_documents_response import RegistryListAllApiDocumentsResponse, ApiDocument, ManagedDocVersion, Tool -from ..types.registry_list_api_documents_response import RegistryListApiDocumentsResponse, ApiDocument, ManagedDocVersion, Tool -from ..types.registry_create_api_document_response import RegistryCreateApiDocumentResponse +from ..types.registry_list_all_api_documents_response import RegistryListAllAPIDocumentsResponse, APIDocument, ManagedDocVersion, Tool +from ..types.registry_list_api_documents_response import RegistryListAPIDocumentsResponse, APIDocument, ManagedDocVersion, Tool +from ..types.registry_create_api_document_response import RegistryCreateAPIDocumentResponse from ..types.version import Version from ..types import registry_create_api_document_params, registry_update_api_document_params, registry_update_api_document_version_params, registry_create_api_document_version_params, registry_create_api_document_access_group_params, registry_delete_api_document_access_group_params -from ..types.registry_update_api_document_response import RegistryUpdateApiDocumentResponse -from ..types.registry_delete_api_document_response import RegistryDeleteApiDocumentResponse -from ..types.registry_update_api_document_version_response import RegistryUpdateApiDocumentVersionResponse -from ..types.registry_delete_api_document_version_response import RegistryDeleteApiDocumentVersionResponse -from ..types.registry_list_api_document_version_metadata_response import RegistryListApiDocumentVersionMetadataResponse, Tool -from ..types.registry_create_api_document_version_response import RegistryCreateApiDocumentVersionResponse, Tool -from ..types.registry_create_api_document_access_group_response import RegistryCreateApiDocumentAccessGroupResponse +from ..types.registry_update_api_document_response import RegistryUpdateAPIDocumentResponse +from ..types.registry_delete_api_document_response import RegistryDeleteAPIDocumentResponse +from ..types.registry_update_api_document_version_response import RegistryUpdateAPIDocumentVersionResponse +from ..types.registry_delete_api_document_version_response import RegistryDeleteAPIDocumentVersionResponse +from ..types.registry_list_api_document_version_metadata_response import RegistryListAPIDocumentVersionMetadataResponse, Tool +from ..types.registry_create_api_document_version_response import RegistryCreateAPIDocumentVersionResponse, Tool +from ..types.registry_create_api_document_access_group_response import RegistryCreateAPIDocumentAccessGroupResponse from ..types.slug import Slug -from ..types.registry_delete_api_document_access_group_response import RegistryDeleteApiDocumentAccessGroupResponse +from ..types.registry_delete_api_document_access_group_response import RegistryDeleteAPIDocumentAccessGroupResponse __all__ = ["RegistryResource", "AsyncRegistryResource"] @@ -52,7 +52,7 @@ def list_all_api_documents( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryListAllApiDocumentsResponse: + ) -> RegistryListAllAPIDocumentsResponse: """ List all API documents across every namespace the caller can access. @@ -63,7 +63,7 @@ def list_all_api_documents( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryListAllApiDocumentsResponse: Default Response + RegistryListAllAPIDocumentsResponse: Default Response Example: ```python @@ -73,7 +73,7 @@ def list_all_api_documents( return self._get( "/v1/apis", options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryListAllApiDocumentsResponse, + cast_to=RegistryListAllAPIDocumentsResponse, ) def list_api_documents( @@ -86,7 +86,7 @@ def list_api_documents( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryListApiDocumentsResponse: + ) -> RegistryListAPIDocumentsResponse: """ List API documents in a namespace. @@ -98,7 +98,7 @@ def list_api_documents( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryListApiDocumentsResponse: Default Response + RegistryListAPIDocumentsResponse: Default Response Example: ```python @@ -112,7 +112,7 @@ def list_api_documents( return self._get( path_template("/v1/apis/{namespace}", **{"namespace": namespace}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryListApiDocumentsResponse, + cast_to=RegistryListAPIDocumentsResponse, ) def create_api_document( @@ -132,7 +132,7 @@ def create_api_document( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryCreateApiDocumentResponse: + ) -> RegistryCreateAPIDocumentResponse: """ Create an API document. @@ -151,7 +151,7 @@ def create_api_document( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryCreateApiDocumentResponse: Default Response + RegistryCreateAPIDocumentResponse: Default Response Example: ```python @@ -178,10 +178,10 @@ def create_api_document( "is_private": is_private, "document": document, }, - registry_create_api_document_params.RegistryCreateApiDocumentParams, + registry_create_api_document_params.RegistryCreateAPIDocumentParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryCreateApiDocumentResponse, + cast_to=RegistryCreateAPIDocumentResponse, ) def update_api_document( @@ -199,7 +199,7 @@ def update_api_document( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryUpdateApiDocumentResponse: + ) -> RegistryUpdateAPIDocumentResponse: """ Update metadata for an API document. @@ -216,7 +216,7 @@ def update_api_document( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryUpdateApiDocumentResponse: Default Response + RegistryUpdateAPIDocumentResponse: Default Response Example: ```python @@ -239,10 +239,10 @@ def update_api_document( "is_private": is_private, "ruleset": ruleset, }, - registry_update_api_document_params.RegistryUpdateApiDocumentParams, + registry_update_api_document_params.RegistryUpdateAPIDocumentParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryUpdateApiDocumentResponse, + cast_to=RegistryUpdateAPIDocumentResponse, ) def delete_api_document( @@ -256,7 +256,7 @@ def delete_api_document( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryDeleteApiDocumentResponse: + ) -> RegistryDeleteAPIDocumentResponse: """ Delete an API document and all versions. @@ -269,7 +269,7 @@ def delete_api_document( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryDeleteApiDocumentResponse: Default Response + RegistryDeleteAPIDocumentResponse: Default Response Example: ```python @@ -286,7 +286,7 @@ def delete_api_document( return self._delete( path_template("/v1/apis/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryDeleteApiDocumentResponse, + cast_to=RegistryDeleteAPIDocumentResponse, ) def retrieve_api_document_version( @@ -353,7 +353,7 @@ def update_api_document_version( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryUpdateApiDocumentVersionResponse: + ) -> RegistryUpdateAPIDocumentVersionResponse: """ Update the registry file content for an API document version. @@ -369,7 +369,7 @@ def update_api_document_version( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryUpdateApiDocumentVersionResponse: Default Response + RegistryUpdateAPIDocumentVersionResponse: Default Response Example: ```python @@ -394,10 +394,10 @@ def update_api_document_version( "document": document, "last_known_version_sha": last_known_version_sha, }, - registry_update_api_document_version_params.RegistryUpdateApiDocumentVersionParams, + registry_update_api_document_version_params.RegistryUpdateAPIDocumentVersionParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryUpdateApiDocumentVersionResponse, + cast_to=RegistryUpdateAPIDocumentVersionResponse, ) def delete_api_document_version( @@ -412,7 +412,7 @@ def delete_api_document_version( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryDeleteApiDocumentVersionResponse: + ) -> RegistryDeleteAPIDocumentVersionResponse: """ Delete a specific API document version. @@ -426,7 +426,7 @@ def delete_api_document_version( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryDeleteApiDocumentVersionResponse: Default Response + RegistryDeleteAPIDocumentVersionResponse: Default Response Example: ```python @@ -446,7 +446,7 @@ def delete_api_document_version( return self._delete( path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryDeleteApiDocumentVersionResponse, + cast_to=RegistryDeleteAPIDocumentVersionResponse, ) def list_api_document_version_metadata( @@ -461,7 +461,7 @@ def list_api_document_version_metadata( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryListApiDocumentVersionMetadataResponse: + ) -> RegistryListAPIDocumentVersionMetadataResponse: """ Get metadata (uid, content shas, version sha, tags) for a specific API document version. @@ -475,7 +475,7 @@ def list_api_document_version_metadata( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryListApiDocumentVersionMetadataResponse: Default Response + RegistryListAPIDocumentVersionMetadataResponse: Default Response Example: ```python @@ -495,7 +495,7 @@ def list_api_document_version_metadata( return self._get( path_template("/v1/apis/{namespace}/{slug}/version/{semver}/metadata", **{"namespace": namespace, "slug": slug, "semver": semver}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryListApiDocumentVersionMetadataResponse, + cast_to=RegistryListAPIDocumentVersionMetadataResponse, ) def create_api_document_version( @@ -513,7 +513,7 @@ def create_api_document_version( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryCreateApiDocumentVersionResponse: + ) -> RegistryCreateAPIDocumentVersionResponse: """ Create a new API document version. @@ -530,7 +530,7 @@ def create_api_document_version( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryCreateApiDocumentVersionResponse: Default Response + RegistryCreateAPIDocumentVersionResponse: Default Response Example: ```python @@ -555,10 +555,10 @@ def create_api_document_version( "force": force, "last_known_version_sha": last_known_version_sha, }, - registry_create_api_document_version_params.RegistryCreateApiDocumentVersionParams, + registry_create_api_document_version_params.RegistryCreateAPIDocumentVersionParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryCreateApiDocumentVersionResponse, + cast_to=RegistryCreateAPIDocumentVersionResponse, ) def create_api_document_access_group( @@ -573,7 +573,7 @@ def create_api_document_access_group( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryCreateApiDocumentAccessGroupResponse: + ) -> RegistryCreateAPIDocumentAccessGroupResponse: """ Add an access group to an API document. @@ -587,7 +587,7 @@ def create_api_document_access_group( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryCreateApiDocumentAccessGroupResponse: Default Response + RegistryCreateAPIDocumentAccessGroupResponse: Default Response Example: ```python @@ -606,10 +606,10 @@ def create_api_document_access_group( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( {"access_group_slug": access_group_slug}, - registry_create_api_document_access_group_params.RegistryCreateApiDocumentAccessGroupParams, + registry_create_api_document_access_group_params.RegistryCreateAPIDocumentAccessGroupParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryCreateApiDocumentAccessGroupResponse, + cast_to=RegistryCreateAPIDocumentAccessGroupResponse, ) def delete_api_document_access_group( @@ -624,7 +624,7 @@ def delete_api_document_access_group( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryDeleteApiDocumentAccessGroupResponse: + ) -> RegistryDeleteAPIDocumentAccessGroupResponse: """ Remove an access group from an API document. @@ -638,7 +638,7 @@ def delete_api_document_access_group( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryDeleteApiDocumentAccessGroupResponse: Default Response + RegistryDeleteAPIDocumentAccessGroupResponse: Default Response Example: ```python @@ -657,10 +657,10 @@ def delete_api_document_access_group( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=maybe_transform( {"access_group_slug": access_group_slug}, - registry_delete_api_document_access_group_params.RegistryDeleteApiDocumentAccessGroupParams, + registry_delete_api_document_access_group_params.RegistryDeleteAPIDocumentAccessGroupParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryDeleteApiDocumentAccessGroupResponse, + cast_to=RegistryDeleteAPIDocumentAccessGroupResponse, ) @@ -683,7 +683,7 @@ async def list_all_api_documents( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryListAllApiDocumentsResponse: + ) -> RegistryListAllAPIDocumentsResponse: """ List all API documents across every namespace the caller can access. @@ -694,7 +694,7 @@ async def list_all_api_documents( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryListAllApiDocumentsResponse: Default Response + RegistryListAllAPIDocumentsResponse: Default Response Example: ```python @@ -704,7 +704,7 @@ async def list_all_api_documents( return await self._get( "/v1/apis", options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryListAllApiDocumentsResponse, + cast_to=RegistryListAllAPIDocumentsResponse, ) async def list_api_documents( @@ -717,7 +717,7 @@ async def list_api_documents( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryListApiDocumentsResponse: + ) -> RegistryListAPIDocumentsResponse: """ List API documents in a namespace. @@ -729,7 +729,7 @@ async def list_api_documents( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryListApiDocumentsResponse: Default Response + RegistryListAPIDocumentsResponse: Default Response Example: ```python @@ -743,7 +743,7 @@ async def list_api_documents( return await self._get( path_template("/v1/apis/{namespace}", **{"namespace": namespace}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryListApiDocumentsResponse, + cast_to=RegistryListAPIDocumentsResponse, ) async def create_api_document( @@ -763,7 +763,7 @@ async def create_api_document( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryCreateApiDocumentResponse: + ) -> RegistryCreateAPIDocumentResponse: """ Create an API document. @@ -782,7 +782,7 @@ async def create_api_document( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryCreateApiDocumentResponse: Default Response + RegistryCreateAPIDocumentResponse: Default Response Example: ```python @@ -809,10 +809,10 @@ async def create_api_document( "is_private": is_private, "document": document, }, - registry_create_api_document_params.RegistryCreateApiDocumentParams, + registry_create_api_document_params.RegistryCreateAPIDocumentParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryCreateApiDocumentResponse, + cast_to=RegistryCreateAPIDocumentResponse, ) async def update_api_document( @@ -830,7 +830,7 @@ async def update_api_document( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryUpdateApiDocumentResponse: + ) -> RegistryUpdateAPIDocumentResponse: """ Update metadata for an API document. @@ -847,7 +847,7 @@ async def update_api_document( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryUpdateApiDocumentResponse: Default Response + RegistryUpdateAPIDocumentResponse: Default Response Example: ```python @@ -870,10 +870,10 @@ async def update_api_document( "is_private": is_private, "ruleset": ruleset, }, - registry_update_api_document_params.RegistryUpdateApiDocumentParams, + registry_update_api_document_params.RegistryUpdateAPIDocumentParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryUpdateApiDocumentResponse, + cast_to=RegistryUpdateAPIDocumentResponse, ) async def delete_api_document( @@ -887,7 +887,7 @@ async def delete_api_document( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryDeleteApiDocumentResponse: + ) -> RegistryDeleteAPIDocumentResponse: """ Delete an API document and all versions. @@ -900,7 +900,7 @@ async def delete_api_document( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryDeleteApiDocumentResponse: Default Response + RegistryDeleteAPIDocumentResponse: Default Response Example: ```python @@ -917,7 +917,7 @@ async def delete_api_document( return await self._delete( path_template("/v1/apis/{namespace}/{slug}", **{"namespace": namespace, "slug": slug}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryDeleteApiDocumentResponse, + cast_to=RegistryDeleteAPIDocumentResponse, ) async def retrieve_api_document_version( @@ -984,7 +984,7 @@ async def update_api_document_version( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryUpdateApiDocumentVersionResponse: + ) -> RegistryUpdateAPIDocumentVersionResponse: """ Update the registry file content for an API document version. @@ -1000,7 +1000,7 @@ async def update_api_document_version( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryUpdateApiDocumentVersionResponse: Default Response + RegistryUpdateAPIDocumentVersionResponse: Default Response Example: ```python @@ -1025,10 +1025,10 @@ async def update_api_document_version( "document": document, "last_known_version_sha": last_known_version_sha, }, - registry_update_api_document_version_params.RegistryUpdateApiDocumentVersionParams, + registry_update_api_document_version_params.RegistryUpdateAPIDocumentVersionParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryUpdateApiDocumentVersionResponse, + cast_to=RegistryUpdateAPIDocumentVersionResponse, ) async def delete_api_document_version( @@ -1043,7 +1043,7 @@ async def delete_api_document_version( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryDeleteApiDocumentVersionResponse: + ) -> RegistryDeleteAPIDocumentVersionResponse: """ Delete a specific API document version. @@ -1057,7 +1057,7 @@ async def delete_api_document_version( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryDeleteApiDocumentVersionResponse: Default Response + RegistryDeleteAPIDocumentVersionResponse: Default Response Example: ```python @@ -1077,7 +1077,7 @@ async def delete_api_document_version( return await self._delete( path_template("/v1/apis/{namespace}/{slug}/version/{semver}", **{"namespace": namespace, "slug": slug, "semver": semver}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryDeleteApiDocumentVersionResponse, + cast_to=RegistryDeleteAPIDocumentVersionResponse, ) async def list_api_document_version_metadata( @@ -1092,7 +1092,7 @@ async def list_api_document_version_metadata( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryListApiDocumentVersionMetadataResponse: + ) -> RegistryListAPIDocumentVersionMetadataResponse: """ Get metadata (uid, content shas, version sha, tags) for a specific API document version. @@ -1106,7 +1106,7 @@ async def list_api_document_version_metadata( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryListApiDocumentVersionMetadataResponse: Default Response + RegistryListAPIDocumentVersionMetadataResponse: Default Response Example: ```python @@ -1126,7 +1126,7 @@ async def list_api_document_version_metadata( return await self._get( path_template("/v1/apis/{namespace}/{slug}/version/{semver}/metadata", **{"namespace": namespace, "slug": slug, "semver": semver}), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryListApiDocumentVersionMetadataResponse, + cast_to=RegistryListAPIDocumentVersionMetadataResponse, ) async def create_api_document_version( @@ -1144,7 +1144,7 @@ async def create_api_document_version( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryCreateApiDocumentVersionResponse: + ) -> RegistryCreateAPIDocumentVersionResponse: """ Create a new API document version. @@ -1161,7 +1161,7 @@ async def create_api_document_version( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryCreateApiDocumentVersionResponse: Default Response + RegistryCreateAPIDocumentVersionResponse: Default Response Example: ```python @@ -1186,10 +1186,10 @@ async def create_api_document_version( "force": force, "last_known_version_sha": last_known_version_sha, }, - registry_create_api_document_version_params.RegistryCreateApiDocumentVersionParams, + registry_create_api_document_version_params.RegistryCreateAPIDocumentVersionParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryCreateApiDocumentVersionResponse, + cast_to=RegistryCreateAPIDocumentVersionResponse, ) async def create_api_document_access_group( @@ -1204,7 +1204,7 @@ async def create_api_document_access_group( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryCreateApiDocumentAccessGroupResponse: + ) -> RegistryCreateAPIDocumentAccessGroupResponse: """ Add an access group to an API document. @@ -1218,7 +1218,7 @@ async def create_api_document_access_group( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryCreateApiDocumentAccessGroupResponse: Default Response + RegistryCreateAPIDocumentAccessGroupResponse: Default Response Example: ```python @@ -1237,10 +1237,10 @@ async def create_api_document_access_group( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( {"access_group_slug": access_group_slug}, - registry_create_api_document_access_group_params.RegistryCreateApiDocumentAccessGroupParams, + registry_create_api_document_access_group_params.RegistryCreateAPIDocumentAccessGroupParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryCreateApiDocumentAccessGroupResponse, + cast_to=RegistryCreateAPIDocumentAccessGroupResponse, ) async def delete_api_document_access_group( @@ -1255,7 +1255,7 @@ async def delete_api_document_access_group( extra_query: Query | None = None, extra_body: Body | None = None, timeout: float | httpx.Timeout | None | NotGiven = not_given, - ) -> RegistryDeleteApiDocumentAccessGroupResponse: + ) -> RegistryDeleteAPIDocumentAccessGroupResponse: """ Remove an access group from an API document. @@ -1269,7 +1269,7 @@ async def delete_api_document_access_group( timeout: Override the client-level default timeout for this request, in seconds. Returns: - RegistryDeleteApiDocumentAccessGroupResponse: Default Response + RegistryDeleteAPIDocumentAccessGroupResponse: Default Response Example: ```python @@ -1288,10 +1288,10 @@ async def delete_api_document_access_group( path_template("/v1/apis/{namespace}/{slug}/access-group", **{"namespace": namespace, "slug": slug}), body=await async_maybe_transform( {"access_group_slug": access_group_slug}, - registry_delete_api_document_access_group_params.RegistryDeleteApiDocumentAccessGroupParams, + registry_delete_api_document_access_group_params.RegistryDeleteAPIDocumentAccessGroupParams, ), options=make_request_options(extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout), - cast_to=RegistryDeleteApiDocumentAccessGroupResponse, + cast_to=RegistryDeleteAPIDocumentAccessGroupResponse, ) diff --git a/src/types/__init__.py b/src/types/__init__.py index fbb7ca1..3c6691a 100644 --- a/src/types/__init__.py +++ b/src/types/__init__.py @@ -6,24 +6,26 @@ from .slug import Slug as Slug from .login_portal_email import LoginPortalEmail as LoginPortalEmail from .login_portal_page import LoginPortalPage as LoginPortalPage -from .registry_list_all_api_documents_response import RegistryListAllApiDocumentsResponse as RegistryListAllApiDocumentsResponse -from .registry_list_api_documents_response import RegistryListApiDocumentsResponse as RegistryListApiDocumentsResponse -from .registry_create_api_document_response import RegistryCreateApiDocumentResponse as RegistryCreateApiDocumentResponse -from .registry_create_api_document_params import RegistryCreateApiDocumentParams as RegistryCreateApiDocumentParams -from .registry_update_api_document_response import RegistryUpdateApiDocumentResponse as RegistryUpdateApiDocumentResponse -from .registry_update_api_document_params import RegistryUpdateApiDocumentParams as RegistryUpdateApiDocumentParams -from .registry_delete_api_document_response import RegistryDeleteApiDocumentResponse as RegistryDeleteApiDocumentResponse -from .registry_retrieve_api_document_version_response import RegistryRetrieveApiDocumentVersionResponse as RegistryRetrieveApiDocumentVersionResponse -from .registry_update_api_document_version_response import RegistryUpdateApiDocumentVersionResponse as RegistryUpdateApiDocumentVersionResponse -from .registry_update_api_document_version_params import RegistryUpdateApiDocumentVersionParams as RegistryUpdateApiDocumentVersionParams -from .registry_delete_api_document_version_response import RegistryDeleteApiDocumentVersionResponse as RegistryDeleteApiDocumentVersionResponse -from .registry_list_api_document_version_metadata_response import RegistryListApiDocumentVersionMetadataResponse as RegistryListApiDocumentVersionMetadataResponse -from .registry_create_api_document_version_response import RegistryCreateApiDocumentVersionResponse as RegistryCreateApiDocumentVersionResponse -from .registry_create_api_document_version_params import RegistryCreateApiDocumentVersionParams as RegistryCreateApiDocumentVersionParams -from .registry_create_api_document_access_group_response import RegistryCreateApiDocumentAccessGroupResponse as RegistryCreateApiDocumentAccessGroupResponse -from .registry_create_api_document_access_group_params import RegistryCreateApiDocumentAccessGroupParams as RegistryCreateApiDocumentAccessGroupParams -from .registry_delete_api_document_access_group_response import RegistryDeleteApiDocumentAccessGroupResponse as RegistryDeleteApiDocumentAccessGroupResponse -from .registry_delete_api_document_access_group_params import RegistryDeleteApiDocumentAccessGroupParams as RegistryDeleteApiDocumentAccessGroupParams +from .login_portal_email_param import LoginPortalEmailParam as LoginPortalEmailParam +from .login_portal_page_param import LoginPortalPageParam as LoginPortalPageParam +from .registry_list_all_api_documents_response import RegistryListAllAPIDocumentsResponse as RegistryListAllAPIDocumentsResponse +from .registry_list_api_documents_response import RegistryListAPIDocumentsResponse as RegistryListAPIDocumentsResponse +from .registry_create_api_document_response import RegistryCreateAPIDocumentResponse as RegistryCreateAPIDocumentResponse +from .registry_create_api_document_params import RegistryCreateAPIDocumentParams as RegistryCreateAPIDocumentParams +from .registry_update_api_document_response import RegistryUpdateAPIDocumentResponse as RegistryUpdateAPIDocumentResponse +from .registry_update_api_document_params import RegistryUpdateAPIDocumentParams as RegistryUpdateAPIDocumentParams +from .registry_delete_api_document_response import RegistryDeleteAPIDocumentResponse as RegistryDeleteAPIDocumentResponse +from .registry_retrieve_api_document_version_response import RegistryRetrieveAPIDocumentVersionResponse as RegistryRetrieveAPIDocumentVersionResponse +from .registry_update_api_document_version_response import RegistryUpdateAPIDocumentVersionResponse as RegistryUpdateAPIDocumentVersionResponse +from .registry_update_api_document_version_params import RegistryUpdateAPIDocumentVersionParams as RegistryUpdateAPIDocumentVersionParams +from .registry_delete_api_document_version_response import RegistryDeleteAPIDocumentVersionResponse as RegistryDeleteAPIDocumentVersionResponse +from .registry_list_api_document_version_metadata_response import RegistryListAPIDocumentVersionMetadataResponse as RegistryListAPIDocumentVersionMetadataResponse +from .registry_create_api_document_version_response import RegistryCreateAPIDocumentVersionResponse as RegistryCreateAPIDocumentVersionResponse +from .registry_create_api_document_version_params import RegistryCreateAPIDocumentVersionParams as RegistryCreateAPIDocumentVersionParams +from .registry_create_api_document_access_group_response import RegistryCreateAPIDocumentAccessGroupResponse as RegistryCreateAPIDocumentAccessGroupResponse +from .registry_create_api_document_access_group_params import RegistryCreateAPIDocumentAccessGroupParams as RegistryCreateAPIDocumentAccessGroupParams +from .registry_delete_api_document_access_group_response import RegistryDeleteAPIDocumentAccessGroupResponse as RegistryDeleteAPIDocumentAccessGroupResponse +from .registry_delete_api_document_access_group_params import RegistryDeleteAPIDocumentAccessGroupParams as RegistryDeleteAPIDocumentAccessGroupParams from .schema_list_response import SchemaListResponse as SchemaListResponse from .schema_create_response import SchemaCreateResponse as SchemaCreateResponse from .schema_create_params import SchemaCreateParams as SchemaCreateParams diff --git a/src/types/login_portal_create_params.py b/src/types/login_portal_create_params.py index 20c122e..99a0c44 100644 --- a/src/types/login_portal_create_params.py +++ b/src/types/login_portal_create_params.py @@ -4,8 +4,8 @@ from typing_extensions import Required, TypedDict -from .shared_params.login_portal_email import LoginPortalEmail -from .shared_params.login_portal_page import LoginPortalPage +from .login_portal_email_param import LoginPortalEmailParam +from .login_portal_page_param import LoginPortalPageParam __all__ = ["LoginPortalCreateParams"] @@ -16,6 +16,6 @@ class LoginPortalCreateParams(TypedDict, total=False): slug: Required[str] - email: Required[LoginPortalEmail] + email: Required[LoginPortalEmailParam] - page: Required[LoginPortalPage] + page: Required[LoginPortalPageParam] diff --git a/src/types/shared_params/login_portal_email.py b/src/types/login_portal_email_param.py similarity index 87% rename from src/types/shared_params/login_portal_email.py rename to src/types/login_portal_email_param.py index 7edf78e..6ef95df 100644 --- a/src/types/shared_params/login_portal_email.py +++ b/src/types/login_portal_email_param.py @@ -4,12 +4,12 @@ from typing_extensions import Annotated, Required, TypedDict -from ..._utils import PropertyInfo +from .._utils import PropertyInfo -__all__ = ["LoginPortalEmail"] +__all__ = ["LoginPortalEmailParam"] -class LoginPortalEmail(TypedDict, total=False): +class LoginPortalEmailParam(TypedDict, total=False): logo: Required[str] diff --git a/src/types/shared_params/login_portal_page.py b/src/types/login_portal_page_param.py similarity index 88% rename from src/types/shared_params/login_portal_page.py rename to src/types/login_portal_page_param.py index c5a7bab..2961645 100644 --- a/src/types/shared_params/login_portal_page.py +++ b/src/types/login_portal_page_param.py @@ -4,12 +4,12 @@ from typing_extensions import Annotated, Required, TypedDict -from ..._utils import PropertyInfo +from .._utils import PropertyInfo -__all__ = ["LoginPortalPage"] +__all__ = ["LoginPortalPageParam"] -class LoginPortalPage(TypedDict, total=False): +class LoginPortalPageParam(TypedDict, total=False): title: Required[str] diff --git a/src/types/registry_create_api_document_access_group_params.py b/src/types/registry_create_api_document_access_group_params.py index 0eb47e6..4ceb233 100644 --- a/src/types/registry_create_api_document_access_group_params.py +++ b/src/types/registry_create_api_document_access_group_params.py @@ -8,10 +8,10 @@ from .slug import Slug -__all__ = ["RegistryCreateApiDocumentAccessGroupParams"] +__all__ = ["RegistryCreateAPIDocumentAccessGroupParams"] -class RegistryCreateApiDocumentAccessGroupParams(TypedDict, total=False): +class RegistryCreateAPIDocumentAccessGroupParams(TypedDict, total=False): namespace: Required[str] diff --git a/src/types/registry_create_api_document_access_group_response.py b/src/types/registry_create_api_document_access_group_response.py index f5af9f1..04c4459 100644 --- a/src/types/registry_create_api_document_access_group_response.py +++ b/src/types/registry_create_api_document_access_group_response.py @@ -2,6 +2,6 @@ from typing_extensions import TypeAlias -__all__ = ["RegistryCreateApiDocumentAccessGroupResponse"] +__all__ = ["RegistryCreateAPIDocumentAccessGroupResponse"] -RegistryCreateApiDocumentAccessGroupResponse: TypeAlias = None +RegistryCreateAPIDocumentAccessGroupResponse: TypeAlias = None diff --git a/src/types/registry_create_api_document_params.py b/src/types/registry_create_api_document_params.py index a6b041f..61602e0 100644 --- a/src/types/registry_create_api_document_params.py +++ b/src/types/registry_create_api_document_params.py @@ -8,10 +8,10 @@ from .version import Version -__all__ = ["RegistryCreateApiDocumentParams"] +__all__ = ["RegistryCreateAPIDocumentParams"] -class RegistryCreateApiDocumentParams(TypedDict, total=False): +class RegistryCreateAPIDocumentParams(TypedDict, total=False): title: Required[str] diff --git a/src/types/registry_create_api_document_response.py b/src/types/registry_create_api_document_response.py index 3af8068..01a14d4 100644 --- a/src/types/registry_create_api_document_response.py +++ b/src/types/registry_create_api_document_response.py @@ -4,9 +4,9 @@ from .._models import BaseModel -__all__ = ["RegistryCreateApiDocumentResponse"] +__all__ = ["RegistryCreateAPIDocumentResponse"] -class RegistryCreateApiDocumentResponse(BaseModel): +class RegistryCreateAPIDocumentResponse(BaseModel): uid: str diff --git a/src/types/registry_create_api_document_version_params.py b/src/types/registry_create_api_document_version_params.py index e1fa06c..ea22c07 100644 --- a/src/types/registry_create_api_document_version_params.py +++ b/src/types/registry_create_api_document_version_params.py @@ -8,10 +8,10 @@ from .version import Version -__all__ = ["RegistryCreateApiDocumentVersionParams"] +__all__ = ["RegistryCreateAPIDocumentVersionParams"] -class RegistryCreateApiDocumentVersionParams(TypedDict, total=False): +class RegistryCreateAPIDocumentVersionParams(TypedDict, total=False): namespace: Required[str] diff --git a/src/types/registry_create_api_document_version_response.py b/src/types/registry_create_api_document_version_response.py index 2e930f3..6e75f0a 100644 --- a/src/types/registry_create_api_document_version_response.py +++ b/src/types/registry_create_api_document_version_response.py @@ -9,7 +9,7 @@ from .version import Version -__all__ = ["RegistryCreateApiDocumentVersionResponse", "Tool"] +__all__ = ["RegistryCreateAPIDocumentVersionResponse", "Tool"] class Tool(BaseModel): @@ -22,7 +22,7 @@ class Tool(BaseModel): -class RegistryCreateApiDocumentVersionResponse(BaseModel): +class RegistryCreateAPIDocumentVersionResponse(BaseModel): uid: str diff --git a/src/types/registry_delete_api_document_access_group_params.py b/src/types/registry_delete_api_document_access_group_params.py index d3893ee..3e19a4f 100644 --- a/src/types/registry_delete_api_document_access_group_params.py +++ b/src/types/registry_delete_api_document_access_group_params.py @@ -8,10 +8,10 @@ from .slug import Slug -__all__ = ["RegistryDeleteApiDocumentAccessGroupParams"] +__all__ = ["RegistryDeleteAPIDocumentAccessGroupParams"] -class RegistryDeleteApiDocumentAccessGroupParams(TypedDict, total=False): +class RegistryDeleteAPIDocumentAccessGroupParams(TypedDict, total=False): namespace: Required[str] diff --git a/src/types/registry_delete_api_document_access_group_response.py b/src/types/registry_delete_api_document_access_group_response.py index c6b35fa..7e3b4fd 100644 --- a/src/types/registry_delete_api_document_access_group_response.py +++ b/src/types/registry_delete_api_document_access_group_response.py @@ -2,6 +2,6 @@ from typing_extensions import TypeAlias -__all__ = ["RegistryDeleteApiDocumentAccessGroupResponse"] +__all__ = ["RegistryDeleteAPIDocumentAccessGroupResponse"] -RegistryDeleteApiDocumentAccessGroupResponse: TypeAlias = None +RegistryDeleteAPIDocumentAccessGroupResponse: TypeAlias = None diff --git a/src/types/registry_delete_api_document_response.py b/src/types/registry_delete_api_document_response.py index 0e515b9..e2a4c26 100644 --- a/src/types/registry_delete_api_document_response.py +++ b/src/types/registry_delete_api_document_response.py @@ -2,6 +2,6 @@ from typing_extensions import TypeAlias -__all__ = ["RegistryDeleteApiDocumentResponse"] +__all__ = ["RegistryDeleteAPIDocumentResponse"] -RegistryDeleteApiDocumentResponse: TypeAlias = None +RegistryDeleteAPIDocumentResponse: TypeAlias = None diff --git a/src/types/registry_delete_api_document_version_response.py b/src/types/registry_delete_api_document_version_response.py index 0c9267f..222f2d3 100644 --- a/src/types/registry_delete_api_document_version_response.py +++ b/src/types/registry_delete_api_document_version_response.py @@ -2,6 +2,6 @@ from typing_extensions import TypeAlias -__all__ = ["RegistryDeleteApiDocumentVersionResponse"] +__all__ = ["RegistryDeleteAPIDocumentVersionResponse"] -RegistryDeleteApiDocumentVersionResponse: TypeAlias = None +RegistryDeleteAPIDocumentVersionResponse: TypeAlias = None diff --git a/src/types/registry_list_all_api_documents_response.py b/src/types/registry_list_all_api_documents_response.py index 24e384c..9b099b1 100644 --- a/src/types/registry_list_all_api_documents_response.py +++ b/src/types/registry_list_all_api_documents_response.py @@ -12,7 +12,7 @@ from .version import Version from .slug import Slug -__all__ = ["RegistryListAllApiDocumentsResponse", "ApiDocument", "ManagedDocVersion", "Tool"] +__all__ = ["RegistryListAllAPIDocumentsResponse", "APIDocument", "ManagedDocVersion", "Tool"] class Tool(BaseModel): @@ -44,7 +44,7 @@ class ManagedDocVersion(BaseModel): version_sha: Optional[str] = FieldInfo(alias="versionSha", default=None) -class ApiDocument(BaseModel): +class APIDocument(BaseModel): uid: str @@ -66,4 +66,4 @@ class ApiDocument(BaseModel): -RegistryListAllApiDocumentsResponse: TypeAlias = List[ApiDocument] +RegistryListAllAPIDocumentsResponse: TypeAlias = List[APIDocument] diff --git a/src/types/registry_list_api_document_version_metadata_response.py b/src/types/registry_list_api_document_version_metadata_response.py index ecb71cd..9d20c17 100644 --- a/src/types/registry_list_api_document_version_metadata_response.py +++ b/src/types/registry_list_api_document_version_metadata_response.py @@ -9,7 +9,7 @@ from .version import Version -__all__ = ["RegistryListApiDocumentVersionMetadataResponse", "Tool"] +__all__ = ["RegistryListAPIDocumentVersionMetadataResponse", "Tool"] class Tool(BaseModel): @@ -22,7 +22,7 @@ class Tool(BaseModel): -class RegistryListApiDocumentVersionMetadataResponse(BaseModel): +class RegistryListAPIDocumentVersionMetadataResponse(BaseModel): uid: str diff --git a/src/types/registry_list_api_documents_response.py b/src/types/registry_list_api_documents_response.py index b4ac587..a6ac9fb 100644 --- a/src/types/registry_list_api_documents_response.py +++ b/src/types/registry_list_api_documents_response.py @@ -12,7 +12,7 @@ from .version import Version from .slug import Slug -__all__ = ["RegistryListApiDocumentsResponse", "ApiDocument", "ManagedDocVersion", "Tool"] +__all__ = ["RegistryListAPIDocumentsResponse", "APIDocument", "ManagedDocVersion", "Tool"] class Tool(BaseModel): @@ -44,7 +44,7 @@ class ManagedDocVersion(BaseModel): version_sha: Optional[str] = FieldInfo(alias="versionSha", default=None) -class ApiDocument(BaseModel): +class APIDocument(BaseModel): uid: str @@ -66,4 +66,4 @@ class ApiDocument(BaseModel): -RegistryListApiDocumentsResponse: TypeAlias = List[ApiDocument] +RegistryListAPIDocumentsResponse: TypeAlias = List[APIDocument] diff --git a/src/types/registry_retrieve_api_document_version_response.py b/src/types/registry_retrieve_api_document_version_response.py index 20c6e6b..40a27a7 100644 --- a/src/types/registry_retrieve_api_document_version_response.py +++ b/src/types/registry_retrieve_api_document_version_response.py @@ -2,6 +2,6 @@ from typing_extensions import TypeAlias -__all__ = ["RegistryRetrieveApiDocumentVersionResponse"] +__all__ = ["RegistryRetrieveAPIDocumentVersionResponse"] -RegistryRetrieveApiDocumentVersionResponse: TypeAlias = str +RegistryRetrieveAPIDocumentVersionResponse: TypeAlias = str diff --git a/src/types/registry_update_api_document_params.py b/src/types/registry_update_api_document_params.py index 6aa372c..3dd61d0 100644 --- a/src/types/registry_update_api_document_params.py +++ b/src/types/registry_update_api_document_params.py @@ -6,10 +6,10 @@ from .._utils import PropertyInfo -__all__ = ["RegistryUpdateApiDocumentParams"] +__all__ = ["RegistryUpdateAPIDocumentParams"] -class RegistryUpdateApiDocumentParams(TypedDict, total=False): +class RegistryUpdateAPIDocumentParams(TypedDict, total=False): namespace: Required[str] diff --git a/src/types/registry_update_api_document_response.py b/src/types/registry_update_api_document_response.py index a11fc7c..3ab019a 100644 --- a/src/types/registry_update_api_document_response.py +++ b/src/types/registry_update_api_document_response.py @@ -2,6 +2,6 @@ from typing_extensions import TypeAlias -__all__ = ["RegistryUpdateApiDocumentResponse"] +__all__ = ["RegistryUpdateAPIDocumentResponse"] -RegistryUpdateApiDocumentResponse: TypeAlias = None +RegistryUpdateAPIDocumentResponse: TypeAlias = None diff --git a/src/types/registry_update_api_document_version_params.py b/src/types/registry_update_api_document_version_params.py index 3e6b3d2..e53b7b6 100644 --- a/src/types/registry_update_api_document_version_params.py +++ b/src/types/registry_update_api_document_version_params.py @@ -6,10 +6,10 @@ from .._utils import PropertyInfo -__all__ = ["RegistryUpdateApiDocumentVersionParams"] +__all__ = ["RegistryUpdateAPIDocumentVersionParams"] -class RegistryUpdateApiDocumentVersionParams(TypedDict, total=False): +class RegistryUpdateAPIDocumentVersionParams(TypedDict, total=False): namespace: Required[str] diff --git a/src/types/registry_update_api_document_version_response.py b/src/types/registry_update_api_document_version_response.py index b1ddf90..c81d6e7 100644 --- a/src/types/registry_update_api_document_version_response.py +++ b/src/types/registry_update_api_document_version_response.py @@ -4,9 +4,9 @@ from .._models import BaseModel -__all__ = ["RegistryUpdateApiDocumentVersionResponse"] +__all__ = ["RegistryUpdateAPIDocumentVersionResponse"] -class RegistryUpdateApiDocumentVersionResponse(BaseModel): +class RegistryUpdateAPIDocumentVersionResponse(BaseModel): json_sha: str = FieldInfo(alias="jsonSha") diff --git a/src/types/shared_params/__init__.py b/src/types/shared_params/__init__.py deleted file mode 100644 index 040852d..0000000 --- a/src/types/shared_params/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -# File generated from our OpenAPI spec by Scalar. See README.md for details. - -from __future__ import annotations - -from .login_portal_email import LoginPortalEmail as LoginPortalEmail -from .login_portal_page import LoginPortalPage as LoginPortalPage