intercoopVersion: "1.0"  # Version of the protocol
peerVersion: 1 # Version of the descriptor data
peerid: somenergia # readable text identifier for the peer
name: Som Energia SCCL
logo: https://www.somenergia.coop/wp-content/uploads/2014/07/logohdmi.png
description: 
  es: Contrata la luz con la cooperativa de energía verde
  ca: Contracta la llum amb la cooperativa de energía verda
url:
  es: https://www.somenergia.coop/es
  ca: https://www.somenergia.coop/ca
  eu: https://www.somenergia.coop/eu
  gl: https://www.somenergia.coop/gl
privacyPolicyUrl:
  es: https://www.somenergia.coop/es/politica-de-privacidad-cookies-y-aviso-legal/
  ca: https://www.somenergia.coop/ca/politica-de-privacitat-cookies-i-avis-legal/
  eu: https://www.somenergia.coop/eu/pribatutasun-politika-cookie-ak-eta-lege-oharra/
  gl: https://www.somenergia.coop/gl/politica-de-privacidade-cookies-y-aviso-legal/
info:
  es: >
    Som Energia es una cooperativa de consumo de energía verde sin ánimo de lucro.
    Nuestras principales actividades son la comercialización y producción de energía de origen renovable.
    Estamos comprometidos a impulsar un cambio del modelo energético actual para conseguir un modelo 100% renovable.
  ca: >
    Som Energia és una cooperativa de consum d’energia verda sense ànim de lucre.
    Les nostres activitats principals són la comercialització i la producció d’energia d’origen renovable.
    Estem compromesos a impulsar un canvi del model energètic actual per assolir un model 100% renovable.
  eu: >
    Som Energia irabazi-asmorik gabeko energia berdearen kontsumo-kooperatiba da.
    Gure funtsezko jarduerak jatorri berriztagarriko energiaren ekoizpena eta komertzializazioa dira.
    Oraingo eredu energetikoaren aldaketaren alde gaude %100eko eredu guztiz berriztagarria lortzeko.
  gl: >
    Som Energia é unha cooperativa de consumo de enerxía verde sen ánimo de lucro.
    As nosas principais actividades son a comercialización e produción de enerxía de orixe renovable.
    Estamos comprometidos a impulsar un cambio do modelo enerxético actual para conseguir un modelo 100% renovable.
services:
  contract:
    name:
      es: Contrata la luz
    description:
      es: Contratar luz como si fueras miembro de la cooperativa.
  generationkwh:
    name:
      es: Generation kWh
    description:
      es: Participar en los proyectos de autoproducción colectiva.
  recuperaelsol:
    name:
      es: Recupera el sol
    description:
      es: Participar en rescates de proyectos solares en quiebra.
  collectivepurchases:
    name:
      es: Compras colectivas
    description:
      es: Participar en compras colectivas para socios/as.
      ca: Participar en compres col·lectives per a socis/es.
targetUrl: https://api.somenergia.coop/intercoop/contrataluz
dataFormat: yaml
fields:
- innerid # serial number within the source entity
- peerroles # list of roles within the source entity (member, worker, customer...)
- nif
- name
- address
- postalcode
- city
- state
- country
- phone
- email
- proxynif
- proxyname
publickey: |
  -----BEGIN PUBLIC KEY-----
  MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA6NNjLFEswRPwzTbuD1Oa
  H9eIVR3U/8iBxQR9jgExqCEI/4oBjBk/eZmYOVdygkZgTeU0TxD5NFd5Zd0Cewz3
  kTkUHJ9YLHSb2SClE6pYlocRYlrvPxEa0XIF+ujRcpKUk5UpEcFNzmNS0s7cUpB+
  UufeEUSyiETeMlu0pqhIXQZSQlgxBt3Fb4vUv8E2Jp1jb4b8A7iygN7oPE7800NX
  VqoCLTnoc3IPDTPugoxfH59rY7LZH0yCCFl5gIAmM1J+w6YFdfjSSwZyE4w/0aF8
  Y4CXTEOoo8f0vTnpN96or4ObdI1ZMwU8b7rpxEHmP2exAul9FnoEZytVtteAYpIt
  QwIDAQAB
  -----END PUBLIC KEY-----
# vim: et ts=2 sw=2

$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