Hi - I answer from the OpenSmartRoute documentation: routing, the API, plans and quotas, self-hosting. Ask away, or open a support ticket if you need a person.
Grounded in the docs - follow a source before acting on it.
Use when editing OpenAPI contracts, generated API models/interfaces, controller signatures, or DTO mappings for the operator, backoffice, public, or EYCA APIs.
Instruction file imported from pagopa/cgn-onboarding-portal-backend (.github/instructions/openapi.instructions.md). Copyright stays with the author.
OpenAPI Contract Guidelines
Treat the files under openapi/ as the source of truth for API contracts.
openapi/openapi.yaml drives the main operator API, openapi/backoffice/openapi.yaml drives backoffice APIs, openapi/public.yaml drives public APIs, and openapi/eyca-data-export/openapi.yaml drives the EYCA client generation.
Maven generates the related it.gov.pagopa.cgnonboardingportal.* sources into target/generated-sources; do not hand-edit generated output.
When a spec changes, check the handwritten controller that implements the generated interface and the converter/facade classes that map between JPA entities and generated models.
Keep contract changes within the correct API surface instead of mixing operator, backoffice, public, and EYCA models.
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/pagopa-cgn-onboarding-portal-backend-openapi-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.
{
"ocm": "1",
"id": "pagopa-cgn-onboarding-portal-backend-openapi-instructions",
"kind": "skill",
"name": "OpenAPI Contract Guidelines",
"description": "Use when editing OpenAPI contracts, generated API models/interfaces, controller signatures, or DTO mappings for the operator, backoffice, public, or EYCA APIs.",
"publisher": "pagopa",
"version": "1.0.0",
"capabilities": {
"domains": [
"coding",
"legal"
],
"tags": [
"skill-md",
"github-instructions"
],
"languages": [
"en"
]
},
"quality_prior": 0.6,
"examples": [
"Use when editing OpenAPI contracts, generated API models/interfaces, controller signatures, or DTO mappings for the operator, backoffice, public, or EYCA APIs."
],
"primary": false,
"metadata": {
"source": {
"provider": "github-instructions",
"repository": "https://github.com/pagopa/cgn-onboarding-portal-backend",
"path": ".github/instructions/openapi.instructions.md",
"ref": "8aac44523db4fa342b17d015fb78ba32c4abb6e5",
"url": "https://github.com/pagopa/cgn-onboarding-portal-backend/blob/8aac44523db4fa342b17d015fb78ba32c4abb6e5/.github/instructions/openapi.instructions.md",
"key": "pagopa/cgn-onboarding-portal-backend/.github/instructions/openapi.instructions.md"
},
"applies_to": [
"openapi/*.yaml",
"openapi/**/*.yaml"
]
},
"instructions": "# OpenAPI Contract Guidelines\n\n- Treat the files under `openapi/` as the source of truth for API contracts.\n- `openapi/openapi.yaml` drives the main operator API, `openapi/backoffice/openapi.yaml` drives backoffice APIs, `openapi/public.yaml` drives public APIs, and `openapi/eyca-data-export/openapi.yaml` drives the EYCA client generation.\n- Maven generates the related `it.gov.pagopa.cgnonboardingportal.*` sources into `target/generated-sources`; do not hand-edit generated output.\n- When a spec changes, check the handwritten controller that implements the generated interface and the converter/",
"cost": {
"context_tokens": 196
}
}
Fetch it by URL: GET /api/v1/registry/pagopa-cgn-onboarding-portal-backend-openapi-instructions/manifest?version=1.0.0
Reviews
Star ratings from people who tried it. One review per account; edit yours any time.
No reviews yet. Install it, try it, and be the first to rate it.
