invalid 'examples' tag fixed

invalid 'examples' tag fixed

Although Atom did not report an error, the examples tag format was not valid. Changed it to a more simple 'example' tag.

#%RAML 1.0 Library

# Name: dd-base-types.raml
#
# Date: 2018-07-14
#
#  This file defines the basic datatypes used in the DD API and DD-OPER API.

types:
  AdditionalQuality:
    type: integer
    description: Provides detailed information on specific Quality numbers.

  Altitude: number

  Aspect:
    description: A matematical derived variant of a specific measurement, forecast, etc.
    type: object
    properties:
      name: string
      unit: string

  AspectSet:
    description: The AspectSet defines a group of related mathematical values for a single measurement, forecast, etc
    type: object
    properties:
      name: AspectSetName
      aspects:
        type: Aspect[]
        minItems: 0

  AspectSetName:
    description:
    type: string
    default: "standard"
    example: "minimum, maximum, standard, ...."

  AspectPointsValue:
    description: Object used for Event.Aspect.Points. Specifies the values in points array in context of Aspect name.
    type: object
    properties:
      name:
        type: string
        description: Name of aspect.
      points: PointsValue[]

  AspectValue:
    description: Object used for Event.Aspect[] results. Specifies the value in context of Aspect name.
    type: object
    properties:
      name:
        type: string
        description: Name of aspect.
      value: number
      quality?: number
      additionalQuality?: number

