apiselector.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "ApiSelector",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "$schema": {
      "type": "string",
      "format": "uri",
      "description": "Selected schema for this file"
    },
    "GlobalApis": {
      "type": "array",
      "description": "Run all the configurations for this list of APIs",
      "items": {
        "$ref": "#/definitions/SelectedApi"
      }
    },
    "GlobalApisWithPath": {
      "type": "object",
      "description": "Run all the configurations for this list of APIs too, Here keys (i.e. folder paths) will be concatenated with each Api's FilePath",
      "additionalProperties": {
        "type": "array",
        "items": {
          "$ref": "#/definitions/SelectedApi"
        }
      }
    },
    "GlobalTemplates": {
      "type": "array",
      "description": "List of languages to be used by all the configurations",
      "items": {
        "$ref": "#/definitions/Languages"
      }
    },
    "ExecuteConfigs": {
      "type": "array",
      "description": "Select configuration names from the 'Configurations' Dictionary. The selected configurations will be executed.",
      "items": {
        "type": "string"
      }
    },
    "ApiSelectionFilter": {
      "type": "string",
      "description": "Only execute this apiSelector for the specs where the spec names are matching this ApiSelectionFilter regex. Default `*` i.e. run for all the selected specs."
    },
    "DisableApiCache": {
      "type": "boolean",
      "description": "Should disable cache of the imported API specs. Default `false` (i.e. Cache enabled)."
    },
    "Configurations": {
      "type": "object",
      "description": "Dictionary of API configurations, here Keys are configuration names.",
      "additionalProperties": {
        "$ref": "#/definitions/ApiConfig"
      }
    }
  },
  "definitions": {
    "SelectedApi": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "FilePath"
      ],
      "properties": {
        "FilePath": {
          "type": "string",
          "description": "Full path of the spec file/directory, or any spec file/directory name in the CI spec directory."
        },
        "Merge": {
          "type": "boolean",
          "description": "Controls the merging of all the specs in the directory, when the FilePath leads to a directory. Default: false"
        },
        "Namespaces": {
          "type": "object",
          "description": "Should only present if we want to merge namespaces to the spec specified at FilePath. Here key is the namespace name, while value is its FilePath",
          "additionalProperties": {
            "type": "string"
          }
        },
        "OnlyForTemplates": {
          "type": "array",
          "description": "Restrict code generation for this api to a limited number of languages",
          "items": {
            "$ref": "#/definitions/Languages"
          }
        }
      }
    },
    "Languages": {
      "type": "string",
      "description": "List of supported languages",
      "x-enumNames": [
        "cs",
        "java",
        "python",
        "ruby",
        "go",
        "php",
        "ts"
      ],
      "enum": [
        "cs",
        "java",
        "python",
        "ruby",
        "go",
        "php",
        "ts"
      ]
    },
    "ApiConfig": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "Apis": {
          "type": "array",
          "description": "List of APIs to be generated only for this configuration",
          "items": {
            "$ref": "#/definitions/SelectedApi"
          }
        },
        "Templates": {
          "type": "array",
          "description": "List of languages to be used only by this configuration",
          "items": {
            "$ref": "#/definitions/Languages"
          }
        },
        "UseCiSpecs": {
          "type": "boolean",
          "description": "Controls the generation of all the APIs in the CI specs directory, Default: false"
        },
        "UseAllSpecs": {
          "type": "boolean",
          "description": "Controls the generation of all the APIs in the CI specs directory including ignored specs, Default: false"
        },
        "UseGlobalApis": {
          "type": "boolean",
          "description": "Controls the inclusion of global apis in local apis, Default: true"
        },
        "UseGlobalTemplates": {
          "type": "boolean",
          "description": "Controls the inclusion of global templates in local templates, Default: true"
        },
        "OpenAfterGeneration": {
          "type": "boolean",
          "description": "Open generated folder or file after generation, Default: false"
        },
        "OpenSdkWithCommand": {
          "type": "string",
          "description": "A command or path to an executable. The generated SDK's path will be passed as an argument to it. For example if it's 'code' and the SDK is generated at /home/sdks/my-sdk, the command `code /home/sdks/my-sdk` will be run after generation. NOTE: On Windows, you need to give the full path to the executable/command. For example, for VS Code it would be something like C:\\Users\\<username>\\AppData\\Local\\Programs\\Microsoft VS Code\\bin\\code.cmd"
        },
        "MaxWindowsToOpenAfterGeneration": {
          "type": "integer",
          "description": "Max no. of windows that can be opened after executing this config. Used with OpenAfterGeneration, Default: 10"
        },
        "OutputDirPath": {
          "type": "string",
          "description": "Path of the folder where Docs or SDKs would be generated, Default: bin/*/*/"
        },
        "DirectoryPostFix": {
          "type": "string",
          "description": "Postfix added to the SDKs or Docs generated folders, Default: \"\""
        },
        "SdksPath": {
          "type": "string",
          "description": "Path of SDKs inside the OutputDirPath. Available placeholders are {template}, {sdkName}, and {specName}. Default: {template}\\{sdkName}"
        },
        "DocsPath": {
          "type": "string",
          "description": "Path of Docs inside the OutputDirPath. Available placeholders are {sdkName}. Default: DOCS\\{sdkName}"
        },
        "CodeSampleTemplatesPath": {
          "type": "string",
          "description": "Path of CodeSampleTemplates inside the OutputDirPath. Available placeholders are {template}, {sdkName}, and {specName}. Default: CodeSampleTemplates\\{template}\\{sdkName}"
        },
        "CodeSampleApiDataPath": {
          "type": "string",
          "description": "Path of CodeSampleApiData inside the OutputDirPath. Available placeholders are {sdkName}, and {specName}. Default: CodeSampleApiData\\{specName}"
        },
        "SpecWriteFile": {
          "type": "string",
          "description": "Path of Specs inside the OutputDirPath. Available placeholders are {sdkName}, and {specName}. Default: Jenkins\\apimatic-{specName}"
        },
        "ThrowError": {
          "type": "boolean",
          "description": "Controls throwing error on failure, Default: false"
        },
        "Sdks": {
          "type": "boolean",
          "description": "Controls the SDKs generation, Default: false"
        },
        "WriteExamplesInSdks": {
          "type": "boolean",
          "description": "Controls code samples generation in SDKs, Default: false"
        },
        "WriteDisabledTestModes": {
          "type": "boolean",
          "description": "Controls DisabledTestModes configuration generation while import, Default: false"
        },
        "Docs": {
          "type": "boolean",
          "description": "Controls Docs generation, Default: false"
        },
        "HttpDocs": {
          "type": "boolean",
          "description": "Controls Http Docs generation, Default: false"
        },
        "DocsWithToc": {
          "type": "boolean",
          "description": "Controls the Docs generation with or without TOC, Default: false (without TOC)"
        },
        "SdksWithCustomizations": {
          "type": "boolean",
          "description": "Controls the Sdk generation with or without customizations, Default: false (without customizations)"
        },
        "SrcDirectoryPath": {
          "type": "string",
          "description": "Path src build directory, Default: Settings\\Local\\ (Or Settings\\ if local directory is missing)"
        },
        "CodeSampleTemplates": {
          "type": "boolean",
          "description": "Controls CodeSampleTemplates generation, Default: false"
        },
        "HttpCodeSampleTemplates": {
          "type": "boolean",
          "description": "Controls CodeSampleTemplates generation for Http, Default: false"
        },
        "WriteLiquidJSRenderedOutputForCodeSampleTemplates": {
          "type": "boolean",
          "description": "Controls rendered CodeSampleTemplates generation, Default: false"
        },
        "CodeSampleApiData": {
          "type": "boolean",
          "description": "Controls CodeSampleApiData generation, Default: false"
        },
        "HttpCodeSampleApiData": {
          "type": "boolean",
          "description": "Controls CodeSampleApiData generation for Http, Default: false"
        },
        "WriteApimaticSpec": {
          "type": "boolean",
          "description": "Controls spec writing in apimatic type after validation and transformation, Default: false"
        },
        "ValidateSpec": {
          "type": "boolean",
          "description": "Controls spec validation and transformation. You can also use WriteApimaticSpec to validate and write the result as well , Default: false"
        },
        "WriteFailureReport": {
          "type": "boolean",
          "description": "Controls failure report generation, Default: false"
        },
        "WriteMinimalLogs": {
          "type": "boolean",
          "description": "Controls writing a quieter version of success logs to the console, Default: false"
        }
      }
    }
  }
}