Discovery.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Discovery internal schema for API documentation",
  "description": "This schema describe the Discovery section of our build process - allowing to extend the application by including other APIs to display",
  "type": "object",
  "properties": {
    "apis": {
      "description": "List of API groups supported",
      "type": "array",
      "items": {
        "$ref": "#/definitions/Group"
      },
      "minItems": 1
    },
    "tags": {
      "description": "List of known tags",
      "type": "array",
      "items": {
        "$ref": "#/definitions/Tag"
      }
    }
  },
  "required": [
    "apis"
  ],
  "definitions": {
    "Group": {
      "description": "Groups multiple APIs together. i.e. insights, openshift, etc",
      "type": "object",
      "properties": {
        "id": {
          "description": "Identifier of the group. i.e. insights",
          "$ref": "#/definitions/id"
        },
        "name": {
          "description": "Display name for the group. i.e. Hybrid Cloud Console and Insights",
          "type": "string"
        },
        "apps": {
          "description": "Apps within the group",
          "type": "array",
          "items": {
            "$ref": "#/definitions/App"
          },
          "minItems": 1
        }
      },
      "required": [
        "id",
        "name",
        "apps"
      ]
    },
    "App": {
      "description": "Applications whose API wants to be displayed",
      "type": "object",
      "properties": {
        "id": {
          "description": "Identifier of the application. i.e. cost-management",
          "$ref": "#/definitions/id"
        },
        "name": {
          "description": "Display name for the application. i.e. Cost Management",
          "type": "string"
        },
        "description": {
          "description": "Displayed description for the application.",
          "type": "string",
          "maxLength": 100
        },
        "consoleUrl": {
          "description": "Base URL of the redhat console",
          "type": "string"
        },
        "url": {
          "description": "URL to the public API file",
          "type": "string"
        },
        "useLocalFile": {
          "description": "Decide if we should try to fetch the API or use the local file",
          "type": "boolean"
        },
        "apiType": {
          "description": "Type of the API",
          "type": "string",
          "enum": [ "openapi-v3", "openapi-v2", "graphql", "unknown" ]
        },
        "icon": {
          "$ref": "#/definitions/icon"
        },
        "tags": {
          "description": "Array of tag ids associated to this application",
          "type": "array",
          "items": {
            "$ref": "#/definitions/id"
          }
        }
      },
      "required": [
        "id",
        "name",
        "description",
        "apiType"
      ],
      "allOf": [
        {
          "$ref": "#/definitions/url-or-use-local-or-skip"
        },
        {
          "$ref": "#/definitions/skip-with-reason"
        }
      ]
    },
    "Tag": {
      "type": "object",
      "properties": {
        "id": {
          "$ref": "#/definitions/id"
        },
        "name": {
          "type": "string"
        },
        "type": {
          "description": "Type of tag",
          "type": "string",
          "enum": ["use-case", "service", "platform"]
        }
      },
      "allOf": [
        {
          "$ref": "#/definitions/developers-redhat-com-taxonomy"
        }
      ],
      "required": [
        "id",
        "name",
        "type"
      ]
    },
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9_\\-]+$"
    },
    "icon": {
      "type": "string",
      "enum": [
        "ansible",
        "edge",
        "insights",
        "openshift",
        "services",
        "subscriptions"
      ]
    },
    "skip-with-reason": {
      "type": "object",
      "properties": {
        "skip": {
          "type": "boolean"
        }
      },
      "dependencies": {
        "skip": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "skip": {
                  "const": false
                }
              }
            },
            {
              "type": "object",
              "properties": {
                "skipReason": {
                  "type": "string"
                }
              },
              "required": ["skipReason"]
            }
          ]
        }
      }
    },
    "url-or-use-local-or-skip": {
      "description": "Should set at least url, skip=true or useLocalFile=true",
      "anyOf": [
        {
          "type": "object",
          "required": ["url"]
        },
        {
          "type": "object",
          "properties": {
            "useLocalFile": {
              "const": true
            }
          },
          "required": [ "useLocalFile" ]
        },
        {
          "type": "object",
          "properties": {
            "skip": {
              "const": true
            }
          }
        }
      ]
    },
    "developers-redhat-com-taxonomy": {
      "properties": {
        "dev-rh:taxonomy": {
          "description": "Taxonomy terms as defined in 'Developers Product and Topic terms' document",
          "properties": {
            "product-line": {
              "enum": [
                "OpenShift"
              ]
            },
            "product": {
              "enum": [
                "Azure Red Hat OpenShift",
                "Cloud services - Application services",
                "Developer Sandbox for Red Hat OpenShift",
                "Helm",
                "Identity Management",
                "Migration Toolkit for Runtimes",
                "odo",
                "OpenShift Connector",
                "OpenShift Developer Console",
                "Red Hat 3scale API Management",
                "Red Hat Advanced Cluster Management for Kubernetes",
                "Red Hat Advanced Cluster Security for Kubernetes",
                "Red Hat Application Studio",
                "Red Hat build of Eclipse Vert.x",
                "Red Hat build of Node.js",
                "Red Hat build of OpenJDK",
                "Red Hat build of Quarkus.",
                "Red Hat Ceph Storage",
                "Red Hat CodeReady Dependency Analytics",
                "Red Hat Directory Server",
                "Red Hat OpenShift API Management",
                "Red Hat OpenShift Data Foundation",
                "Red Hat OpenShift Data Science",
                "Red Hat OpenShift Database Access",
                "Red Hat OpenShift Dev Spaces",
                "Red Hat OpenShift GitOps",
                "Red Hat OpenShift Local",
                "Red Hat OpenShift Serverless",
                "Red Hat OpenShift Service Mesh",
                "Red Hat OpenShift Service on AWS",
                "Red Hat OpenShift Streams for Apache Kafka",
                "Red Hat Quay",
                "Red Hat Single sign-on",
                "Red Hat support for Spring Boot",
                "Service Binding Operator",
                "Red Hat AMQ",
                "Red Hat Ansible Automation Platform",
                "Red Hat CodeReady Linux Builder",
                "Red Hat CodeReady Containers",
                "Red Hat OpenShift Pipelines",
                "Red Hat CodeReady Studio",
                "CodeReady Toolchain",
                "Red Hat CodeReady Workspaces",
                "Container Development Kit",
                "Red Hat Data Grid",
                "Decision Manager",
                "Developer Toolset",
                "Fuse",
                "JBoss Data Virtualization",
                "Red Hat JBoss Enterprise Application Platform",
                "Red Hat JBoss Web Server",
                "Migration Toolkit for Applications",
                "Mobile Application Platform",
                "Red Hat OpenShift",
                "OpenShift Runtimes",
                "OpenShift Cloud Functions",
                "Red Hat OpenShift Container Platform",
                "OpenShift Container Storage",
                "OpenShift.io",
                "Process Automation Manager",
                "RHEL",
                "RHEL CoreOS",
                "RHEL for SAP Solutions",
                "Red Hat Software Collections",
                "VSCode Plugins",
                "Unspecified"
              ]
            },
            "topic": {
              "enum": [
                ".NET",
                "Big Data",
                "Camel K",
                "Compilers",
                "Data Encapsulation",
                "Data integration",
                "Integration",
                "Internet of Things",
                "Kotlin",
                "Open Data Hub",
                "Performance",
                "Programming languages",
                "Runtimes",
                "Rust",
                "Serverless integration",
                "Stream processing",
                "Windows",
                "Data Science",
                "AI/ML",
                "API Management",
                "Automation",
                "C",
                "C#",
                "C++",
                "CI/CD",
                "Containers",
                "Developer Tools",
                "DevOps",
                "DevSecOps",
                "Edge",
                "Event-Driven",
                "GitOps",
                "Go",
                "Helm",
                "IDEs",
                "Java",
                "JavaScript",
                "Linux",
                "Kafka",
                "Kubernetes",
                "Microservices",
                "Node.js",
                "Operators",
                "OpenShift",
                "Open Source",
                "PHP",
                "Python",
                "Quarkus",
                "Ruby",
                "Spring Boot",
                "Service Mesh",
                "Serverless",
                "Security",
                "Secure Coding",
                "UI/UX",
                "Unspecified"
              ]
            }
          }
        }
      }
    }
  }
}