enola.yaml

# SPDX-License-Identifier: Apache-2.0
#
# Copyright 2023-2024 The Enola <https://enola.dev> Authors
#
# 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
#
#     https://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.

# NB: schemas/Type.schema.json et al are generated by tools/protoc.bash!

# TODO Rosetta support for YAML with “---” - just make it List!
# ./enola rosetta --in=file:models/enola/enola.yaml --out=file:models/enola/enola.json
# converts this to JSON, which may be interesting for some template engines?

# TODO https://github.com/redhat-developer/vscode-yaml/issues/995
# with https://github.com/redhat-developer/yaml-language-server/issues/946

# TODO Move this into .vscode/settings.json
# (once https://docs.enola.dev/json-schema/enola_meta.schema.jsonc is published)
# yaml-language-server: $schema=schemas/Type.schema.json

# TODO When https://github.com/python-jsonschema/check-jsonschema/issues/222 is fixed,
# validate this during the build, using https://github.com/python-jsonschema/check-jsonschema#example-pre-commit-config.

name: enola.dev/url
doc: enola.md#URL
emoji: 🔗
labels:
  en: URL
#schema:
string: {}
hrefs:
  it: "{url}"
---
name: enola.dev/id
doc: enola.md#ID
emoji: 🆔
labels:
  en: Enola (binary) ID
schema:
  binary:
java: dev.enola.core.ByteSeq

---
name: enola.dev/gun
doc: enola.md#GUN
labels:
  en: Globally Unique Name (GUN)
schema:
  string:

---
name: enola.dev/email
doc: enola.md#Email
emoji: 📧
labels:
  en: Email Address
  de: Email Adresse
  de-CH: E-Mail Adresse
hrefs:
  mailto:
    url: mailto:{email}
  gmail-from:
    # TODO Test encoding! The @ has to be %40 encoded...
    url: https://mail.google.com/mail/u/0/#search/from%3A{email}
  gmail-to:
    url: https://mail.google.com/mail/u/0/#search/to%3A{email}
schema:
  string:

---
name: enola.dev/mls
doc: enola.md#MLS
emoji: 🌐
labels:
  en: Multi-language Strings
# schema? It's a map<string, string> .. but do we HAVE to specify a schema? For what??

---
name: enola.dev/proto
doc: enola.md#Proto
emoji: 🗜️
labels:
  en: Protocol Buffer Message
schema:
  string:
hrefs:
  enola:
    url: enola:enola.dev/proto/{fqn}