peerdescriptor-schema.yaml

$schema: http://json-schema.org/draft-06/schema#
id: http://intercoop.somenergia.coop/peerinfo-schema/1.0/#
title: Peer catalog and api information for intercooperation
description: >
  This schema defines a format to describe a peer entity 
  in a intercooperation context using the intercoop protocol.
  It includes information to be able to display a catalog
  of services and how to activate them via an intercoop api.
type: object
required:
- intercoopVersion
- peerVersion
- peerid
- name
- logo
- description
- url
- privacyPolicyUrl
- services
- targetUrl
additionalProperties: false
properties:
  intercoopVersion:
    type: string
    pattern: '[0-9]+(\.[0-9]+)*'
    enum:
    - "1.0" # Force current version
  peerVersion:
    type: integer
  peerid:
    type: string
    pattern: '^[a-z]+$'
  name:
    title: Entity name
    type: string
  logo:
    title: Url to the entity logo
    type: string
  publickey:
    title: Public RSA key in PEM format that others peers can use to validate signed messages from the entity
    type: string
  description:
    title: Single line entity description
    $ref: "#/definitions/translatable"
  url:
    title: Url to entity's web page
    $ref: "#/definitions/translatable"
  privacyPolicyUrl:
    title: A link to the entity privacy policy
    $ref: "#/definitions/translatable"
  info:
    title: Extended information in markdown format
    $ref: "#/definitions/translatable"
  services:
    title: Services that the entity offers
    type: object
    patternProperties:
      "^[a-z]+$": 
        $ref: "#/definitions/service"
    additionalProperties: false
  dataFormat:
    type: string
    default: yaml
    enum:
    - yaml
    - json
    - xml
  targetUrl:
    title: base Url to redirect services
    type: string
  fields:
    title: Transferred fields for any service not specifying it
    default:
    - peerid
    - nif
    $ref: "#/definitions/transferFields"

definitions:

  transferFields:
    title: fields that a service could request to share
    type: array
    items:
      type: string
      enum:
      - originpeer # slug id of the source entity (required)
      - innerid # serial number within the source entity
      - peerroles # list of roles within the source entity (member, worker, customer...)
      - nif # includes dni, cie and cif
      - name # "surname, fistname" for physical persons, 
      - address
      - postalcode
      - city
      - state
      - country # ISO code
      - phone # Preferred contact phone
      - email # Preferred contact email
      - lang # Language preferred by the user (ISO code)
      - langs # Languages accepted by the user sorted by preference (ISO code)
      - proxynif # For legal persons, the proxy phisical person nif (see nif)
      - proxyname # For legal persons, the proxy phisical person name (see name)

  translatable:
    title: strings that can be optionally translated
    description: >
      Translatable strings may have plain string values
      or they can contain a map of translations with the
      2-letters of the lang ISO code.
    anyOf:
    - description: optionally untranslated string
      type: string
    - description: a map of translations including at least 'es'
      type: object
      required:
      - es
      additionalProperties: false
      patternProperties:
        (es|ca|gl|eu|an|ast|oc):
          type: string

  service:
    type: object
    required:
    - name
    - description
    additionalProperties: false
    properties:
      name:
        $ref: "#/definitions/translatable"
      description:
        $ref: "#/definitions/translatable"
      fields:
        description: Fields to be transferred to activate the service
        $ref: "#/definitions/transferFields"


# vim: et ts=2 sw=2