feat: +x-prerequisite

2026-05-07 23:02:38 +02:00 · 2023-09-16 14:56:38 +08:00 · 2023-09-16 14:56:38 +08:00 · b4493052e7
commit b4493052e7
parent 9fdf706586
2 changed files with 96 additions and 61 deletions
--- a/.well-known/metagpt_oas3_api.yaml
+++ b/.well-known/metagpt_oas3_api.yaml
@ -13,12 +13,17 @@ servers:
 paths:
  /tts/azsure:
    x-prerequisite:
-      - name: AZURE_TTS_SUBSCRIPTION_KEY
-        type: string
-        description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
-      - name: AZURE_TTS_REGION
-        type: string
-        description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
+      configurations:
+        AZURE_TTS_SUBSCRIPTION_KEY:
+          type: string
+          description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
+        AZURE_TTS_REGION:
+          type: string
+          description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
+      required:
+        allOf:
+          - AZURE_TTS_SUBSCRIPTION_KEY
+          - AZURE_TTS_REGION
    post:
      summary: "Convert Text to Base64-encoded .wav File Stream"
      description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
@ -77,15 +82,21 @@ paths:

  /tts/iflytek:
    x-prerequisite:
-      - name: IFLYTEK_APP_ID
-        type: string
-        description: "Application ID is used to access your iFlyTek service API, see: `https://console.xfyun.cn/services/tts`"
-      - name: IFLYTEK_API_KEY
-        type: string
-        description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
-      - name: IFLYTEK_API_SECRET
-        type: string
-        description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
+      configurations:
+        IFLYTEK_APP_ID:
+          type: string
+          description: "Application ID is used to access your iFlyTek service API, see: `https://console.xfyun.cn/services/tts`"
+        IFLYTEK_API_KEY:
+          type: string
+          description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
+        IFLYTEK_API_SECRET:
+          type: string
+          description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
+      required:
+        allOf:
+          - IFLYTEK_APP_ID
+          - IFLYTEK_API_KEY
+          - IFLYTEK_API_SECRET
    post:
      summary: "Convert Text to Base64-encoded .mp3 File Stream"
      description: "For more details, check out: [iFlyTek](https://console.xfyun.cn/services/tts)"
@ -137,9 +148,13 @@ paths:

  /txt2img/openai:
    x-prerequisite:
-      - name: OPENAI_API_KEY
-        type: string
-        description: "OpenAI API key, For more details, checkout: `https://platform.openai.com/account/api-keys`"
+      configurations:
+        OPENAI_API_KEY:
+          type: string
+          description: "OpenAI API key, For more details, checkout: `https://platform.openai.com/account/api-keys`"
+      required:
+        allOf:
+          - OPENAI_API_KEY
    post:
      summary: "Convert Text to Base64-encoded Image Data Stream"
      operationId: openai_text_to_image.oas3_openai_text_to_image
@ -179,9 +194,13 @@ paths:
          description: "Internal Server Error"
  /txt2embedding/openai:
    x-prerequisite:
-      - name: OPENAI_API_KEY
-        type: string
-        description: "OpenAI API key, For more details, checkout: `https://platform.openai.com/account/api-keys`"
+      configurations:
+        OPENAI_API_KEY:
+          type: string
+          description: "OpenAI API key, For more details, checkout: `https://platform.openai.com/account/api-keys`"
+      required:
+        allOf:
+          - OPENAI_API_KEY
    post:
      summary: Text to embedding
      operationId: openai_text_to_embedding.oas3_openai_text_to_embedding
@ -222,9 +241,13 @@ paths:

  /txt2image/metagpt:
    x-prerequisite:
-      - name: METAGPT_TEXT_TO_IMAGE_MODEL_URL
-        type: string
-        description: "Model url."
+      configurations:
+        METAGPT_TEXT_TO_IMAGE_MODEL_URL:
+          type: string
+          description: "Model url."
+      required:
+        allOf:
+          - METAGPT_TEXT_TO_IMAGE_MODEL_URL
    post:
      summary: "Text to Image"
      description: "Generate an image from the provided text using the MetaGPT Text-to-Image API."
