🧪 Skills

Alicloud Platform Openapi Product Api Discovery

Discover and reconcile Alibaba Cloud product catalogs from Ticket System, Support & Service, and BSS OpenAPI; fetch OpenAPI product/version/API metadata; and...

v1.0.2
❤️ 0
⬇️ 817
👁 4
Share

Description


name: alicloud-platform-openapi-product-api-discovery description: Discover and reconcile Alibaba Cloud product catalogs from Ticket System, Support & Service, and BSS OpenAPI; fetch OpenAPI product/version/API metadata; and summarize API coverage to plan new skills. Use when you need a complete product list, product-to-API mapping, or coverage/gap reports for skill generation. version: 1.0.0

Alibaba Cloud Product + API Discovery

Follow this workflow to collect products, resolve API metadata, and build summaries for skill planning.

Workflow

  1. Fetch product lists from the three sources
  • Ticket System (ListProducts)
  • Support & Service (ListProductByGroup)
  • BSS OpenAPI (QueryProductList)

Run the bundled scripts (from this skill folder):

python scripts/products_from_ticket_system.py
python scripts/products_from_support_service.py
python scripts/products_from_bssopenapi.py

Provide required env vars in each script (see references).

  1. Merge product lists
python scripts/merge_product_sources.py

This writes output/product-scan/merged_products.json and .md.

  1. Fetch OpenAPI metadata product list
python scripts/products_from_openapi_meta.py

This writes output/product-scan/openapi-meta/products.json and products_normalized.json.

  1. Fetch OpenAPI API docs per product/version
python scripts/apis_from_openapi_meta.py

By default this can be large. Use filters for dry runs:

  • OPENAPI_META_MAX_PRODUCTS=10
  • OPENAPI_META_PRODUCTS=Ecs,Ons
  • OPENAPI_META_VERSIONS=2014-05-26
  1. Join products with API counts
python scripts/join_products_with_api_meta.py
  1. Summarize products by category/group
python scripts/summarize_openapi_meta_products.py
  1. (Optional) Compare products vs existing skills
python scripts/analyze_products_vs_skills.py

Output discipline

All generated files must go under output/. Do not place temporary files elsewhere.

Validation

mkdir -p output/alicloud-platform-openapi-product-api-discovery
for f in skills/platform/openapi/alicloud-platform-openapi-product-api-discovery/scripts/*.py; do
  python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/alicloud-platform-openapi-product-api-discovery/validate.txt

Pass criteria: command exits 0 and output/alicloud-platform-openapi-product-api-discovery/validate.txt is generated.

Output And Evidence

  • Save artifacts, command outputs, and API response summaries under output/alicloud-platform-openapi-product-api-discovery/.
  • Include key parameters (region/resource id/time range) in evidence files for reproducibility.

Prerequisites

  • Configure least-privilege Alibaba Cloud credentials before execution.
  • Prefer environment variables: ALICLOUD_ACCESS_KEY_ID, ALICLOUD_ACCESS_KEY_SECRET, optional ALICLOUD_REGION_ID.
  • If region is unclear, ask the user before running mutating operations.

References

  • Product source APIs: see references/product-sources.md
  • OpenAPI meta endpoints: see references/openapi-meta.md

Reviews (0)

Sign in to write a review.

No reviews yet. Be the first to review!

Comments (0)

Sign in to join the discussion.

No comments yet. Be the first to share your thoughts!

Compatible Platforms

Pricing

Free

Related Configs