feat(api-docs): Improve SDK API documentation #3444

	name: API Pull Request with Private Packages

	permissions:
	contents: read # For actions/checkout
	id-token: write # For Codecov OIDC

	on:
	pull_request:
	paths:
	- api/**
	- docker/api/**
	- .github/**
	- .release-please-manifest.json
	types: [opened, synchronize, reopened, ready_for_review]
	push:
	paths:
	- api/**
	- docker/api/**
	- .github/**
	- .release-please-manifest.json
	branches:
	- main

	defaults:
	run:
	working-directory: api

	jobs:
	test:
	runs-on: depot-ubuntu-latest-16
	name: API Unit Tests

	strategy:
	max-parallel: 2
	matrix:
	python-version: ["3.11", "3.12"]

	steps:
	- name: Cloning repo
	uses: actions/checkout@v5

	- name: Install Poetry
	run: make install-poetry

	- uses: actions/setup-python@v5
	with:
	python-version: ${{ matrix.python-version }}
	cache: poetry

	- name: Install SAML Dependencies
	run: sudo apt-get install -y xmlsec1

	- name: Install packages and Tests
	shell: bash
	run: \|
	echo "https://${{ secrets.GH_PRIVATE_ACCESS_TOKEN }}:@github.com" > ${HOME}/.git-credentials
	git config --global credential.helper store
	make install-packages opts="--with saml,auth-controller,workflows"
	make install-private-modules
	make integrate-private-tests
	rm -rf ${HOME}/.git-credentials

	- name: Run Tests
	env:
	DOTENV_OVERRIDE_FILE: .env-ci
	run: make test

	- name: Upload Coverage
	uses: codecov/codecov-action@v4
	env:
	PRIVATE_PACKAGES: "true"
	PYTHON: ${{ matrix.python-version }}
	with:
	env_vars: PRIVATE_PACKAGES,PYTHON
	use_oidc: true

Provide feedback