Add oasislmf api client CLI documentation#48
Merged
Conversation
Brings all docs in sync with the 2.5.x release series: - Bump PLAT_VER in update-redoc.py from 2.5.0 → 2.5.4 and regenerate all four OpenAPI/settings JSON schemas - Add 2.5.0–2.5.4 changelogs for OasisLMF and OasisPlatform (replacing the stale 1.4.x history and the broken include directive) - Update Python minimum requirement 3.8 → 3.10 - Document new oasislmf CLI subcommands, utility commands (warmup, config, version, admin, test), and API client commands - Add macOS Apple Silicon installation section and JIT cache warmup guide - Update ods_tools compatibility table to include 3.2.x/4.0.x/5.0.x - Rewrite ODS-tools page: add combine and generate commands, update convert/check option lists - Fix OED page: broken/stale links, xlsx → CSV spec (v4.0.0), add marine cargo section, fix repo path changes - container_configuration.rst: update psycopg driver string, add API_AUTH_TYPE=disabled, server-internal RUN_MODE, Celery SSL/TLS vars - distributed_execution.rst: rename ktools_* → kernel_*, remove raw_output_locations (removed in 2.5.4) - Oasis-models.rst: add Dynamic Footprint, PiWind Vulnerability Adjustments, PiWind S3, and PiWind Azure model entries Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Per Sam's review comment on PR #47: maintaining inline RST changelogs is ongoing toil. Replace oasislmf.rst and oasis_platform.rst with simple link-out pages pointing to GitHub releases, and wire them into the Releases toctree so they're navigable from the docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Adds a new section (sections/api-client.rst) covering the oasislmf api subcommand — the recommended way for model developers to validate a model against a worker container before distributing it. Documents all six subcommands (run, generate-oasis-files, generate-losses, list, get, delete), all three auth modes (simple/oidc/m2m) with example credentials JSON, a step-by-step testing workflow, and config-file usage. Cross-linked from OasisLMF-package.rst and added to the main toctree. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
sambles
approved these changes
Jun 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
sections/api-client.rst— a new page documenting theoasislmf apiCLI subcommand (closes Oasis API Client Documentation #31)OasisLMF-package.rstand adds entry to the main toctreeThe page covers:
oasislmf apiinstead ofoasislmf model runfor model validation (platform serialisation differences)run,generate-oasis-files,generate-losses,list,get,deleteTest plan
make htmlinGenerateDocs/and verify the new page builds without warnings🤖 Generated with Claude Code