# BB is not required as object since bbox is only used as query parameter (toch maar laten staan? SH)
  BoundingBox:
    description: The specification of a bounding box using the longitude and latitiude of the most SouthWest point followed by the most NorthEast points (GeoJSON).
    type: Double[]
    minItems: 4
    maxItems: 4
    examples:
      -bbox: [ 4.123456, 52.123456, 10.123456, 55.123456 ]

  Coordinate:
    type: number
    format: double

  Double:
    description: A value of type Double (todo specify #digits/format?).
    type: number
    format: double

  EndTime:
    type: datetime
    example: 2018-01-01T00:00:00Z
    description:  The End date/time of the timeseries, or the End date/time of the interval for an individual value in the series. Uses the UCT (Zulu) notation.
      The endtime is exlusive, hence the requested period ends just before the given time.
      2018-01-01T00:00:00Z - 2018-01-01T00:00:10Z  specifies a 10 minute period starting at midnight and
      ending at 2018-01-01T00:09:59.99999Z

  Event:
    description: In case of scalar time series the event contains time stamp and value, optionally extended with
      an interval specification (startTime/endTime/resultTime), and a quality indication (quality, additionalQuality).
      In case of a timeseries with Aspects or with values on multiple points, the events contains object for the aspects or points.
    type: object
    properties:
      timeStamp?: datetime
      startTime?: StartTime
      endTime?: EndTime
      resultTime?: datetime
      value?:
        description: The 'value', 'quantity' and 'additionalQuality' can be returned at this level (Event object) in case the AspectSet and/or Point nestings would be redundant and introduce unnecesssary levels in the response
        type: number
      quality?:
        description: See value attribute.
        type: number
      additionalQuality?:
        description: See also value attribute.
        type: number
      aspects?:
        type: AspectValue[] | AspectPointsValue []
        description: When Aspects are used the value/quality/unit are given in and object for each aspect or aspect+point.
      points?:
        type: PointsValue[]
        description: When multiple positions are involved the value/quantity/unit are given in context of each position.

  FilterError:
    type: object
    description: Defines the field of an error in the filtering syntax.
    properties:
      errorType: string
      context: string

  Geometry:
    description: A geometry in GeoJSON format. Digital Delta currently only supports the Point and MultiPoint types.
    type: object
    properties:
      type:
        description: The geometry type. Must have the value "Point" or "MultiPoint".
        type: string
        example: "Point"
      coordinates?:
        description: An array of doubles, representing a Longitude, Latitude and optional Altitude.
        type: Position | Positions
        examples:
          -point:  [4.234 , 5.23423]
          -multipoint:  [[4.2, 52.0], [3.2, 52.3,0]]

  Identifier:
    type: string | Uuid
    description: An uuid or a preferably human readable identifier.

  Institution:
    type: object
    properties:
      name:
        type: string
        description: The name of the institution that produced and/or owns the data
      description?:
        type: string
        description: Additional discription of the institution

# IntervalLength is not required as object since it is only used as query parameter (toch maar laten staan? SH)
  IntervalLength:
    default: 10min

  Location:
    description: Generic DD API 2.0 Location object structure that is used by /dd and /dd-oper. Most attributes are optional as the content returned in the response depends on the request.  Location attributes are placed within the properties group of the GeoJSON  object.
    properties:
      type:
        description: Type of GeoJSON object. In the DD-API the only allowed type is "Feature"
        type: string
        enum: ["Feature"]
      geometry:
        description: The coordinate(s) of the Location are placed within the "geometry" section of the GeoJSON object. DD-API uses Point and Multi-Point locations, but is not restricted to these two.
        type: Geometry | nil
      properties?:
        description: The attributes of Location object are placed within the properties group of the GeoJSON object.
        type: object
        properties:
          node?: Node
          url?: string
          locationId?: string
          locationCode?: string
          referenceLevel?:
            description: GeoJSON element. Specifies the reference plane for the altitude coordinates (third). For example "NAP"
            type: string
          crs?:
            description: GeoJSON element. According to GeoJSON the coordinate reference system element is only included when it is not "WGS84" (default).
            type: string
          locationName?: LocationName
          locationNameSpace?:
            type: LocationNameSpace
          displayNameDetail?:
            type: LocationName
            description: Remark, Only used in dd-oper response.
          displayNameGlobal?:
            type: LocationName
            description: Remark, Only used in dd-oper response.
          displayNameSpace?:
            type: LocationNameSpace
            description: Remark, Only used in dd-oper response.
          parentName?:
            type: LocationName
            description: Remark, Only used in dd-oper response.

  LocationName:
    type: string
    example: "Hoek-van-Holland"

  LocationNameSpace:
    type: string
    example: "NL.RWS.WM"

  Node:
    description: Node objects contain the properties of the data node. A node is an operational implementation of the Digital Delta specification.
    type: object
    properties:
      id?:
        type: Identifier
      name:
        type: string
        description: The name of the node.<br/>
      description?:
        type: string
        description: The description of the node.
      baseUrl?:
        type: string
        description: The base URL of the node.

  ObservationType:
    description: Generic DD API 2.0 parameter object. DD-OPER API response returns a subset of the attributes.
    type: object
    properties:
      node?: Node
      url?: Url
      id?: Identifier
      quantityName?:
        description: Composed name of the quantity(.parameterCode) that was measured or computed.
          Remark Only used in dd-oper response.
        type: QuantityName
      parameterCode?:
        description: Parameter code specifying the observationtype. Non-biological observation types follow the Aquo standards.
        type: string
      description?: string
      quantity?: string
      unit?: string
      compartment?:
        description: The compartment in which the measurement/computationt is available. Standardised Aquo compartments.
        type: string
        example:  OW, DL, GW, LW
      aspectSet?:
        description: Optional, currently only provided and used by RWS.
        type: AspectSet

  PageLinks:
    description: The object contains urls and page size information to support back and forward paging
    type: object
    properties:
      totalObjectCount?:
        description: The actual number of objects available. When paging is used the response contains a subset of the total obejcts available up to the max page size.
        type: integer
      maxPageSize?:
        description: Maximum number of objects in the response. Defined by the Provider of the response.
        type: PageSize
      minPageSize?:
          description: Minimum number of objects in the response. Defined by the Provider of the response.
          type: PageSize
          minimum: 1
      self?: Url | nil
      first?: Url | nil
      prev: Url | nil
      next: Url | nil
      last?: Url | nil

  PageNumber:
    description: Page number in case the response is seprated in different pages.
    type: integer
    minimum: 1
    example: 1

  PageSize:
    description: Number of result objects per a single response page. Used for minimum, maximum and/or actual.
    type: integer
    minimum: 1
    maximum: 10000
    example: 10

  PointsValue:
    type: object
    properties:
      coordinates: Position
      value?:
        description: The 'value', 'quantity' and 'additionalQuality' can be returned at this level (Event object) in case the AspectSet and/or Point nestings would be redundant and introduce unnecesssary levels in the response
        type: number
      quality?:
        description: See also value attribute.
        type: number
      additionalQuality?:
        description: See also value attribute.
        type: number

  Position:
    description: |
      A location specified in an array with longitude, lattitude and optional altitude.
    type: Double[]
    minItems: 2
    maxItems: 3
    example: [4.234 , 5.23423]

  Positions:
    description: An array of Positions to specify a MultiPpoint location.
    type: Position[]
    minItems: 0
    examples:
      -multipoint: [[4.2, 52.0], [3.2, 52.3,0]]

  Problem:
    description:  Error response in line with RFC7807. Although both optional the minimum information that should be given are the title and status.
    type: object
    properties:
      type?: Url
      title?: string
      status?:
        type: integer
        description: The HTTP errrocode number.
      detail?: string
      instance?: string | nil
    # Additional fields, RFC7807 extension
      errors?:
        description: Error details.
        type: FilterError[]
      typeinfo?:
        description: Link to information on the type of error.  ??? Why not use 'type'. is link according RFC7807
        type: string | nil

  ProcessName:
    type: string
    description: The name of the mechanism to collect/derive the timeseries value.
      When accessing RWS' DD-API, providing a processName as query parameter is required. The process names are pre-defined (see examples).
      Extending the processname with a suffix, referencing a more detailed mechanism like a specific calculation model, is not allowed.
      Other implementions dot need to implement this query-parameter.
    example: measurement, forecast, astronomical, advise

  Provider:
    type: object
    description: Information regarding the system that is responible for the response.
      Provides support contact information in case there are issues with response format or content.
    properties:
      name?: string
      supportUrl?: string
      apiVersion?: string
      responseType?: string
      responseTimestamp?:
        type: Timestamp
        description: Timestamp when this response was created.

  Quality:
    type: integer

  QuantityName:
    type: string
    description: A name referencing a category of timeseries. The quantity names are predefined.
      For example 'WaterLevel', 'WaterTemperature', 'WaveHeight'.
    example: WaterLevel

  Source:
    description: Describes the type of data in the time series, and the owner of the data.
    type: object
    properties:
      process: ProcessName
      name?:
        type: SourceName
        description: A name describing the source, e.g. a model name.
      description?:
        type: string
        description: Additional description of the data source (might contain a URL to a site with information on the model).
      realizationCount?:
        type: integer
        description: if present, and larger then 1, the results are part of an ensemble run
      institution: Institution

  SourceName:
    type: string
    description: A name describing the source, e.g. a model name
    example: rws_prediction

  StartTime:
    type: datetime
    example: 2016-01-01T12:45:00Z
    description:  Start date/time of the timeseries, or the Start date/time of the interval for an individual value in the series. Uses the UCT (Zulu) notation.

  Timeseries:
    description: Generic DD API 2.0 timeseries object.DD API 'OPER' response returns a subset of the attributes.
    type: object
    properties:
      node?: Node
      url?: string
      id?: Identifier
      source: Source
      location: Location
      observationType: ObservationType
      startTime: datetime
      endTime: datetime
      analysisTime?: datetime
      realization?: number
      events?:
        type: Event[]
        description: If no startTime and no endTime are provided in the /timeseries-query, only meta-data is provided,
          so the events are not present.

  Timestamp:
    type: string
    description: Date and time in format "yyyy-mmm-ddThh:mm:ss.ffffffZ"  (UTC Zulu with minimal 3 digits of fractional seconds)
    example: "2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z"
    minLength: 24

  Url:
    type: string
    description: Correctly formatted url reference.

  Uuid:
    type: string
    pattern: "[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}"
    description: Unique identifier for the datasource. Version 4.
    example: 978fdf5c-95c8-43a5-82ff-d27d9e6d685f

# response types
#
#  The repsonse layouts are of Location object are similar to DD API 1.9 definition except that not all atttributes that are returned,
#  and DD-strict has additional location properties that are not par of the DD API 1.9 specification.

#  LocationListResponse:
#    description: Contains zero or more responses to a Node list request.
#    type: object
#    properties:
#      provider:
#        type: Node
#        description: Reference to the responsible provider for the response.
#     node: Node
#      results:
#        type: Location[]
#        description: List of Location objects
#      count?:
#        description: Number of records satisfying the query parameters.
#        type: integer
#        example: 1123

#  ProblemResponse:
#    description:
#    type: object
#    properties:
#      provider:
#        type: Provider
#      problem:
#        type: Problem

#%RAML 1.0 Library

# Name: dd-base-types.raml
#
# Date: 2018-07-10
#
#  This file defines the basic datatypes used in the DD API and DD-OPER API.

types:
  AdditionalQuality:
    type: integer
    description: Provides detailed information on specific Quality numbers.

  Altitude: number

  Aspect:
    description: A matematical derived variant of a specific measurement, forecast, etc.
    type: object
    properties:
      name: string
      unit: string

  AspectSet:
    description: The AspectSet defines a group of related mathematical values for a single measurement, forecast, etc
    type: object
    properties:
      name: AspectSetName
      aspects:
        type: Aspect[]
        minItems: 0

  AspectSetName:
    description:
    type: string
    default: "standard"
    example: "minimum, maximum, standard, ...."

  AspectPointsValue:
    description: Object used for Event.Aspect.Points. Specifies the values in points array in context of Aspect name.
    type: object
    properties:
      name:
        type: string
        description: Name of aspect.
      points: PointsValue[]

  AspectValue:
    description: Object used for Event.Aspect[] results. Specifies the value in context of Aspect name.
    type: object
    properties:
      name:
        type: string
        description: Name of aspect.
      value: number
      quality?: number
      additionalQuality?: number

# BB is not required as object since bbox is only used as query parameter (toch maar laten staan? SH)
  BoundingBox:
    description: The specification of a bounding box using the longitude and latitiude of the most SouthWest point followed by the most NorthEast points (GeoJSON).
    type: Double[]
    minItems: 4
    maxItems: 4
    examples:
      -bbox: [ 4.123456, 52.123456, 10.123456, 55.123456 ]

  Coordinate:
    type: number
    format: double

  Double:
    description: A value of type Double (todo specify #digits/format?).
    type: number
    format: double

  EndTime:
    type: datetime
    example: 2018-01-01T00:00:00Z
    description:  The End date/time of the timeseries, or the End date/time of the interval for an individual value in the series. Uses the UCT (Zulu) notation.
      The endtime is exlusive, hence the requested period ends just before the given time.
      2018-01-01T00:00:00Z - 2018-01-01T00:00:10Z  specifies a 10 minute period starting at midnight and
      ending at 2018-01-01T00:09:59.99999Z

  Event:
    description: In case of scalar time series the event contains time stamp and value, optionally extended with
      an interval specification (startTime/endTime/resultTime), and a quality indication (quality, additionalQuality).
      In case of a timeseries with Aspects or with values on multiple points, the events contains object for the aspects or points.
    type: object
    properties:
      timeStamp?: datetime
      startTime?: StartTime
      endTime?: EndTime
      resultTime?: datetime
      value?:
        description: The 'value', 'quantity' and 'additionalQuality' can be returned at this level (Event object) in case the AspectSet and/or Point nestings would be redundant and introduce unnecesssary levels in the response
        type: number
      quality?:
        description: See value attribute.
        type: number
      additionalQuality?:
        description: See also value attribute.
        type: number
      aspects?:
        type: AspectValue[] | AspectPointsValue []
        description: When Aspects are used the value/quality/unit are given in and object for each aspect or aspect+point.
      points?:
        type: PointsValue[]
        description: When multiple positions are involved the value/quantity/unit are given in context of each position.

  FilterError:
    type: object
    description: Defines the field of an error in the filtering syntax.
    properties:
      errorType: string
      context: string

  Geometry:
    description: A geometry in GeoJSON format. Digital Delta currently only supports the Point and MultiPoint types.
    type: object
    properties:
      type:
        description: The geometry type. Must have the value "Point" or "MultiPoint".
        type: string
        example: "Point"
      coordinates?:
        description: An array of doubles, representing a Longitude, Latitude and optional Altitude.
        type: Position | Positions
        examples:
          -point:  [4.234 , 5.23423]
          -multipoint:  [[4.2, 52.0], [3.2, 52.3,0]]

  Identifier:
    type: string | Uuid
    description: An uuid or a preferably human readable identifier.

  Institution:
    type: object
    properties:
      name:
        type: string
        description: The name of the institution that produced and/or owns the data
      description?:
        type: string
        description: Additional discription of the institution

# IntervalLength is not required as object since it is only used as query parameter (toch maar laten staan? SH)
  IntervalLength:
    default: 10min

  Location:
    description: Generic DD API 2.0 Location object structure that is used by /dd and /dd-oper. Most attributes are optional as the content returned in the response depends on the request.  Location attributes are placed within the properties group of the GeoJSON  object.
    properties:
      type:
        description: Type of GeoJSON object. In the DD-API the only allowed type is "Feature"
        type: string
        enum: ["Feature"]
      geometry:
        description: The coordinate(s) of the Location are placed within the "geometry" section of the GeoJSON object. DD-API uses Point and Multi-Point locations, but is not restricted to these two.
        type: Geometry | nil
      properties?:
        description: The attributes of Location object are placed within the properties group of the GeoJSON object.
        type: object
        properties:
          node?: Node
          url?: string
          locationId?: string
          locationCode?: string
          referenceLevel?:
            description: GeoJSON element. Specifies the reference plane for the altitude coordinates (third). For example "NAP"
            type: string
          crs?:
            description: GeoJSON element. According to GeoJSON the coordinate reference system element is only included when it is not "WGS84" (default).
            type: string
          locationName?: LocationName
          locationNameSpace?:
            type: LocationNameSpace
          displayNameDetail?:
            type: LocationName
            description: Remark, Only used in dd-oper response.
          displayNameGlobal?:
            type: LocationName
            description: Remark, Only used in dd-oper response.
          displayNameSpace?:
            type: LocationNameSpace
            description: Remark, Only used in dd-oper response.
          parentName?:
            type: LocationName
            description: Remark, Only used in dd-oper response.

  LocationName:
    type: string
    example: "Hoek-van-Holland"

  LocationNameSpace:
    type: string
    example: "NL.RWS.WM"

  Node:
    description: Node objects contain the properties of the data node. A node is an operational implementation of the Digital Delta specification.
    type: object
    properties:
      id?:
        type: Identifier
      name:
        type: string
        description: The name of the node.<br/>
      description?:
        type: string
        description: The description of the node.
      baseUrl?:
        type: string
        description: The base URL of the node.

  ObservationType:
    description: Generic DD API 2.0 parameter object. DD-OPER API response returns a subset of the attributes.
    type: object
    properties:
      node?: Node
      url?: Url
      id?: Identifier
      quantityName?:
        description: Composed name of the quantity(.parameterCode) that was measured or computed.
          Remark Only used in dd-oper response.
        type: QuantityName
      parameterCode?:
        description: Parameter code specifying the observationtype. Non-biological observation types follow the Aquo standards.
        type: string
      description?: string
      quantity?: string
      unit?: string
      compartment?:
        description: The compartment in which the measurement/computationt is available. Standardised Aquo compartments.
        type: string
        examples: [ "OW", "DL", "GW", "LW" ]
      aspectSet?:
        description: Optional, currently only provided and used by RWS.
        type: AspectSet

  PageLinks:
    description: The object contains urls and page size information to support back and forward paging
    type: object
    properties:
      totalObjectCount?:
        description: The actual number of objects available. When paging is used the response contains a subset of the total obejcts available up to the max page size.
        type: integer
      maxPageSize?:
        description: Maximum number of objects in the response. Defined by the Provider of the response.
        type: PageSize
      minPageSize?:
          description: Minimum number of objects in the response. Defined by the Provider of the response.
          type: PageSize
          minimum: 1
      self?: Url | nil
      first?: Url | nil
      prev: Url | nil
      next: Url | nil
      last?: Url | nil

  PageNumber:
    description: Page number in case the response is seprated in different pages.
    type: integer
    minimum: 1
    example: 1

  PageSize:
    description: Number of result objects per a single response page. Used for minimum, maximum and/or actual.
    type: integer
    minimum: 1
    maximum: 10000
    example: 10

  PointsValue:
    type: object
    properties:
      coordinates: Position
      value?:
        description: The 'value', 'quantity' and 'additionalQuality' can be returned at this level (Event object) in case the AspectSet and/or Point nestings would be redundant and introduce unnecesssary levels in the response
        type: number
      quality?:
        description: See also value attribute.
        type: number
      additionalQuality?:
        description: See also value attribute.
        type: number

  Position:
    description: |
      A location specified in an array with longitude, lattitude and optional altitude.
    type: Double[]
    minItems: 2
    maxItems: 3
    example: [4.234 , 5.23423]

  Positions:
    description: An array of Positions to specify a MultiPpoint location.
    type: Position[]
    minItems: 0
    examples:
      -multipoint: [[4.2, 52.0], [3.2, 52.3,0]]

  Problem:
    description:  Error response in line with RFC7807. Although both optional the minimum information that should be given are the title and status.
    type: object
    properties:
      type?: Url
      title?: string
      status?:
        type: integer
        description: The HTTP errrocode number.
      detail?: string
      instance?: string | nil
    # Additional fields, RFC7807 extension
      errors?:
        description: Error details.
        type: FilterError[]
      typeinfo?:
        description: Link to information on the type of error.  ??? Why not use 'type'. is link according RFC7807
        type: string | nil

  ProcessName:
    type: string
    description: The name of the mechanism to collect/derive the timeseries value.
      When accessing RWS' DD-API, providing a processName as query parameter is required. The process names are pre-defined (see examples).
      Extending the processname with a suffix, referencing a more detailed mechanism like a specific calculation model, is not allowed.
      Other implementions dot need to implement this query-parameter.
    example: measurement, forecast, astronomical, advise

  Provider:
    type: object
    description: Information regarding the system that is responible for the response.
      Provides support contact information in case there are issues with response format or content.
    properties:
      name?: string
      supportUrl?: string
      apiVersion?: string
      responseType?: string
      responseTimestamp?:
        type: Timestamp
        description: Timestamp when this response was created.

  Quality:
    type: integer

  QuantityName:
    type: string
    description: A name referencing a category of timeseries. The quantity names are predefined.
      For example 'WaterLevel', 'WaterTemperature', 'WaveHeight'.
    example: WaterLevel

  Source:
    description: Describes the type of data in the time series, and the owner of the data.
    type: object
    properties:
      process: ProcessName
      name?:
        type: SourceName
        description: A name describing the source, e.g. a model name.
      description?:
        type: string
        description: Additional description of the data source (might contain a URL to a site with information on the model).
      realizationCount?:
        type: integer
        description: if present, and larger then 1, the results are part of an ensemble run
      institution: Institution

  SourceName:
    type: string
    description: A name describing the source, e.g. a model name
    example: rws_prediction

  StartTime:
    type: datetime
    example: 2016-01-01T12:45:00Z
    description:  Start date/time of the timeseries, or the Start date/time of the interval for an individual value in the series. Uses the UCT (Zulu) notation.

  Timeseries:
    description: Generic DD API 2.0 timeseries object.DD API 'OPER' response returns a subset of the attributes.
    type: object
    properties:
      node?: Node
      url?: string
      id?: Identifier
      source: Source
      location: Location
      observationType: ObservationType
      startTime: datetime
      endTime: datetime
      analysisTime?: datetime
      realization?: number
      events?:
        type: Event[]
        description: If no startTime and no endTime are provided in the /timeseries-query, only meta-data is provided,
          so the events are not present.

  Timestamp:
    type: string
    description: Date and time in format "yyyy-mmm-ddThh:mm:ss.ffffffZ"  (UTC Zulu with minimal 3 digits of fractional seconds)
    example: "2018-07-05T15:11:36.123Z, 2018-07-05T15:11:36.123456Z, 2018-07-05T15:11:36.000Z"
    minLength: 24

  Url:
    type: string
    description: Correctly formatted url reference.

  Uuid:
    type: string
    pattern: "[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}"
    description: Unique identifier for the datasource. Version 4.
    example: 978fdf5c-95c8-43a5-82ff-d27d9e6d685f

# response types
#
#  The repsonse layouts are of Location object are similar to DD API 1.9 definition except that not all atttributes that are returned,
#  and DD-strict has additional location properties that are not par of the DD API 1.9 specification.

#  LocationListResponse:
#    description: Contains zero or more responses to a Node list request.
#    type: object
#    properties:
#      provider:
#        type: Node
#        description: Reference to the responsible provider for the response.
#     node: Node
#      results:
#        type: Location[]
#        description: List of Location objects
#      count?:
#        description: Number of records satisfying the query parameters.
#        type: integer
#        example: 1123

#  ProblemResponse:
#    description:
#    type: object
#    properties:
#      provider:
#        type: Provider
#      problem:
#        type: Problem


Add docs for pickupPointType

Add docs for pickupPointType

This was added to master after we branched out for the revamp.

#%RAML 0.8
---
title: Pickup Point API
baseUri: https://api.bring.com/pickuppoint/api/pickuppoint

documentation:
- title: Introduction
  content: |
      The Pickup point API provides a list of locations for package pickup. Based on a specified postal code or a geographical location, the 10 nearest pickup points are returned. Response is available as either XML or JSON.

      A pickup point is defined as any location delivering shipments on behalf of Bring and Posten, such as post offices, selected grocery stores, lockers, etc.

      ### Filtering results

      In addition to postal code or location, one or more optional parameters can be added to the request, adding additional restrictions to the pickup points being returned. One such parameter is `searchForText=<texts>`, resulting in a response where all pickup points have at least a partial match with the search string given in `<texts>`. This can be the name of the pickup point, its address, city, county, municipality or location. Go to the reference table or see additional examples for more information.

      ### Rate limiting

      The Pickup point API has a rate limit, primarily considered on a per-user basis. Currently it limits API users to no more than 60 requests within a minute from a single IP address.

      Once you go over the rate limit, you will receive a response with an HTTP response code of 429 (Too Many Requests). The body of the response will consist of the following fields:

      - `code`: `429`
      - `error_message`: `The maximum number of requests per minute has been exceeded.`

      As an additional note, While accessing the Pickup point API together with Shipping Guide API, the product list should be displayed even in the case that the request has been rate limited by the Pickup point API.

      #### High-volume users

      If you're a high-volume user of the Pickup Point API, please [contact Customer Service](http://developer.bring.com/support/) to discuss your options.

      When contacting Bring support include a description of how you are using the Pickup Point API, also an estimate of current request volumes.

/{countryCode}/postalCode/{postalCode}{mediaTypeExtension}:
  displayName: Pickup points for postal code
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", "DK", "SE", "FI" ]
    postalCode:
      displayName: Postal code
      type: string
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json, .xml to get application/xml or .html to get HTML.
  get:
    description: List pickup points for postal code
    queryParameters:
      searchForText:
        displayName: Text filter
        type: string
      openingHoursSearchType:
        displayName: Filter using opening hours
        enum: [ ALL_WEEKDAYS, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]
      openOnOrBefore:
        description: Format `HH:mm`. Return only pickup points that are open on or before the specified time.
        type: string
      openOnOrAfter:
        description: Format `HH:mm`. Return only pickup points that are open on or after the specified time.
        type: string
      pickupPointType:
        displayName: Pickup-point type
        description: Currently available for Swedish pickup point request only.
        enum: [ manned, locker ]
      numberOfResponses:
        description: Return the specified number of pickup points instead of the default.
        type: integer
        default: 10
      street:
        description: Searches for the nearest pickup points to the given street.
        type: string
      streetNumber:
        description: Searches for the nearest pickup points to the given street number.
        type: string
      callback:
        description: JSONP callback function name.
        type: string
    responses:
      200:
        displayName: Example response for NO/postalCode/1407
        body:
          application/json:
            example: !include examples/by_postal_code.json
          application/xml:
            example: !include examples/by_postal_code.xml
      250:
        displayName: Using postal code and street address
        description: |
          Sometimes (especially in Denmark) it's a good idea to also specify the address when searching for pickup points, to get more accurate results.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/DK/postalCode/2000.json?street=Smallegade&streetNumber=3), we look for pickup points in Smallegade 3, 2000 Frederiksberg.
        body:
          application/json:
            example: !include examples/filter_address.json
          application/xml:
            example: !include examples/filter_address.xml
      251:
        displayName: Find pickup points containing a specific string
        description: |
          If you want to return only the pickup points matching a specific string, you may use the `searchForText` query param. The given text can be the name of the pickup point, its address, city, county, municipality or location. Partial matches are also allowed.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/NO/postalCode/1407.json?searchForText=KIWI), we look for pickup points near NO/1407 cotaining "Kiwi".
        body:
          application/json:
            example: !include examples/filter_search.json
          application/xml:
            example: !include examples/filter_search.xml
      252:
        displayName: Find pickup points open on specific days
        description: |
          If you want to return only the pickup points open on specified days, you may use the `openingHoursSearchType=<day>` query param. `<day>` be:

          - `ALL_WEEKDAYS` (default)
          - `MONDAY`
          - `TUESDAY`
          - `WEDNESDAY`
          - `THURSDAY`
          - `FRIDAY`
          - `SATURDAY`
          - `SUNDAY`

          If you want you can also add `openOnOrBefore` and / or `openOnOrAfter`, to limit the search even more.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/NO/postalCode/1407.json?openingHoursSearchType=SUNDAY), we look for pickup points near NO/1407 that are open Sundays.
        body:
          application/json:
            example: !include examples/filter_days.json
          application/xml:
            example: !include examples/filter_days.xml
      253:
        displayName: Find pickup points open at specific hours
        description: |
          If you want to return only the pickup points open on specific hours, you may use the `openOnOrBefore=<time>` and/or `openOnOrAfter=<time>` query params.

          The format of `<time>` is `hhmm`.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/NO/postalCode/1407.json?openOnOrBefore=0800), we look for pickup points near NO/1407 open on or before 08:00.
        body:
          application/json:
            example: !include examples/filter_hours.json
          application/xml:
            example: !include examples/filter_hours.xml

