good-multi-file.yaml

# Copyright 2017 Google Inc.
# 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.

--- !ruby/object:Api::Product
name: MyProduct
versions:
  - !ruby/object:Api::Product::Version
    name: ga
    base_url: http://myproduct.google.com/api
scopes:
  - http://scope-to-my-api/
objects:
  - !ruby/object:Api::Resource
    name: 'ReferencedResource'
    kind: 'myproduct#referencedresource'
    base_url: 'referencedresource'
    description: 'blah blah'
    properties:
      - !ruby/object:Api::Type::String
        name: 'name'
        description: 'an explanation whats this about'
  - !ruby/object:Api::Resource
    name: 'MyResource'
    kind: 'multiproduct#myresource'
    base_url: some/path/to/resources
    description: 'blah blah'
    properties:
      - !ruby/object:Api::Type::String
        name: 'property1'
        description: |
          Some multiline
          description for the property.
  - !ruby/object:Api::Resource
    name: 'AnotherResource'
    kind: 'multiproduct#anotherresource'
    base_url: some/path/to/anotherresources
    description: 'blah blah'
    parameters:
      - !ruby/object:Api::Type::ResourceRef
        resource: 'ReferencedResource'
        name: 'property5'
        imports: 'name'
        description: 'hey, this is property number 5!'
    properties:
      - !ruby/object:Api::Type::String
        name: 'property1'
        description: |
          Some multiline
          description for the property.
      - !ruby/object:Api::Type::String
        name: 'property2'
        description: 'A single line description'
      - !ruby/object:Api::Type::Array
        item_type: Api::Type::String
        name: 'property3'
        description: 'A single line description'
      - !ruby/object:Api::Type::Enum
        name: 'property4'
        description: |
          A long description for a property. Whenever the property description
          is too long it may be formatted appropriately by the provider to look
          good at the final file.
        values:
          - :value1
          - 'value2'
          - 3