sdk-builder

分类: 开发与编程 | 上传者: pingidentity | 下载: 0 | 版本: v1.0（最新）

Guided workflow for generating SDKs from OpenAPI specifications. Use when users request SDK generation, build, or creation for specific products (pingone, identitycloud, etc.) and languages (go, python, etc.). Triggers on requests like "build the X SDK", "generate Y client library", "create Z API SDK", or any request to produce SDK code from OpenAPI specs.

更新日志: Source: GitHub https://github.com/pingidentity/pingone-openapi-specifications

目录结构

当前层级: .github/skills/sdk-builder/

📄 LICENSE.md 11.1 KB
📄 SKILL.md 4.3 KB

SKILL.md

---
name: sdk-builder
description: Guided workflow for generating SDKs from OpenAPI specifications. Use when users request SDK generation, build, or creation for specific products (pingone, identitycloud, etc.) and languages (go, python, etc.). Triggers on requests like "build the X SDK", "generate Y client library", "create Z API SDK", or any request to produce SDK code from OpenAPI specs.
---

# SDK Builder

Generates SDKs from OpenAPI specifications using a multi-step guided workflow.

## Workflow

### Step 1: Determine OAS Source

Ask the user for the OpenAPI specification source. If not provided, use default for `pingone`:
```
specification/3.1/api/sdk-generation/openapi.yaml
```

If not `pingone`, as the user to clarify the source.

OAS source can be:
- File path (local file)
- HTTP/HTTPS URL (remote file)
- FTP URL (remote file)
- Content in the request itself

### Step 2: Clarify Output Location

Ask where to place the generated SDK:

**Option A: Directory output (default)**
- Use the Makefile's default pattern: `dist/{language}/{product}/{version}`
- Allow custom directory override via TARGET_DIR

**Option B: Raise PR against remote project**
- Defer to a future "pr-raiser" skill (not yet implemented)
- For now, generate to default staging area: `dist/{language}/{product}/{version}`

### Step 3: Gather Required Parameters

Collect from user (all required):
- `LANGUAGE` - SDK language (e.g., go, python)
- `PRODUCT` - Product code (e.g., pingone, identitycloud)
- `VERSION` - SDK version - **MUST** be explicitly provided, never use a default
  - Expected format: Semver v2 with `v` prefix (e.g., v0.7.0, v1.2.3)
  - If version matches expected format, continue without interruption
  - If version does NOT match expected format, prompt user to clarify the intended version format

Optional:
- `TARGET_DIR` - Custom output directory

**Important**: The VERSION parameter must always be explicitly specified by the user or agent. Never assume or default a version number.

### Step 4: Retrieve Remote OAS (if needed)

If OAS source is remote (HTTP, HTTPS, FTP):
1. Use `run_in_terminal` with `curl` to download to temporary location
2. Store downloaded file path for use in next step

Example:
```bash
curl -L -o /tmp/openapi-spec.yaml "https://pingidentity.com/openapi.yaml"
```

### Step 5: Check Output Directory

Before generating the SDK, check if the output directory already exists and contains files:

1. Determine the target directory path:
   - If `TARGET_DIR` provided: use that path
   - Otherwise: use default pattern `dist/{language}/{product}/{version}`

2. Check directory status using `run_in_terminal`:
   ```bash
   if [ -d "/path/to/output" ] && [ "$(ls -A /path/to/output 2>/dev/null)" ]; then
     echo "EXISTS_AND_NOT_EMPTY"
   elif [ -d "/path/to/output" ]; then
     echo "EXISTS_BUT_EMPTY"
   else
     echo "DOES_NOT_EXIST"
   fi
   ```

3. Handle results:
   - **DOES_NOT_EXIST**: Proceed to Step 6
   - **EXISTS_BUT_EMPTY**: Proceed to Step 6
   - **EXISTS_AND_NOT_EMPTY**: Prompt user with options:
     ```
     The output directory already exists and contains files:
     {directory_path}
     
     How would you like to proceed?
     1. Remove existing directory and regenerate
     2. Cancel generation
     3. Specify a different output directory
     ```
     
     Based on user choice:
     - Option 1: Run `rm -rf {directory_path}` then proceed to Step 6
     - Option 2: Stop workflow and confirm cancellation
     - Option 3: Return to Step 2 to gather new TARGET_DIR, then re-check

### Step 6: Execute SDK Generation

Run Makefile `generate-sdk` target with parameters:

```bash
make generate-sdk \
  INPUT_OAS="/path/to/spec.yaml" \
  LANGUAGE=go \
  PRODUCT=pingone \
  VERSION=v0.0.1 \
  [TARGET_DIR=/custom/path]
```

The Makefile will:
1. Build the Docker image
2. Generate SDK to the target directory
3. Apply language-specific post-processing

### Step 7: Confirm Completion

Report to user:
- Location of generated SDK
- Next steps (if PR workflow was requested but deferred)

## Notes

- Always verify required parameters before running generation
- Always check for existing output directory and prompt user before overwriting
- For remote OAS files, validate download succeeded before proceeding
- Default output follows pattern: `dist/{language}/{product}/{version}`
- PR workflow requires future "pr-raiser" skill integration

登录后下载/点赞/收藏 ❤ 2 | ★ 0

sdk-builder

目录结构

SKILL.md

举报内容

提示