/{countryCode}/location/{latitude},{longitude}{mediaTypeExtension}:
  displayName: Pickup points for location
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", "DK", "SE", "FI" ]
    latitude:
      displayName: Latitude
      description: Geographic coordinate specifying the north-south position.
      type: string
    longitude:
      displayName: Longitude
      description: Geographic coordinate specifying the east-west position.
      type: string
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json or .xml to get application/xml.
  get:
    description: List pickup points closest to location
    queryParameters:
      searchForText:
        displayName: Text filter
        type: string
      openingHoursSearchType:
        displayName: Filter using opening hours
        enum: [ ALL_WEEKDAYS, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]
      openOnOrBefore:
        description: Format `HH:mm`. Return only pickup points that are open on or before the specified time.
        type: string
      openOnOrAfter:
        description: Format `HH:mm`. Return only pickup points that are open on or after the specified time.
        type: string
      pickupPointType:
        displayName: Pickup-point type
        description: Currently available for Swedish pickup point request only.
        enum: [ manned, locker ]
      numberOfResponses:
        description: Return the specified number of pickup points instead of the default.
        type: integer
        default: 10
      street:
        description: Searches for the nearest pickup points to the given street.
        type: string
      streetNumber:
        description: Searches for the nearest pickup points to the given street number.
        type: string
      callback:
        description: JSONP callback function name.
        type: string
    responses:
      200:
        displayName: Example response for location/60.395226,5.321725
        body:
          application/json:
            example: !include examples/by_coordinates.json
          application/xml:
            example: !include examples/by_coordinates.xml

