skills.rest
datagouv
datagouvOFFICIAL
Explore all skills by this author →
Website𝕏@datagouvfrGitHub

edit-endpoint

Edit API endpoint documentation and swagger definitions in the catalog.

13|8|Updated Apr 2, 2026
Search Tags:#documentation#swagger#endpoint#edit#api-entreprise#api-particulier
One-click install
npx skills add https://github.com/datagouv/apistration --skill edit-endpoint
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: edit-endpoint
Source: https://github.com/datagouv/apistration/tree/main/.claude/skills/edit-endpoint
Command: npx skills add https://github.com/datagouv/apistration --skill edit-endpoint

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams quickly modify the documentation of an API endpoint, including its business fiche (perimeter, FAQ, keywords, and description) and its Swagger/OpenAPI definitions.

Core Features & Use Cases

  • Edit endpoint fiche: update uid, path, perimeter, keywords, and descriptions for API Entreprise and API Particulier endpoints.
  • Swagger synchronization: update or add Swagger entries in the _swagger_shared files or provider-specific swagger sections.
  • Use Case: when an endpoint's scope changes or new FAQs are needed, this Skill updates both métier fiche and technical swagger in tandem.

Quick Start

Provide an updated endpoint fiche for the chosen API in the catalog, including perimetre, FAQ, keywords, description, and the corresponding swagger details if applicable.

Frequently Asked Questions about edit-endpoint

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update API endpoint documentation and Swagger definitions simultaneously?▼

You update API endpoint documentation and Swagger definitions by providing an updated endpoint fiche including perimeter, FAQ, keywords, and description alongside the corresponding swagger details. This synchronizes both the business fiche and technical swagger in tandem.

What is the process for editing API Entreprise and API Particulier endpoint fiches?▼

Editing API Entreprise and API Particulier endpoint fiches involves updating the uid, path, perimeter, keywords, and descriptions. The skill validates fiche fields and links them to the correct controller mappings and swagger entries for consistency.

Can I add new Swagger entries to shared swagger files for API endpoints?▼

Yes, you can update or add Swagger entries directly in the swagger_shared files or provider-specific swagger sections. This ensures the OpenAPI swagger definitions remain deployment-ready and synchronized with the endpoint fiche.

How do I keep endpoint perimeters and FAQs consistent with controller mappings?▼

Keeping endpoint perimeters and FAQs consistent requires validating and linking fiche fields to the correct controller mappings and swagger entries. This validation ensures deployment-ready documentation across API Entreprise and API Particulier catalogs.

What do I need to provide to start editing API endpoint documentation?▼

To start editing API endpoint documentation, provide an updated endpoint fiche for the chosen API in the catalog, including perimetre, FAQ, keywords, description, and the corresponding swagger details if applicable.

Related Skills

Explore More Software Engineering Skills→
datagouvdatagouv
13

bump-version

Create new API endpoint versions while preserving legacy YAML entries.

Official
Intermediate
blaxel-aiblaxel-ai
25

update-api-reference

Regenerate OpenAPI reference documentation from Go swag annotations.

Official
Intermediate
ananddtyagiananddtyagi
687

API Contract Sync Manager

Validate API contracts against backend implementations and generate TypeScript clients.

Community
Advanced
CloudyWingCloudyWing

generate-api-doc

Generates XML comments and Swagger attributes for ASP.NET Core controllers and endpoints.

Community
Intermediate