#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

tosca_definitions_version: tosca_simple_yaml_1_1

metadata:
  filename: tosca/data.yml
  version: '1.0'
  
imports:
- tosca_index:
    file: _index.yml

data_types:
  tosca.datatypes.Root:
    description: The TOSCA root Data Type all other TOSCA base Data Types derive from

  string:
    derived_from: tosca.datatypes.Root

  integer:
    derived_from: tosca.datatypes.Root

  boolean:
    derived_from: tosca.datatypes.Root

  float:
    derived_from: tosca.datatypes.Root

  range:
    derived_from: tosca.datatypes.Root

  list:
    derived_from: tosca.datatypes.Root

  map:
    derived_from: tosca.datatypes.Root

  timestamp:
    derived_from: tosca.datatypes.Root

  version:
    derived_from: tosca.datatypes.Root

  scalar-unit.size:
    derived_from: tosca.datatypes.Root

  scalar-unit.frequency:
    derived_from: tosca.datatypes.Root

  scalar-unit.time:
    derived_from: tosca.datatypes.Root

  tosca.datatypes.network.NetworkInfo:
    derived_from: tosca.datatypes.Root
    description: The Network type is a complex TOSCA data type used to describe logical network information.
    properties:
      network_name:
        description: The name of the logical network. e.g., "public", "private", "admin". etc.
        type: string
        required: false
      network_id:
        description: The unique ID of for the network generated by the network provider.
        type: string
        required: false
      addresses:
        description: The list of IP addresses assigned from the underlying network.
        type: list
        entry_schema:
          type: string
        required: false

  tosca.datatypes.TimeInterval:
    derived_from: tosca.datatypes.Root
    properties:
      start_time:
        type: timestamp
        required: true
      end_time:
        type: timestamp
        required: true

  tosca.datatypes.network.PortSpec:
    derived_from: tosca.datatypes.Root
    description: The PortSpec type is a complex TOSCA data Type used when describing port specifications for a network connection.
    properties:
      protocol:
        description: The required protocol used on the port.
        type: string
        default: tcp
        constraints:
        - valid_values:
          - udp
          - tcp
          - igmp
      source:
        description: The optional source port.
        type: tosca.datatypes.network.PortDef
        required: false
      source_range:
        description: The optional range for source port.
        type: range
        required: false
        constraints:
        - in_range:
          - 1
          - 65535
      target:
        description: The optional target port.
        type: tosca.datatypes.network.PortDef
        required: false
      target_range:
        description: The optional range for target port.
        type: range
        required: false
        constraints:
        - in_range:
          - 1
          - 65535

  tosca.datatypes.network.PortDef:
    derived_from: integer
    description: The PortDef type is a TOSCA data Type used to define a network port.
    constraints:
    - in_range:
      - 1
      - 65535

  tosca.datatypes.network.PortInfo:
    derived_from: tosca.datatypes.Root
    description: The PortInfo type is a complex TOSCA data type used to describe network port information.
    properties:
      port_name:
        description: The logical network port name.
        type: string
        required: false
      port_id:
        description: The unique ID for the network port generated by the network provider.
        type: string
        required: false
      network_id:
        description: The unique ID for the network.
        type: string
        required: false
      mac_address:
        description: The unique media access control address (MAC address) assigned to the port.
        type: string
        required: false
      addresses:
        description: The list of IP address(es) assigned to the port.
        type: list
        entry_schema:
          type: string
        required: false

  tosca.datatypes.Credential:
    derived_from: tosca.datatypes.Root
    description: The Credential type is a complex TOSCA data Type used when describing authorization credentials used to access network accessible resources.
    properties:
      protocol:
        description: The optional protocol name.
        type: string
        required: false
      token_type:
        description: The required token type.
        type: string
        default: password
      token:
        description: The required token used as a credential for authorization or access to a networked resource.
        type: string
      keys:
        description: The optional list of protocol-specific keys or assertions.
        type: map
        entry_schema:
          type: string
        required: false
      user:
        description: The optional user (name or ID) used for non-token based credentials.
        type: string
        required: false