/{countryCode}/id/{id}{mediaTypeExtension}:
  displayName: A specific pickup point
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", DK, SE, FI ]
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json or .xml to get application/xml.
  get:
    description: Look up a specific pickup point
    queryParameters:
      callback:
        displayName: JSONP support
        description: Callback function name.
        type: string
    responses:
      200:
        displayName: Example response for id/121110
        body:
          application/json:
            example: !include examples/by_id.json
          application/xml:
            example: !include examples/by_id.xml

/{countryCode}/all{mediaTypeExtension}:
  displayName: All pickup points in a country
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", DK, SE, FI ]
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json or .xml to get application/xml.
  get:
    description: All pickup points in a country
    queryParameters:
      callback:
        displayName: JSONP support
        description: Callback function name.
        type: string

#%RAML 0.8
---
title: Pickup Point API
baseUri: https://api.bring.com/pickuppoint/api/pickuppoint

documentation:
- title: Introduction
  content: |
      The Pickup point API provides a list of locations for package pickup. Based on a specified postal code or a geographical location, the 10 nearest pickup points are returned. Response is available as either XML or JSON.

      A pickup point is defined as any location delivering shipments on behalf of Bring and Posten, such as post offices, selected grocery stores, lockers, etc.

      ### Filtering results

      In addition to postal code or location, one or more optional parameters can be added to the request, adding additional restrictions to the pickup points being returned. One such parameter is `searchForText=<texts>`, resulting in a response where all pickup points have at least a partial match with the search string given in `<texts>`. This can be the name of the pickup point, its address, city, county, municipality or location. Go to the reference table or see additional examples for more information.

      ### Rate limiting

      The Pickup point API has a rate limit, primarily considered on a per-user basis. Currently it limits API users to no more than 60 requests within a minute from a single IP address.

      Once you go over the rate limit, you will receive a response with an HTTP response code of 429 (Too Many Requests). The body of the response will consist of the following fields:

      - `code`: `429`
      - `error_message`: `The maximum number of requests per minute has been exceeded.`

      As an additional note, While accessing the Pickup point API together with Shipping Guide API, the product list should be displayed even in the case that the request has been rate limited by the Pickup point API.

      #### High-volume users

      If you're a high-volume user of the Pickup Point API, please [contact Customer Service](http://developer.bring.com/support/) to discuss your options.

      When contacting Bring support include a description of how you are using the Pickup Point API, also an estimate of current request volumes.

