bcgovpubcode.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {
    "language_name_version": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name",
        "version"
      ],
      "properties": {
        "name": {
          "title": "Name",
          "description": "This key contains the name of the language used",
          "type": "string",
          "enum": [
            "C",
            "C#",
            "C++",
            "Clojure",
            "CoffeeScript",
            "Cobol",
            "Dart",
            "Elixir",
            "Erlang",
            "F#",
            "Fortran",
            "Go",
            "Groovy",
            "Haskell",
            "Java",
            "JavaScript",
            "Julia",
            "Kotlin",
            "Lua",
            "Objective-C",
            "Perl",
            "PHP",
            "PowerShell",
            "Python",
            "R",
            "Ruby",
            "Rust",
            "Scala",
            "Shell",
            "Swift",
            "Zig",
            "TypeScript",
            "Other"
          ]
        },
        "version": {
          "title": "Version",
          "description": "This key contains the Version.",
          "type": "string"
        }
      }
    },
    "frameworks_name_version": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "name",
        "version"
      ],
      "properties": {
        "name": {
          "title": "Name",
          "description": "This key contains the Name of the framework used",
          "type": "string",
          "enum": [
            "Actix",
            "Angular",
            "ASP.NET",
            "Bootstrap",
            "Bun",
            "Cordova",
            "Deno",
            "Django",
            "Express",
            "FastAPI",
            "Fiber",
            "Flask",
            "Happi",
            "Helidon",
            "jQuery",
            "Koa",
            "Laravel",
            "Micronaut",
            "NestJS",
            "Next.js",
            "Node.js",
            "Quarkus",
            "React",
            "Ruby on Rails",
            "Spring Boot",
            "Svelte",
            "Vue",
            "Other"
          ]
        },
        "version": {
          "title": "Version",
          "description": "This key contains the Version.",
          "type": "string"
        }
      }
    },
    "product_information": {
      "type": "object",
      "required": [
        "ministry",
        "program_area",
        "product_acronym",
        "product_name",
        "product_description"
      ],
      "properties": {
        "ministry": {
          "uniqueItems": true,
          "title": "Ministry",
          "description": "This key contains the ministry name. -> link: https://www2.gov.bc.ca/gov/content/governments/organizational-structure/ministries-organizations/ministries",
          "type": "array",
          "items": {
            "enum": [
              "Agriculture and Food",
              "Attorney General",
              "Children and Family Development",
              "Citizens' Services",
              "Education and Child Care",
              "Emergency Management and Climate Readiness",
              "Energy, Mines and Low Carbon Innovation",
              "Environment and Climate Change Strategy",
              "Finance",
              "Forests",
              "Health",
              "Housing",
              "Indigenous Relations & Reconciliation",
              "Jobs, Economic Development and Innovation",
              "Labour",
              "Mental Health and Addictions",
              "Municipal Affairs",
              "Post-Secondary Education and Future Skills",
              "Public Safety and Solicitor General",
              "Social Development and Poverty Reduction",
              "Tourism, Arts, Culture and Sport",
              "Transportation and Infrastructure",
              "Water, Land and Resource Stewardship"
            ]
          }
        },
        "program_area": {
          "title": "Program Area",
          "description": "This key contains the program area name. ex: It could be a ministry division branch or section. ",
          "type": "string"
        },
        "product_acronym": {
          "title": "Product Acronym",
          "description": "This key contains the product acronym. ex: Infrastructure reporting service the acronym (IRS)",
          "type": "string"
        },
        "product_name": {
          "title": "Product Name",
          "description": "This key contains the full product name.",
          "type": "string"
        },
        "product_description": {
          "title": "Product Description",
          "description": "This key contains description of the product.",
          "type": "string"
        },
        "product_status": {
          "title": "Product Status",
          "description": "Status of the product. more around this can be found here. link: https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md",
          "type": "string",
          "enum": [
            "active",
            "stable",
            "maturing",
            "dormant",
            "retired"
          ]
        },
        "product_urls": {
          "uniqueItems": true,
          "title": "Product URLs",
          "description": "Different Urls of the product.",
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "api_specifications": {
          "title": "API Specifications",
          "description": "API specification URLs",
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          }
        },
        "business_capabilities_standard": {
          "uniqueItems": true,
          "title": "Business Capabilities - Standard",
          "description": "This key contains the business capabilities that are supported by this product.",
          "type": "array",
          "default": [],
          "items": {
            "enum": [
              "Agriculture Land Management",
              "Authorization Management",
              "Climate Action",
              "Client Advisory Services",
              "Communications",
              "Compliance and Enforcement",
              "Economic Development",
              "Emergency Management",
              "Emergency Response Planning",
              "Environment Sustainability",
              "Environmental Assessments",
              "Environmental Protection",
              "Financial Management",
              "First Nations Consultations",
              "Heritage Protection",
              "Human Resources Management",
              "Laboratory Services",
              "Land Use Planning",
              "Manage Object Storage Objects",
              "Mineral Titles and Tenures",
              "Parks Management",
              "Performance Management",
              "Policy and Legislation",
              "Procurement",
              "Program Management",
              "Referrals",
              "Resource Management",
              "Site Remediation",
              "Stakeholder Engagement",
              "Tenure Management",
              "Timber Pricing and Sales",
              "Workplace Strategies",
              "Other"
            ]
          }
        }
      },
      "allOf": [
        {
          "if": {
            "properties": {
              "business_capabilities_standard": {
                "contains": {
                  "enum": [
                    "Other"
                  ]
                }
              }
            }
          },
          "then": {
            "properties": {
              "business_capabilities_custom": {
                "title": "Business Capabilities - Custom",
                "description": "This key contains the business capabilities that are supported by this product, which are not available in pick list of \"Business Capabilities Standard\". comma separated string with free text",
                "type": "string"
              }
            }
          },
          "else": {}
        }
      ]
    },
    "product_technology_info": {
      "type": "object",
      "required": [
        "hosting_platforms"
      ],
      "properties": {
        "backend_languages_version": {
          "uniqueItems": true,
          "title": "Backend Languages with their version",
          "description": "This key contains the languages used for backends( java or erlang or golang or elixir or rust) with their version",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/language_name_version"
          }
        },
        "backend_frameworks": {
          "uniqueItems": true,
          "title": "Backend Frameworks",
          "description": "This key contains the frameworks used for backends( express or gin or fiber or spring boot or quarkus)",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/frameworks_name_version"
          }
        },
        "frontend_languages": {
          "uniqueItems": true,
          "title": "Frontend Languages",
          "description": "This key contains the frontend languages",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/language_name_version"
          }
        },
        "frontend_frameworks": {
          "uniqueItems": true,
          "title": "Frontend Frameworks",
          "description": "This key contains the frontend frameworks(react or angular or vue or svelte)",
          "type": "array",
          "items": {
            "type": "object",
            "$ref": "#/definitions/frameworks_name_version"
          }
        },
        "hosting_platforms": {
          "uniqueItems": true,
          "title": "Hosting Platforms",
          "minItems": 1,
          "default": [],
          "description": "This key contains the hosting platforms used in this product",
          "type": "array",
          "items": {
            "enum": [
              "Amazon-Web-Services",
              "Google-Cloud-Platform",
              "Microsoft-Azure",
              "On-Premise-Physical",
              "On-Premise-Virtual",
              "Private-Cloud-Openshift",
              "Other"
            ]
          }
        },
        "other_tools": {
          "title": "Other Tools Used",
          "description": "This key contains the other tools used for the product or by the product team, including any tools that don't fall into the above categories. Ex: Mural, Sentry, Sysdig, ACS",
          "type": "string"
        }
      },
      "allOf": [
        {
          "if": {
            "properties": {
              "hosting_platforms": {
                "contains": {
                  "enum": [
                    "Other"
                  ]
                }
              }
            }
          },
          "then": {
            "properties": {
              "hosting_platforms_custom": {
                "title": "Hosting Platforms - Custom",
                "description": "This key contains the hosting platform the product is hosted on which is not available as a pick list in the Hosting Platforms. Comma separated string with free text",
                "type": "string"
              },
              "data_storage_platforms": {
                "uniqueItems": true,
                "title": "Data Storage Platforms",
                "description": "This key contains the data storage platforms used, relational, in-memory, spatial, document, object storage",
                "type": "array",
                "default": [],
                "items": {
                  "enum": [
                    "Cassandra",
                    "Dynamodb",
                    "Esri-Geodatabase",
                    "Esri-Sde",
                    "Microsoft-Access",
                    "Memcached",
                    "Mongodb",
                    "Mysql",
                    "Object-Storage",
                    "Oracle",
                    "Oracle-Spatial",
                    "Postgis",
                    "Postgresql",
                    "Redis",
                    "Sqlserver",
                    "Tikv",
                    "Other"
                  ]
                }
              }
            },
            "required": [
              "hosting_platforms_custom"
            ]
          },
          "else": {
            "properties": {
              "data_storage_platforms": {
                "uniqueItems": true,
                "title": "Data Storage Platforms",
                "description": "This key contains the data storage platforms used, relational, in-memory, spatial, document, object storage",
                "type": "array",
                "default": [],
                "items": {
                  "type": "string",
                  "enum": [
                    "Cassandra",
                    "Dynamodb",
                    "Esri-Geodatabase",
                    "Esri-Sde",
                    "Microsoft-Access",
                    "Memcached",
                    "Mongodb",
                    "Mysql",
                    "Object-Storage",
                    "Oracle",
                    "Oracle-Spatial",
                    "Postgis",
                    "Postgresql",
                    "Redis",
                    "Sqlserver",
                    "Tikv",
                    "Other"
                  ]
                }
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "data_storage_platforms": {
                "contains": {
                  "enum": [
                    "Other"
                  ]
                }
              }
            }
          },
          "then": {
            "properties": {
              "data_storage_platforms_custom": {
                "title": "Data Storage Platforms - Custom",
                "description": "This key contains the data storage platforms used, relational, in-memory, spatial, document, object storage,  which is not available as a pick list in the Data Storage Platforms. Comma separated string with free text",
                "type": "string"
              },
              "ci_cd_tools": {
                "uniqueItems": true,
                "title": "Continuous Integration and Delivery Tools",
                "description": "This key contains the CI/CD tools used for the product. ex: GitHub Actions, ArgoCD, Helm, Kustomize",
                "type": "array",
                "default": [],
                "items": {
                  "enum": [
                    "ArgoCD",
                    "GitLab-CI",
                    "GitHub-Actions",
                    "Helm",
                    "Jenkins",
                    "Kustomize",
                    "OpenShift-Templates",
                    "Tekton",
                    "Terraform",
                    "Terragrunt",
                    "Other"
                  ]
                }
              }
            },
            "required": [
              "data_storage_platforms_custom"
            ]
          },
          "else": {
            "properties": {
              "ci_cd_tools": {
                "uniqueItems": true,
                "title": "Continuous Integration and Delivery Tools",
                "description": "This key contains the CI/CD tools used for the product. ex: GitHub Actions, ArgoCD, Helm, Kustomize",
                "type": "array",
                "default": [],
                "items": {
                  "enum": [
                    "ArgoCD",
                    "GitLab-CI",
                    "GitHub-Actions",
                    "Helm",
                    "Jenkins",
                    "Kustomize",
                    "OpenShift-Templates",
                    "Tekton",
                    "Terraform",
                    "Terragrunt",
                    "Other"
                  ]
                }
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "ci_cd_tools": {
                "contains": {
                  "enum": [
                    "Other"
                  ]
                }
              }
            }
          },
          "then": {
            "properties": {
              "ci_cd_tools_custom": {
                "title": "Continuous Integration and Delivery Tools - Custom",
                "description": "This key contains the CI/CD tools used for the product. ex: GitHub Actions, ArgoCD, Helm, Kustomize,  which is not available as a pick list in the Continuous Integration and Delivery Tools. Comma separated string with free text",
                "type": "string"
              },
              "spatial_mapping_technologies": {
                "uniqueItems": true,
                "title": "Spatial Mapping Technologies",
                "description": "This key contains the mapping technologies used in the stack(Leaflet, Geoserver, Mapbox, Openlayers, ArcGIS, Google Maps, Bing Maps, OpenStreetMap, MapLibre)",
                "type": "array",
                "default": [],
                "items": {
                  "enum": [
                    "Leaflet",
                    "Geoserver",
                    "Mapbox",
                    "Openlayers",
                    "ArcGIS",
                    "Google Maps",
                    "Bing Maps",
                    "OpenStreetMap",
                    "MapLibre",
                    "Other"
                  ]
                }
              }
            },
            "required": [
              "ci_cd_tools_custom"
            ]
          },
          "else": {
            "properties": {
              "spatial_mapping_technologies": {
                "uniqueItems": true,
                "title": "Spatial Mapping Technologies",
                "description": "This key contains the mapping technologies used in the stack(Leaflet, Geoserver, Mapbox, Openlayers, ArcGIS, Google Maps, Bing Maps, OpenStreetMap, MapLibre)",
                "type": "array",
                "default": [],
                "items": {
                  "enum": [
                    "Leaflet",
                    "Geoserver",
                    "Mapbox",
                    "Openlayers",
                    "ArcGIS",
                    "Google Maps",
                    "Bing Maps",
                    "OpenStreetMap",
                    "MapLibre",
                    "Other"
                  ]
                }
              }
            }
          }
        },
        {
          "if": {
            "properties": {
              "spatial_mapping_technologies": {
                "contains": {
                  "enum": [
                    "Other"
                  ]
                }
              }
            }
          },
          "then": {
            "properties": {
              "spatial_mapping_technologies_custom": {
                "title": "Spatial Mapping Technologies - Custom",
                "description": "This key contains the mapping technologies used in the stack(Leaflet, Geoserver, Mapbox, Openlayers, ArcGIS, Google Maps, Bing Maps, OpenStreetMap, MapLibre),  which is not available as a pick list in the Spatial Mapping Technologies. Comma separated string with free text",
                "type": "string"
              }
            },
            "required": [
              "spatial_mapping_technologies_custom"
            ]
          },
          "else": {}
        }
      ]
      
    },
    "external_dependencies": {
      "type": "object",
      "properties": {
        "identity_authorization": {
          "uniqueItems": true,
          "title": "Identity And Authorization",
          "description": "This key contains the Identity Integrations and authorization components used in the stack",
          "type": "array",
          "items": {
            "enum": [
              "IDIR",
              "BceId",
              "Business-BceId",
              "BC-Services-Card",
              "Azure-AD-IDIR",
              "Custom-Keycloak",
              "BCGov-SSO-Keycloak",
              "AWS-Cognito"
            ]
          }
        },
        "common_components": {
          "uniqueItems": true,
          "title": "Common Components",
          "description": "This key contains the common components used in the stack, link: https://digital.gov.bc.ca/common-components",
          "type": "array",
          "items": {
            "enum": [
              "Address-Complete",
              "BC-Address-Geocoder",
              "BC-Express-Pay",
              "BC-Route-Planner",
              "CMS-Forms",
              "Common-Document-Generation-Service",
              "Common-Hosted-Form-Service",
              "Common-Object-Management-Service",
              "Design-System",
              "Digital-Mailroom-and-Document-Scanning",
              "Microsoft-Active-Directory-Services",
              "PayBC",
              "Secure-File-Transfer-Service",
              "Simple-Map-Kit"
            ]
          }
        },
        "notification_standard": {
          "uniqueItems": true,
          "title": "Notification Standard",
          "description": "This key contains the notification systems used in the stack",
          "type": "array",
          "items": {
            "enum": [
              "GCNotify",
              "Common-Hosted-Email-Service",
              "Custom-SMTP",
              "Other"
            ]
          }
        },
        "notification_custom": {
          "title": "Notification Custom",
          "description": "This key contains the notification other which is to be filled if the notification does not have the option to fill in the above key",
          "type": "string",
          "maxLength": 150
        },
        "other_dependencies": {
          "title": "Other Dependencies",
          "description": "This key contains the external dependencies which are not outlined in above keys",
          "type": "string"
        }
      }
    },
    "data_management_roles": {
      "type": "object",
      "required": [
        "product_owner",
        "data_custodian"
      ],
      "properties": {
        "product_owner": {
          "title": "Product Owner",
          "description": "This key contains the full name of one of the product owner, It must be a real person",
          "type": "string",
          "minLength": 1
        },
        "data_custodian": {
          "title": "Data Custodian",
          "description": "This key contains the Contact Name who is data custodian for the application/suite of applications.link https://bcgov.github.io/data-publication/pages/dsg_bcdc_roles_responsibilities.html#am-i-a-data-custodian",
          "type": "string",
          "minLength": 1
        },
        "data_steward": {
          "title": "Data Steward",
          "description": "This key contains the Contact Name who is the data steward",
          "type": "string"
        }
      }
    }
  },
  "description": "bcgovpubcode.yml is a metadata standard for repositories containing software developed or acquired by the Public Administration, aimed at making them easily discoverable and thus reusable by other entities. Fields or Sections marked with \"*\" are mandatory",
  "properties": {
    "product_information": {
      "title": "Product Information *",
      "description": "This Section describes the basic information around product and is required to be filled",
      "type": "object",
      "$ref": "#/definitions/product_information"
    },
    "data_management_roles": {
      "title": "Data Management Roles *",
      "description": "This Section describes the information around Data Assets and is required to be filled",
      "type": "object",
      "$ref": "#/definitions/data_management_roles"
    },
    "product_technology_information": {
      "title": "Product Technology Information *",
      "description": "This Section describes the basic information around tech stack used in the product and is required to be filled",
      "type": "object",
      "$ref": "#/definitions/product_technology_info"
    },
    "product_external_dependencies": {
      "title": "Product External Dependencies",
      "description": "This Section describes the information around external dependencies which the product relies upon",
      "type": "object",
      "$ref": "#/definitions/external_dependencies"
    },
    "version": {
      "title": "BCGov Pubcode Version",
      "description": "This key defines which version of the yaml is being filled",
      "type": "number",
      "default": 1,
      "enum": [
        1
      ]
    }
  },
  "required": [
    "product_information",
    "data_management_roles",
    "product_technology_information",
    "version"
  ],
  "title": "JSON schema for bcgovpubcode.yml",
  "type": "object"
}