maas-schemas

environments Schema

http://maasglobal.com/environments/environments.json

The base environments object with several environment groups and related meta data

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Defined In
Can be instantiated	Yes	Develop	No	Forbidden	Forbidden	environments/environments.json

environments Example

{
  "index": [
    {
      "name": "Core Environments",
      "envs": [
        {
          "id": "production",
          "api": "https://production.example.com/api/",
          "live": true,
          "contact": {
            "name": "Alisha Admin",
            "email": "admin@example.com"
          },
          "description": "Production environment"
        },
        {
          "id": "testing",
          "api": "https://testing.example.com/api/",
          "live": false,
          "contact": {
            "name": "Alisha Admin"
          },
          "description": "Testing environment"
        }
      ]
    },
    {
      "name": "Development Environments",
      "envs": [
        {
          "id": "fantasy-topping",
          "api": "https://fantasy-topping.example.com/api/",
          "live": false,
          "contact": {
            "name": "Dennis Developer"
          },
          "name": "Fantasy Topping",
          "description": "Add support for pizza customization"
        }
      ]
    }
  ]
}

environments Definitions

Property	Type	Group
api	environmentUrl	http://maasglobal.com/environments/environments.json#/definitions/environment
contact	developer	http://maasglobal.com/environments/environments.json#/definitions/environment
description	environmentGroupDescription	http://maasglobal.com/environments/environments.json#/definitions/environmentGroup
email	email	http://maasglobal.com/environments/environments.json#/definitions/developer
envs	environment	http://maasglobal.com/environments/environments.json#/definitions/environmentGroup
id	environmentId	http://maasglobal.com/environments/environments.json#/definitions/environment
live	environmentLive	http://maasglobal.com/environments/environments.json#/definitions/environment
name	environmentGroupName	http://maasglobal.com/environments/environments.json#/definitions/environmentGroup

api

api

• is required
• type: environmentUrl
• defined in this schema

api Type

• environmentUrl – #/definitions/environmentUrl

contact

contact

• is required
• type: developer
• defined in this schema

contact Type

• developer – #/definitions/developer

description

description

• is optional
• type: environmentGroupDescription
• defined in this schema

description Type

• environmentGroupDescription – #/definitions/environmentGroupDescription

email

email

• is optional
• type: email
• defined in this schema

email Type

• email – http://maasglobal.com/core/components/common.json#/definitions/email

envs

envs

• is required
• type: environment
• defined in this schema

envs Type

Array type: environment

All items must be of the type:

• environment – #/definitions/environment

id

id

• is required
• type: environmentId
• defined in this schema

id Type

• environmentId – #/definitions/environmentId

live

live

• is required
• type: environmentLive
• defined in this schema

live Type

• environmentLive – #/definitions/environmentLive

name

name

• is required
• type: environmentGroupName
• defined in this schema

name Type

• environmentGroupName – #/definitions/environmentGroupName

environments Properties

Property	Type	Required	Nullable	Defined by
index	environmentGroup	Required	No	environments (this schema)

index

index

• is required
• type: environmentGroup
• defined in this schema

index Type

Array type: environmentGroup

All items must be of the type:

• environmentGroup – #/definitions/environmentGroup

This site is open source. Improve this page.