api-auth

Name: api-auth
Author: codezorz

API and auth

by codezorz(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Instruction file imported from codezorz/home-assistant-mijnted (.github/instructions/api-auth.instructions.md). Copyright stays with the author.

API and auth

API: All HTTP calls to MijnTed go through api.py (class MijntedApi). Add new endpoints as methods there. Keep URLs and timeouts in const.py, not in api.py.
Auth: OAuth2 and token refresh live in auth.py (MijnTedAuth). The API uses the auth layer; do not store raw passwords in config entry data—only tokens and identifiers.
Errors: Use exceptions from exceptions.py (e.g. MijntedApiError, MijntedAuthenticationError). Let the coordinator or config flow catch them and show user-friendly messages or retries.
Documentation: When changing or adding API methods, check doc/ENDPOINTS.md first (it documents all endpoints), then update it so URLs, parameters, and response shape stay accurate.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml

targets:
  - https://api.opensmartroute.ai/api/v1/registry/codezorz-home-assistant-mijnted-api-auth-instructions/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

codezorz-home-assistant-mijnted-api-auth-instructions.ocm.jsonjson

{
  "ocm": "1",
  "id": "codezorz-home-assistant-mijnted-api-auth-instructions",
  "kind": "skill",
  "name": "api-auth",
  "description": "API and auth",
  "publisher": "codezorz",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "github-instructions"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "API and auth"
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "github-instructions",
      "repository": "https://github.com/codezorz/home-assistant-mijnted",
      "path": ".github/instructions/api-auth.instructions.md",
      "ref": "25e1954fdc6203b7144efd45ccc5da43b3527316",
      "url": "https://github.com/codezorz/home-assistant-mijnted/blob/25e1954fdc6203b7144efd45ccc5da43b3527316/.github/instructions/api-auth.instructions.md",
      "key": "codezorz/home-assistant-mijnted/.github/instructions/api-auth.instructions.md"
    },
    "applies_to": "custom_components/mijnted/api.py,custom_components/mijnted/auth.py,custom_components/mijnted/exceptions.py"
  },
  "instructions": "# API and auth\n\n- **API**: All HTTP calls to MijnTed go through `api.py` (class `MijntedApi`). Add new endpoints as methods there. Keep URLs and timeouts in `const.py`, not in `api.py`.\n- **Auth**: OAuth2 and token refresh live in `auth.py` (`MijnTedAuth`). The API uses the auth layer; do not store raw passwords in config entry data—only tokens and identifiers.\n- **Errors**: Use exceptions from `exceptions.py` (e.g. `MijntedApiError`, `MijntedAuthenticationError`). Let the coordinator or config flow catch them and show user-friendly messages or retries.\n- **Documentation**: When changing or ad",
  "cost": {
    "context_tokens": 187
  }
}

Fetch it by URL: GET /api/v1/registry/codezorz-home-assistant-mijnted-api-auth-instructions/manifest?version=1.0.0

About

API and auth

Use it

Manifest

Reviews