SAKURA internet · OpenAPI Overlay 1.0.0

API Evangelist overlay for AppRun共用型 APIドキュメント

4 actions 4 updates security extends ../openapi/_original/sakura-internet-apprun-shared-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for SAKURA internet's API. It is a proposal applied on top of the contract, not a document SAKURA internet publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

securitySchemessecurityexternalDocsx-api-evangelist

Targets 3

$.components

$.info

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist overlay for AppRun共用型 APIドキュメント
  version: 1.0.0
extends: ../openapi/_original/sakura-internet-apprun-shared-openapi.yml
x-generated: '2026-10-09'
x-method: generated
x-source: openapi/sakura-internet-apprun-shared-openapi.yml
x-rationale: 'Enhancements captured without mutating the original: adds the missing Basic-auth securityScheme
  and root security requirement; links the provider-hosted docs as externalDocs.'
actions:
- target: $.components
  description: Add the HTTP Basic scheme SAKURA documents for its cloud APIs (API key access token as
    username, access token secret as password). The spec ships no securitySchemes.
  update:
    securitySchemes:
      basicAuth:
        type: http
        scheme: basic
        description: 'さくらのクラウド API key: access token (username) + access token secret (password). See
          https://manual.sakura.ad.jp/cloud/api/apikey.html'
- target: $
  description: Apply basicAuth as the root security requirement.
  update:
    security:
    - basicAuth: []
- target: $
  description: Link the provider-hosted human documentation.
  update:
    externalDocs:
      url: https://manual.sakura.ad.jp/api/cloud/portal/apprun-shared-api/index.html
      description: SAKURA internet documentation
- target: $.info
  description: Agent-surface hints from the API Evangelist profile.
  update:
    x-api-evangelist:
      provider: sakura-internet
      mcp: mcp/sakura-internet-mcp.yml
      tool_crosswalk: mcp/sakura-internet-tool-crosswalk.yml
      llms: llms/sakura-internet-llms.txt