@neuland-ingolstadt/backend-core-api 0.0.0-stage → 1.0.5

package/README.md

@@ -1,3 +1,38 @@
-# Temporary Holding Version
+# `@neuland-ingolstadt/backend-core-api`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+TypeScript types (via `openapi-typescript`) and the OpenAPI 3.1 schema for
+**Neuland Backend Core API v0**.
+
+Published to [npmjs.com](https://www.npmjs.com/package/@neuland-ingolstadt/backend-core-api)
+(public, no auth). Versioned with the Maven artifact
+`app.neuland:backend-core-api-v0`. Releases are published from GitHub Actions via
+[npm Trusted Publishing](https://docs.npmjs.com/trusted-publishers/) (OIDC — no
+long-lived tokens).
+
+## Install
+
+```bash
+bun add @neuland-ingolstadt/backend-core-api
+# or: npm install @neuland-ingolstadt/backend-core-api
+```
+
+No `.npmrc` or token required.
+
+## Usage
+
+```ts
+import createClient from 'openapi-fetch'
+import type { paths } from '@neuland-ingolstadt/backend-core-api'
+
+const client = createClient<paths>({
+  baseUrl: 'https://core.api.neuland.app'
+})
+```
+
+Raw OpenAPI document:
+
+```ts
+import openApiUrl from '@neuland-ingolstadt/backend-core-api/openapi.yaml'
+```
+
+Or read `node_modules/@neuland-ingolstadt/backend-core-api/openapi.yaml`.

package/index.js

@@ -0,0 +1,2 @@
+/** Runtime placeholder — this package is types + OpenAPI schema only. */
+export {}