/{countryCode}/postalCode/{postalCode}{mediaTypeExtension}:
  displayName: Pickup points for postal code
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", "DK", "SE", "FI" ]
    postalCode:
      displayName: Postal code
      type: string
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json, .xml to get application/xml or .html to get HTML.
  get:
    description: List pickup points for postal code
    queryParameters:
      searchForText:
        displayName: Text filter
        type: string
      openingHoursSearchType:
        displayName: Filter using opening hours
        enum: [ ALL_WEEKDAYS, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]
      openOnOrBefore:
        description: Format `HH:mm`. Return only pickup points that are open on or before the specified time.
        type: string
      openOnOrAfter:
        description: Format `HH:mm`. Return only pickup points that are open on or after the specified time.
        type: string
      numberOfResponses:
        description: Return the specified number of pickup points instead of the default.
        type: integer
        default: 10
      street:
        description: Searches for the nearest pickup points to the given street.
        type: string
      streetNumber:
        description: Searches for the nearest pickup points to the given street number.
        type: string
      callback:
        description: JSONP callback function name.
        type: string
    responses:
      200:
        displayName: Example response for NO/postalCode/1407
        body:
          application/json:
            example: !include examples/by_postal_code.json
          application/xml:
            example: !include examples/by_postal_code.xml
      250:
        displayName: Using postal code and street address
        description: |
          Sometimes (especially in Denmark) it's a good idea to also specify the address when searching for pickup points, to get more accurate results.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/DK/postalCode/2000.json?street=Smallegade&streetNumber=3), we look for pickup points in Smallegade 3, 2000 Frederiksberg.
        body:
          application/json:
            example: !include examples/filter_address.json
          application/xml:
            example: !include examples/filter_address.xml
      251:
        displayName: Find pickup points containing a specific string
        description: |
          If you want to return only the pickup points matching a specific string, you may use the `searchForText` query param. The given text can be the name of the pickup point, its address, city, county, municipality or location. Partial matches are also allowed.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/NO/postalCode/1407.json?searchForText=KIWI), we look for pickup points near NO/1407 cotaining "Kiwi".
        body:
          application/json:
            example: !include examples/filter_search.json
          application/xml:
            example: !include examples/filter_search.xml
      252:
        displayName: Find pickup points open on specific days
        description: |
          If you want to return only the pickup points open on specified days, you may use the `openingHoursSearchType=<day>` query param. `<day>` be:

          - `ALL_WEEKDAYS` (default)
          - `MONDAY`
          - `TUESDAY`
          - `WEDNESDAY`
          - `THURSDAY`
          - `FRIDAY`
          - `SATURDAY`
          - `SUNDAY`

          If you want you can also add `openOnOrBefore` and / or `openOnOrAfter`, to limit the search even more.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/NO/postalCode/1407.json?openingHoursSearchType=SUNDAY), we look for pickup points near NO/1407 that are open Sundays.
        body:
          application/json:
            example: !include examples/filter_days.json
          application/xml:
            example: !include examples/filter_days.xml
      253:
        displayName: Find pickup points open at specific hours
        description: |
          If you want to return only the pickup points open on specific hours, you may use the `openOnOrBefore=<time>` and/or `openOnOrAfter=<time>` query params.

          The format of `<time>` is `hhmm`.

          In [this example](https://api.bring.com/pickuppoint/api/pickuppoint/NO/postalCode/1407.json?openOnOrBefore=0800), we look for pickup points near NO/1407 open on or before 08:00.
        body:
          application/json:
            example: !include examples/filter_hours.json
          application/xml:
            example: !include examples/filter_hours.xml

/{countryCode}/location/{latitude},{longitude}{mediaTypeExtension}:
  displayName: Pickup points for location
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", "DK", "SE", "FI" ]
    latitude:
      displayName: Latitude
      description: Geographic coordinate specifying the north-south position.
      type: string
    longitude:
      displayName: Longitude
      description: Geographic coordinate specifying the east-west position.
      type: string
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json or .xml to get application/xml.
  get:
    description: List pickup points closest to location
    queryParameters:
      searchForText:
        displayName: Text filter
        type: string
      openingHoursSearchType:
        displayName: Filter using opening hours
        enum: [ ALL_WEEKDAYS, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]
      openOnOrBefore:
        description: Format `HH:mm`. Return only pickup points that are open on or before the specified time.
        type: string
      openOnOrAfter:
        description: Format `HH:mm`. Return only pickup points that are open on or after the specified time.
        type: string
      numberOfResponses:
        description: Return the specified number of pickup points instead of the default.
        type: integer
        default: 10
      street:
        description: Searches for the nearest pickup points to the given street.
        type: string
      streetNumber:
        description: Searches for the nearest pickup points to the given street number.
        type: string
      callback:
        description: JSONP callback function name.
        type: string
    responses:
      200:
        displayName: Example response for location/60.395226,5.321725
        body:
          application/json:
            example: !include examples/by_coordinates.json
          application/xml:
            example: !include examples/by_coordinates.xml

/{countryCode}/id/{id}{mediaTypeExtension}:
  displayName: A specific pickup point
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", DK, SE, FI ]
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json or .xml to get application/xml.
  get:
    description: Look up a specific pickup point
    queryParameters:
      callback:
        displayName: JSONP support
        description: Callback function name.
        type: string
    responses:
      200:
        displayName: Example response for id/121110
        body:
          application/json:
            example: !include examples/by_id.json
          application/xml:
            example: !include examples/by_id.xml

/{countryCode}/all{mediaTypeExtension}:
  displayName: All pickup points in a country
  uriParameters:
    countryCode:
      displayName: Country
      enum: [ "NO", DK, SE, FI ]
    mediaTypeExtension:
      enum: [ .json, .xml ]
      description: Use .json to get application/json or .xml to get application/xml.
  get:
    description: All pickup points in a country
    queryParameters:
      callback:
        displayName: JSONP support
        description: Callback function name.
        type: string


Removed old documentation format

Removed old documentation format

#%RAML 1.0
title: MoonGUI
version: v1
baseUri: /rest
protocols:
  - HTTP
description: |
  This API enables the Contact between
  the Backend Server and The Frontend
  GUI
mediaType:
  - application/json
/:
  head:
    responses:
      200:
        description: Indicates that the Connection to the Resources is correct set
  /system/:
    description: For System Relevant Tasks
    get:
      protocols:
        - HTTP
      description: Get all System Relevant Information
      responses:
        200:
          body:
            application/json:
              default: {arch:string,cores:number,hostname:string,lua:{status:boolean,version:string},os:string,user:string}
/moongen/:
  description: |
    The Entry Point for the MoonGen Live handling to create or get the execution
  get:
    description: Returns the number of the running System
    responses:
      200:
        description: Returns the Number of the Running System
        body:
          application/json:
            type: {execution:number}
      404:
        description: The System is not longer running or was not started
  post:
    description: Starts MoonGen with the Specified Options
    responses:
      200:
        description: Returns the Number of the Running System
        body:
          application/json:
            type: {execution:number}
  /{execution}/:
    delete:
      description: Stops the running System
      responses:
        200:
          description: The Ressources was successfully stoped
        404:
          description: The System was not longer running
    /log:
      get:
        description: Returns the Log File and the number of read Lines as well as the seek position
        body:
          application/json:
            default: {line:number,seek:number,log:array}
        responses:
          200:
            description: File exists and is returned
            body:
              application/text:
                default: {lines:number,content:file}
          304:
            description: Nothing Changed
          404:
            description: File did not exist
        queryParameters:
          line:
            type: number
            description: The line number from which we should start
          seek:
            type: number
            description: The position in the file for reading
    get:
      description: Returns the current data
      responses:
        200:
          description: All Data correct
        404:
          description: No Execution working


Added test for inline type.

Added test for inline type.

/:
  get:
    queryParameters:
      firstName:
        description: The firstname of the user.
        type: string
        required: true
      lastName:
        description: The last name of the user.
        type: string
      age:
        description: The age of the user.
        type: integer
      organization[]:
        description: |
          The organization of the user. The [] at the end of the parameter name is a meaningless literal that is maintained in the API.
        type: string[]
    responses:
      200:
        body:
          application/vnd-v1.0+json:
            schema: user
      412:
        description: PreCondition Failed
        body:
          application/vnd-v1.0+json:
            schema: error

/upload:
  post:
    body:
      multipart/form-data:
    responses:
      200:
        body:

/{userid}:
  uriParameters:
    userid:
      description: The user's id.
      type: string
      required: true
  get:
    queryParameters:
      age:
        description: The age of the user.
        type: number
      firstName:
        description: The firstname of the user.
        type: string
      lastName:
        description: The last name of the user.
        type: string
    responses:
      200:
        body:
          application/vnd-v1.0+json:
            schema: user
          application/vnd-v0.1+json:
            schema: animal
  post:
    body:
      application/x-www-form-urlencoded:
        formParameters:
          text:
            description: Text to post as a comment on the user.
            type: string
            required: true
          value:
            description: Value to give to a user.
            type: integer
            required: false
    responses:
      200:
        body:
  delete:
  put:
    body:
      application/vnd-v1.0+json:
        schema: user
      application/vnd-v0.1+json:
        schema: animal
    responses:
      200:
        body:
          application/vnd-v1.0+json:
            schema: link

/{userid}/dogs:
  uriParameters:
    userid:
      description: The user's id.
      type: string
      required: true
  get:
    responses:
      200:
        body:
          application/vnd-v1.0+json:
            schema: |
              {
                "$ref": "http://atomicbits.io/raml10/paged-list.json#",
                "genericTypes": [
                  {
                    "$ref": "http://atomicbits.io/raml10/dog.json"
                  },
                  {
                    "type": "string"
                  }
                ]
              }
  post:
    body:
      application/vnd-v1.0+json:
        schema: |
          {
            "$ref": "http://atomicbits.io/raml10/dog.json"
          }
    responses:
      201:

#  description: todo support for anonymous schema id's for non-object schema's, List[] support in body and result directly
#  description: todo testing primitives as request & response bodies

/activate:
  put:
    body:
      application/vnd-v1.0+json:
        schema: |
          {
            "type": "array",
            "items": {
              "$ref": "http://atomicbits.io/raml10/user.json"
            }
          }
    responses:
      202:
        body:
          application/vnd-v1.0+json:
            schema: |
              {
                "type": "array",
                "items": {
                  "$ref": "http://atomicbits.io/raml10/user.json"
                }
              }

/{userid}/location:
  uriParameters:
    userid:
      description: The user's id.
      type: string
      required: true
  get:
    responses:
      200:
        body:
          application/vnd-v1.0+json:
            schema: geometry

/test:
  get:
    body:
      application/json:
        schema: |
          {
            "$schema": "http://json-schema.org/draft-03/schema#",
            "id": "http://gurumeditator.io/schema/my-object.json",
            "type": "object",
            "properties": {
              "data": {
                "type": "array",
                "items": {
                  "id": "http://gurumeditator.io/schema/my-other-object.json",
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "required": true
                    },
                    "typeName": {
                      "type": "string",
                      "required": true
                    },
                    "placeList": {
                      "type": "string",
                      "required": true
                    }
                  }
                }
              }
            }
          }

