MC FORGE Companion 2023 with REPO Serach · GPT 작업

openapi: "3.0.0"
info:
  version: "1.0.0"
  title: "GitHub Repository Strucutre and contents API"
  description: "API to fetch structure and contents of a GitHub repository."
servers:
  - url: "https://githubget.mynatapp.cc"
paths:
  /get:
    get:
      summary: "Get GitHub Repository Contents"
      operationId: "getGitHubContents"
      tags:
        - "Repository"
      parameters:
        - name: "username"
          in: "query"
          description: "GitHub username of the repository owner."
          required: true
          schema:
            type: "string"
        - name: "repoRoot"
          in: "query"
          description: "Root path of the GitHub repository (e.g. for root, repositoryName/contents)."
          required: true
          schema:
            type: "string"
        - name: "branch"
          in: "query"
          description: "The branch that user points，if user does not point,input value 'default' "
          required: true
          schema:
            type: "string"
        - name: "default_depth"
          in: "query"
          description: "How deep show directory search，if user does not point,input value '1' for fetch this directory's content of files "
          required: true
          schema:
            type: "string"
      responses:
        '200':
          description: "Successfully retrieved the repository strcutre."
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  status:
                    type: "string"
                    example: "success"
                  data:
                    type: "string"
                    example: {
                    "file1": "file1 content",
                    "file2": "file2 content"
                    }
        '404':
          description: "Repository not found or contents unavailable."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        default:
          description: "Unexpected error"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
  /get_stru:
    get:
      summary: "Get GitHub Repository Structure"
      operationId: "getGitHubRepoStrucutre"
      tags:
        - "Repository"
      parameters:
        - name: "username"
          in: "query"
          description: "GitHub username of the repository owner."
          required: true
          schema:
            type: "string"
        - name: "repoRoot"
          in: "query"
          description: "Root path of the GitHub repository (e.g. for root, repositoryName/contents)."
          required: true
          schema:
            type: "string"
        - name: "branch"
          in: "query"
          description: "The branch that user points，if user does not point,input value 'default' "
          required: true
          schema:
            type: "string"
        - name: "default_depth"
          in: "query"
          description: "How deep show directory search，if user does not point,input value '3' "
          required: true
          schema:
            type: "string"
      responses:
        '200':
          description: "Successfully retrieved the repository strcutre."
          content:
            application/json:
              schema:
                type: "object"
                properties:
                  status:
                    type: "string"
                    example: "success"
                  data:
                    type: "string"
                    example: {
                    "file1": "file1 content",
                    "file2": "file2 content"
                    }
        '404':
          description: "Repository not found or structure unavailable."
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
        default:
          description: "Unexpected error"
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  schemas:
    Error:
      type: "object"
      required:
        - code
        - message
      properties:
        code:
          type: "integer"
          format: "int32"
        message:
          type: "string"