--- a/.well-known/skills.yaml
+++ b/.well-known/skills.yaml
@ -12,29 +12,32 @@ entities:
      - name: text_to_speech
        description: Text-to-speech
        id: text_to_speech.text_to_speech
-        required:
-          oneOf:
-            - schema:
-               type: object
-               properties:
-                 AZURE_TTS_SUBSCRIPTION_KEY:
-                   type: string
-                   description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
-                 AZURE_TTS_REGION:
-                   type: string
-                   description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
-            - schema:
-               type: object
-               properties:
-                IFLYTEK_APP_ID:
-                  type: string
-                  description: "Application ID is used to access your iFlyTek service API, see: `https://console.xfyun.cn/services/tts`"
-                IFLYTEK_API_KEY:
-                  type: string
-                  description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
-                IFLYTEK_API_SECRET:
-                  type: string
-                  description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
+        x-prerequisite:
+          configurations:
+            AZURE_TTS_SUBSCRIPTION_KEY:
+              type: string
+              description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
+            AZURE_TTS_REGION:
+              type: string
+              description: "For more details, check out: [Azure Text-to_Speech](https://learn.microsoft.com/en-us/azure/ai-services/speech-service/language-support?tabs=tts)"
+            IFLYTEK_APP_ID:
+              type: string
+              description: "Application ID is used to access your iFlyTek service API, see: `https://console.xfyun.cn/services/tts`"
+            IFLYTEK_API_KEY:
+              type: string
+              description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
+            IFLYTEK_API_SECRET:
+              type: string
+              description: "WebAPI argument, see: `https://console.xfyun.cn/services/tts`"
+          required:
+            oneOf:
+              - allOf:
+                - AZURE_TTS_SUBSCRIPTION_KEY
+                - AZURE_TTS_REGION
+              - allOf:
+                - IFLYTEK_APP_ID
+                - IFLYTEK_API_KEY
+                - IFLYTEK_API_SECRET
        parameters:
          text:
            description: 'The text used for voice conversion.'
@ -51,9 +54,9 @@ entities:
            description: Name of voice styles
            type: string
            default: zh-CN-XiaomoNeural
-          style: 
+          style:
            type: string
-            description: Speaking style to express different emotions like cheerfulness, empathy, and calm. 
+            description: Speaking style to express different emotions like cheerfulness, empathy, and calm.
            enum:
              - affectionate
              - angry
@ -95,16 +98,20 @@ entities:
      - name: text_to_image
        description: Create a drawing based on the text.
        id: text_to_image.text_to_image
-        required:
-          oneOf: 
-            - name: OPENAI_API_KEY
+        x-prerequisite:
+          configurations:
+            OPENAI_API_KEY:
              type: string
              description: "OpenAI API key, For more details, checkout: `https://platform.openai.com/account/api-keys`"
-            - name: METAGPT_TEXT_TO_IMAGE_MODEL_URL
+            METAGPT_TEXT_TO_IMAGE_MODEL_URL:
              type: string
              description: "Model url."
+          required:
+            oneOf:
+              - OPENAI_API_KEY
+              - METAGPT_TEXT_TO_IMAGE_MODEL_URL
        parameters:
-          text: 
+          text:
            description: 'The text used for image conversion.'
            type: string
            required: true
@ -124,13 +131,18 @@ entities:
      - name: web_search
        description: Perform Google searches to provide real-time information.
        id: web_search.web_search
-        required:
-          - name: SEARCH_ENGINE
-            type: string
-            description: "Supported values: serpapi/google/serper/ddg"
-          - name: SERPER_API_KEY
-            type: string
-            description: "SERPER API KEY, For more details, checkout: `https://serper.dev/api-key`"
+        x-prerequisite:
+          configurations:
+            SEARCH_ENGINE:
+              type: string
+              description: "Supported values: serpapi/google/serper/ddg"
+            SERPER_API_KEY:
+              type: string
+              description: "SERPER API KEY, For more details, checkout: `https://serper.dev/api-key`"
+          required:
+            allOf:
+              - SEARCH_ENGINE
+              - SERPER_API_KEY
        parameters:
          query:
            type: string