/inlinetype:
  get:
    body:
      application/json:
        properties:
          name:
            type: string
          magickey:
            type: integer


api: Add /projects and `GET /builds`

api: Add /projects and `GET /builds`

#%RAML 0.8
---
title: Coverit
version: 0.0.1
baseUri: http://api.coverit.io/
mediaType:  application/json
securedBy: [oauth_2_0]

documentation:
    - title: Objects
      content: !include README.md

securitySchemes:
    - oauth_2_0: !include http://raml.link/securitySchemes/oauth_2_0.yml

/upload:
    displayName: Upload coverage report
    post:
        description: |
            Upload coverage report
        body:
            application/x-www-form-urlencoded:
                formParameters:
                    token:
                        description: Repo Token
                        type: string
                        required: true
                        example: AFNetworking/AFNetworking
                    report:
                        description: Report file, it's type should carried in `Content-Type`
                        type: file
                    git_commit:
                        description: Git commit sha in 10 chars
                        type: string
                        required: true
                        example: 09b26bf784
                    git_branch:
                        description: Git branch
                        type: string
                        required: true
                        example: master

/projects:
    displayName: Project
    post:
        description: |
            Create a project
        body:
            schema: |
                name: string
                repo_url: url
                repo_sshkey: string
        responses:
            201:
                body:
                    schema: |
                        _id: string
                        name: string
    get:
        description: |
            List projects
        responses:
            200:
                body:
                    schema: |
                        [
                            _id: string
                            name: string
                        ]

