Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Conalog/patch-client

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

90 Commits
90 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

patch-client

This repository contains handwritten multi-language clients for the /api/v3 endpoints of the PATCH Plant Data API.

What is in this repo

  • TypeScript client (clients/typescript)
  • Python client (clients/python)
  • Go client (clients/go)
  • Rust client (clients/rust)
  • v3-only OpenAPI spec (openapi/openapi-v3.json)

Repository structure

.
├── clients/
│   ├── typescript/
│   ├── python/
│   ├── go/
│   └── rust/
├── openapi/
│   └── openapi-v3.json
└── scripts/
    └── update-openapi-v3.sh

Language clients

For language-specific usage, see each client README:

  • TypeScript: clients/typescript/README.md
  • Python: clients/python/README.md
  • Go: clients/go/README.md
  • Rust: clients/rust (crate: patch-client)

API spec sync (v3 only)

Extracts only /api/v3/ paths from the source OpenAPI and updates openapi/openapi-v3.json.

Requirements:

  • curl
  • jq

Run:

./scripts/update-openapi-v3.sh

Automated spec sync

GitHub Actions also keeps openapi/openapi-v3.json up to date automatically.

  • Weekly schedule: every Monday at 00:00 UTC, which is Monday 09:00 in Korea Standard Time
  • Manual trigger: Actions -> Sync OpenAPI v3 -> Run workflow
  • Commit behavior: if the extracted v3 snapshot changed, the workflow commits the updated openapi/openapi-v3.json directly to main

The workflow is defined in .github/workflows/sync-openapi-v3.yml and reuses scripts/update-openapi-v3.sh so local and automated sync stay consistent.

Local development

TypeScript

cd clients/typescript
npm install
npm run build

Python

cd clients/python
python -m pip install -e .

Go

cd clients/go
go test ./...

Rust

cd clients/rust
cargo test

Notes

  • The default API base URL is https://patch-api.conalog.com across clients.
  • Authentication generally uses an access token and the Account-Type header (viewer, manager, admin).

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Morty Proxy This is a proxified and sanitized view of the page, visit original site.