/builds:
    displayName: Build
    get:
        description: |
            List builds
        queryParameters:
            project:
                description: Project name
                example: coverit/coverit
            branch:
                description: Project branch
                example: master
        responses:
            200:
                body:
                    schema: |
                    [
                        _id: string
                        git:
                            branch: string
                            commit: string
                            date: time
                            commiter: string
                            type: string
                        platform: string
                        coverage: int
                        reports: [string]
                    ]
    /{build_id}:
        uriParameters:
            build_id:
                description: Build ID
                type: string
                example: '4ed2b809d7446b9a0e000014'
        get:
            description: |
                Get build info
            responses:
                200:
                    body:
                        schema: |
                            _id: string
                            git:
                                branch: string
                                commit: string
                                date: time
                                commiter: string
                                type: string
                            platform: string
                            coverage: int
                            reports: [string]

/reports:
    displayName: Report
    /{report_id}:
        uriParameters:
            report_id:
                description: Report ID
                type: string
                example: '4ed2b809d7446b9a0e000014'
        get:
            description: |
                Get report
            responses:
                200:
                    body:
                        schema: |
                            _id: string
                            user: string
                            project: string
                            build:
                                git:
                                    commit: string
                                    branch: string
                                    date: time
                            files: [
                                name: string
                                coverage: int
                                lines: int
                                hit: int
                            ]

        /{file_name}:
            uriParameters:
                file_name:
                    description: File name
                    type: string
                    example: 'coverit/main.go'
            get:
                description: |
                    Get source level coverage info
                responses:
                    200:
                        body:
                            schema: |
                                user: string
                                project: string
                                file: string
                                source: string
                                line_coverage: [
                                    line_no: int
                                    hit: int
                                ]
                                coverage: int
                                lines: int

#%RAML 0.8
---
title: Coverit
version: 0.0.1
baseUri: http://api.coverit.io/
mediaType:  application/json
securedBy: [oauth_2_0]

documentation:
    - title: Objects
      content: !include README.md

securitySchemes:
    - oauth_2_0: !include http://raml.link/securitySchemes/oauth_2_0.yml

/upload:
    displayName: Upload coverage report
    post:
        description: |
            Upload coverage report
        body:
            application/x-www-form-urlencoded:
                formParameters:
                    token:
                        description: Repo Token
                        type: string
                        required: true
                        example: AFNetworking/AFNetworking
                    report:
                        description: Report file, it's type should carried in `Content-Type`
                        type: file
                    git_commit:
                        description: Git commit sha in 10 chars
                        type: string
                        required: true
                        example: 09b26bf784
                    git_branch:
                        description: Git branch
                        type: string
                        required: true
                        example: master

/builds:
    displayName: Build
    /{build_id}:
        uriParameters:
            build_id:
                description: Build ID
                type: string
                example: '4ed2b809d7446b9a0e000014'
        get:
            description: |
                Get build info
            responses:
                200:
                    body:
                        schema: |
                            _id: string
                            git:
                                branch: string
                                commit: string
                                date: time
                                commiter: string
                                type: string
                            platform: string
                            coverage: int
                            reports: [string]

/reports:
    displayName: Report
    /{report_id}:
        uriParameters:
            report_id:
                description: Report ID
                type: string
                example: '4ed2b809d7446b9a0e000014'
        get:
            description: |
                Get report
            responses:
                200:
                    body:
                        schema: |
                            _id: string
                            user: string
                            project: string
                            build:
                                git:
                                    commit: string
                                    branch: string
                                    date: time
                            files: [
                                name: string
                                coverage: int
                                lines: int
                                hit: int
                            ]

        /{file_name}:
            uriParameters:
                file_name:
                    description: File name
                    type: string
                    example: 'coverit/main.go'
            get:
                description: |
                    Get source level coverage info
                responses:
                    200:
                        body:
                            schema: |
                                user: string
                                project: string
                                file: string
                                source: string
                                line_coverage: [
                                    line_no: int
                                    hit: int
                                ]
                                coverage: int
                                lines: int


webservices.raml: Remove comment about merged todo

Removed comment in webservices.raml that referenced
https://gitlab.com/coala/landing/merge_requests/39, which is now merged

Closes https://github.com/coala/corobo/issues/617

#%RAML 1.0

title: coala webservices
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: http://webservices.coala.io
mediaType: application/json

types:
  Bear:
    type: object
    properties:
      ASCIINEMA_URL: string
      AUTHORS: string[]
      AUTHORS_EMAILS: string[]
      BEAR_DEPS: string[]
      CAN_DETECT: string[]
      CAN_FIX: string[]
      INCLUDE_LOCAL_FILES: string[]
      LANGUAGES: string[]
      LICENSE: string
      MAINTAINERS: string[]
      MAINTAINERS_EMAILS: string[]
      PLATFORMS: string[]
      REQUIREMENTS: Requirement[]
      can_detect: string[]
      data_dir: string
      maintainers: string[]
      maintainers_emails: string[]
      metadata: BearMetaData
      name: string
  Requirement:
    type: object
    properties:
      package: string
      type: string
      version: string
  BearInfo:
    type: object
    properties:
      name: string
      desc: string
      languages: string[]
  BearMetaData:
    type: object
    properties:
      desc: string
      non_optional_params: string[]
      optional_params: string[]
  User:
    type: object
    properties:
      reviews: number
      contributions: number
      bio: string
      login: string
      name: string
      issues: number

/list:
  /bears:
    get:
      responses:
        200:
          body:
            application/json:
              type: BearInfo[]

/search:
  /bears:
    get:
      responses:
        200:
          body:
            application/json:
              type: Bear
      queryParameters:
        bear:
          type: string
          required: true

/contrib/:
  get:
    responses:
      200:
        body:
          application/json:
            type: User[]

#%RAML 1.0

title: coala webservices
version: v1
protocols: [ HTTP, HTTPS ]
baseUri: http://webservices.coala.io
mediaType: application/json

types:
  Bear:
    type: object
    properties:
      ASCIINEMA_URL: string
      AUTHORS: string[]
      AUTHORS_EMAILS: string[]
      BEAR_DEPS: string[]
      CAN_DETECT: string[]
      CAN_FIX: string[]
      INCLUDE_LOCAL_FILES: string[]
      LANGUAGES: string[]
      LICENSE: string
      MAINTAINERS: string[]
      MAINTAINERS_EMAILS: string[]
      PLATFORMS: string[]
      REQUIREMENTS: Requirement[]
      can_detect: string[]
      data_dir: string
      maintainers: string[]
      maintainers_emails: string[]
      metadata: BearMetaData
      name: string
  Requirement:
    type: object
    properties:
      package: string
      type: string
      version: string
  BearInfo:
    type: object
    properties:
      name: string
      desc: string
      languages: string[]
  BearMetaData:
    type: object
    properties:
      desc: string
      non_optional_params: string[]
      optional_params: string[]
  User:
    type: object
    properties:
      reviews: number
      contributions: number
      bio: string
      login: string
      name: string
      issues: number

/list:
  /bears:
    get:
      responses:
        200:
          body:
            application/json:
              type: BearInfo[]  # NOTE: not merged https://gitlab.com/coala/landing/merge_requests/39

/search:
  /bears:
    get:
      responses:
        200:
          body:
            application/json:
              type: Bear
      queryParameters:
        bear:
          type: string
          required: true

/contrib/:
  get:
    responses:
      200:
        body:
          application/json:
            type: User[]