Skip to content
Open

2.x #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
5f754c6
New file tree for v2; fixes #45 Switch to IETF BCP 47 language tags
tiagosimoes-euf Sep 5, 2025
110536e
Initial review of Programmes; covers #38 #46 #47 #53; impacts #35 #45
tiagosimoes-euf Sep 5, 2025
ec12f06
Adds ELM vocabularies to Programme per #48
tiagosimoes-euf Sep 5, 2025
cf7b93c
Initial review of Courses; covers #26 #49 #50 #51
tiagosimoes-euf Sep 5, 2025
b134476
Refactoring for readability and reusability
tiagosimoes-euf Sep 5, 2025
22bb462
Introduces lastModified field in all resource types
tiagosimoes-euf Sep 8, 2025
23aa225
Simplifies Course meta: no global rule, clearer field name, improved doc
tiagosimoes-euf Sep 8, 2025
727ac03
Tweaks to heiId, abbreviations in HEIs and OUnits
tiagosimoes-euf Sep 8, 2025
66dff4d
Sorts out Links objects as per #35; other minor fixes
tiagosimoes-euf Sep 8, 2025
d82ed92
Prerequisite Course relationship
tiagosimoes-euf Sep 9, 2025
0a87e2f
Includes related programmes in the relationships
tiagosimoes-euf Sep 9, 2025
96a69a5
Adds deprecated flag to Courses as per #36
tiagosimoes-euf Sep 9, 2025
3cbac1d
Missing description for deprecated field
tiagosimoes-euf Sep 9, 2025
a9a2b71
Groups fields and links schemas in subdirs
tiagosimoes-euf Sep 9, 2025
bd4b32b
Fixes a typo
tiagosimoes-euf Sep 9, 2025
52d150b
Rebuilds examples according to the current schema
tiagosimoes-euf Sep 9, 2025
1e744b2
Introduces support for Course instances
tiagosimoes-euf Sep 9, 2025
8697606
Adds Course inherited properties to Instance
tiagosimoes-euf Sep 9, 2025
54b6901
More elements of CourseInstance
tiagosimoes-euf Sep 9, 2025
7a78dc5
Language of instruction is always required
tiagosimoes-euf Sep 10, 2025
cca3fdd
Adds grading scheme and result distribution (EWP Courses)
tiagosimoes-euf Sep 10, 2025
b12edf7
Path review, HTTP headers
tiagosimoes-euf Sep 10, 2025
251fbd2
Consistent field order; ready for first alpha #34
tiagosimoes-euf Sep 10, 2025
43d5b77
Adds DDEV support; updates dependencies
tiagosimoes-euf Mar 2, 2026
4ce6ebb
Streamlines tooling
tiagosimoes-euf Mar 4, 2026
cf06fef
Rebuils specification as is
tiagosimoes-euf Mar 4, 2026
2aee20b
Fixes 57 - abbreviations in hei and ounit must follow EWP
tiagosimoes-euf Mar 4, 2026
1035e47
Fixes #58 issue with relationship objects; updates examples
tiagosimoes-euf Mar 4, 2026
6a0dad8
Fixes #57 so HEI and OUnit have single nullable string for abbreviation
tiagosimoes-euf Mar 4, 2026
1117001
Fixes #60 ELM Learning Schedule Type is single value
tiagosimoes-euf Mar 4, 2026
9b9bb01
Fixes #59 programme.ects is float; updated examples
tiagosimoes-euf Mar 4, 2026
8d6511b
Version bump, update description
tiagosimoes-euf Mar 4, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
291 changes: 291 additions & 0 deletions .ddev/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,291 @@
name: occapi-openapi
type: php
docroot: public
php_version: "8.4"
webserver_type: nginx-fpm
xdebug_enabled: false
additional_hostnames: []
additional_fqdns: []
database:
type: mariadb
version: "11.8"
use_dns_when_possible: true
composer_version: "2"
web_environment: []
corepack_enable: false

# Key features of DDEV's config.yaml:

# name: <projectname> # Name of the project, automatically provides
# http://projectname.ddev.site and https://projectname.ddev.site
# If the name is omitted, the project will take the name of the enclosing directory,
# which is useful if you want to have a copy of the project side by side with this one.

# type: <projecttype> # backdrop, cakephp, codeigniter, craftcms, drupal, drupal6, drupal7, drupal8, drupal9, drupal10, drupal11, drupal12, generic, laravel, magento, magento2, php, shopware6, silverstripe, symfony, typo3, wordpress
# See https://docs.ddev.com/en/stable/users/quickstart/ for more
# information on the different project types

# docroot: <relative_path> # Relative path to the directory containing index.php.

# php_version: "8.4" # PHP version to use, "5.6" through "8.5"

# You can explicitly specify the webimage but this
# is not recommended, as the images are often closely tied to DDEV's' behavior,
# so this can break upgrades.

# webimage: <docker_image>
# It’s unusual to change this option, and we don’t recommend it without Docker experience and a good reason.
# Typically, this means additions to the existing web image using a .ddev/web-build/Dockerfile.*

# database:
# type: <dbtype> # mysql, mariadb, postgres
# version: <version> # database version, like "10.11" or "8.0"
# MariaDB versions can be 5.5-10.8, 10.11, 11.4, 11.8
# MySQL versions can be 5.5-8.0, 8.4
# PostgreSQL versions can be 9-18

# router_http_port: <port> # Port to be used for http (defaults to global configuration, usually 80)
# router_https_port: <port> # Port for https (defaults to global configuration, usually 443)

# xdebug_enabled: false # Set to true to enable Xdebug and "ddev start" or "ddev restart"
# Note that for most people the commands
# "ddev xdebug" to enable Xdebug and "ddev xdebug off" to disable it work better,
# as leaving Xdebug enabled all the time is a big performance hit.

# xhgui_http_port: "8143"
# xhgui_https_port: "8142"
# The XHGui ports can be changed from the default 8143 and 8142
# Very rarely used

# host_xhgui_port: "8142"
# Can be used to change the host binding port of the XHGui
# application. Rarely used; only when port conflict and
# bind_all_ports is used (normally with router disabled)

# xhprof_mode: [prepend|xhgui|global]
# Default is "xhgui"

# webserver_type: nginx-fpm, apache-fpm, generic

# timezone: Europe/Berlin
# If timezone is unset, DDEV will attempt to derive it from the host system timezone
# using the $TZ environment variable or the /etc/localtime symlink.
# This is the timezone used in the containers and by PHP;
# it can be set to any valid timezone,
# see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
# For example Europe/Dublin or MST7MDT

# composer_root: <relative_path>
# Relative path to the Composer root directory from the project root. This is
# the directory which contains the composer.json and where all Composer related
# commands are executed.

# composer_version: "2"
# You can set it to "" or "2" (default) for Composer v2
# to use the latest major version available at the time your container is built.
# It is also possible to use each other Composer version channel. This includes:
# - 2.2 (latest Composer LTS version)
# - stable
# - preview
# - snapshot
# Alternatively, an explicit Composer version may be specified, for example "2.2.18".
# To reinstall Composer after the image was built, run "ddev utility rebuild".

# nodejs_version: "24"
# change from the default system Node.js version to any other version.
# See https://docs.ddev.com/en/stable/users/configuration/config/#nodejs_version for more information
# and https://www.npmjs.com/package/n#specifying-nodejs-versions for the full documentation.

# corepack_enable: false
# Change to 'true' to 'corepack enable' and gain access to latest versions of yarn/pnpm

# additional_hostnames:
# - somename
# - someothername
# would provide http and https URLs for "somename.ddev.site"
# and "someothername.ddev.site".

# additional_fqdns:
# - example.com
# - sub1.example.com
# would provide http and https URLs for "example.com" and "sub1.example.com"
# Please take care with this because it can cause great confusion.

# upload_dirs: "custom/upload/dir"
#
# upload_dirs:
# - custom/upload/dir
# - ../private
#
# would set the destination paths for ddev import-files to <docroot>/custom/upload/dir
# When Mutagen is enabled this path is bind-mounted so that all the files
# in the upload_dirs don't have to be synced into Mutagen.

# disable_upload_dirs_warning: false
# If true, turns off the normal warning that says
# "You have Mutagen enabled and your 'php' project type doesn't have upload_dirs set"

# ddev_version_constraint: ""
# Example:
# ddev_version_constraint: ">= 1.24.8"
# This will enforce that the running ddev version is within this constraint.
# See https://github.com/Masterminds/semver#checking-version-constraints for
# supported constraint formats

# working_dir:
# web: /var/www/html
# db: /home
# would set the default working directory for the web and db services.
# These values specify the destination directory for ddev ssh and the
# directory in which commands passed into ddev exec are run.

# omit_containers: [db, ddev-ssh-agent]
# Currently only these containers are supported. Some containers can also be
# omitted globally in the ~/.ddev/global_config.yaml. Note that if you omit
# the "db" container, several standard features of DDEV that access the
# database container will be unusable. In the global configuration it is also
# possible to omit ddev-router, but not here.

# performance_mode: "global"
# DDEV offers performance optimization strategies to improve the filesystem
# performance depending on your host system. Should be configured globally.
#
# If set, will override the global config. Possible values are:
# - "global": uses the value from the global config.
# - "none": disables performance optimization for this project.
# - "mutagen": enables Mutagen for this project.
#
# See https://docs.ddev.com/en/stable/users/install/performance/#mutagen

# fail_on_hook_fail: False
# Decide whether 'ddev start' should be interrupted by a failing hook

# host_https_port: "59002"
# The host port binding for https can be explicitly specified. It is
# dynamic unless otherwise specified.
# This is not used by most people, most people use the *router* instead
# of the localhost port.

# host_webserver_port: "59001"
# The host port binding for the ddev-webserver can be explicitly specified. It is
# dynamic unless otherwise specified.
# This is not used by most people, most people use the *router* instead
# of the localhost port.

# host_db_port: "59002"
# The host port binding for the ddev-dbserver can be explicitly specified. It is dynamic
# unless explicitly specified.

# mailpit_http_port: "8025"
# mailpit_https_port: "8026"
# The Mailpit ports can be changed from the default 8025 and 8026

# host_mailpit_port: "8025"
# The mailpit port is not normally bound on the host at all, instead being routed
# through ddev-router, but it can be bound directly to localhost if specified here.

# webimage_extra_packages: ['php${DDEV_PHP_VERSION}-tidy', 'php${DDEV_PHP_VERSION}-yac']
# Extra Debian packages that are needed in the webimage can be added here

# dbimage_extra_packages: [netcat, telnet, sudo]
# Extra Debian packages that are needed in the dbimage can be added here

# use_dns_when_possible: true
# If the host has internet access and the domain configured can
# successfully be looked up, DNS will be used for hostname resolution
# instead of editing /etc/hosts
# Defaults to true

# project_tld: ddev.site
# The top-level domain used for project URLs
# The default "ddev.site" allows DNS lookup via a wildcard

# share_default_provider: ngrok
# The default share provider to use for "ddev share"
# Defaults to global configuration, usually "ngrok"
# Can be "ngrok" or "cloudflared" or the name of a custom provider from .ddev/share-providers/

# share_provider_args: --basic-auth username:pass1234
# Provide extra flags to the share provider script
# See https://docs.ddev.com/en/stable/users/configuration/config/#share_provider_args

# disable_settings_management: false
# If true, DDEV will not create CMS-specific settings files like
# Drupal's settings.php/settings.ddev.php or TYPO3's additional.php
# In this case the user must provide all such settings.

# You can inject environment variables into the web container with:
# web_environment:
# - SOMEENV=somevalue
# - SOMEOTHERENV=someothervalue

# no_project_mount: false
# (Experimental) If true, DDEV will not mount the project into the web container;
# the user is responsible for mounting it manually or via a script.
# This is to enable experimentation with alternate file mounting strategies.
# For advanced users only!

# bind_all_interfaces: false
# If true, host ports will be bound on all network interfaces,
# not the localhost interface only. This means that ports
# will be available on the local network if the host firewall
# allows it.

# default_container_timeout: 120
# The default time that DDEV waits for all containers to become ready can be increased from
# the default 120. This helps in importing huge databases, for example.

#web_extra_exposed_ports:
#- name: nodejs
# container_port: 3000
# http_port: 2999
# https_port: 3000
#- name: something
# container_port: 4000
# https_port: 4000
# http_port: 3999
# Allows a set of extra ports to be exposed via ddev-router
# Fill in all three fields even if you don’t intend to use the https_port!
# If you don’t add https_port, then it defaults to 0 and ddev-router will fail to start.
#
# The port behavior on the ddev-webserver must be arranged separately, for example
# using web_extra_daemons.
# For example, with a web app on port 3000 inside the container, this config would
# expose that web app on https://<project>.ddev.site:9999 and http://<project>.ddev.site:9998
# web_extra_exposed_ports:
# - name: myapp
# container_port: 3000
# http_port: 9998
# https_port: 9999

#web_extra_daemons:
#- name: "http-1"
# command: "/var/www/html/node_modules/.bin/http-server -p 3000"
# directory: /var/www/html
#- name: "http-2"
# command: "/var/www/html/node_modules/.bin/http-server /var/www/html/sub -p 3000"
# directory: /var/www/html

# override_config: false
# By default, config.*.yaml files are *merged* into the configuration
# But this means that some things can't be overridden
# For example, if you have 'use_dns_when_possible: true'' you can't override it with a merge
# and you can't erase existing hooks or all environment variables.
# However, with "override_config: true" in a particular config.*.yaml file,
# 'use_dns_when_possible: false' can override the existing values, and
# hooks:
# post-start: []
# or
# web_environment: []
# or
# additional_hostnames: []
# can have their intended affect. 'override_config' affects only behavior of the
# config.*.yaml file it exists in.

# Many DDEV commands can be extended to run tasks before or after the
# DDEV command is executed, for example "post-start", "post-import-db",
# "pre-composer", "post-composer"
# See https://docs.ddev.com/en/stable/users/extend/custom-commands/ for more
# information on the commands that can be extended and the tasks you can define
# for them. Example:
#hooks:
94 changes: 5 additions & 89 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,91 +1,7 @@
### Documentation available at https://docs.wodby.com/stacks/php/local
### Changelog can be found at https://github.com/wodby/docker4php/releases
### Images tags format explained at https://github.com/wodby/docker4php#images-tags
# Indicate which OCCAPI version will be used to build the specification assets.

### PROJECT SETTINGS
DEFINITION='openapi/occapi_v2.yaml'
#DEFINITION='openapi/occapi_v1.yaml'

## Used by Docker
PROJECT_NAME=occapi-openapi
PROJECT_BASE_URL=occapi.docker.localhost

PROD_BASE_URL=occapi.uni-foundation.eu
BUILD_PROD=false

HTTP_PORT=8000
NODE_PORT=3000

DB_NAME=php
DB_USER=php
DB_PASSWORD=php
DB_ROOT_PASSWORD=password
DB_HOST=mariadb
DB_DRIVER=mysql

### --- PHP ----

# Linux (uid 1000 gid 1000)

#PHP_TAG=8.4-dev-4.60.0
PHP_TAG=8.3-dev-4.60.0
#PHP_TAG=8.2-dev-4.60.0
#PHP_TAG=8.1-dev-4.60.0

# macOS (uid 501 gid 20)

#PHP_TAG=8.3-dev-macos-4.60.0
#PHP_TAG=8.2-dev-macos-4.60.0
#PHP_TAG=8.1-dev-macos-4.60.0

### --- NGINX ----

NGINX_TAG=1.29-5.44.3
#NGINX_TAG=1.28-5.44.3

### --- NODE ---

NODE_TAG=22-dev-1.53.0
#NODE_TAG=20-dev-1.53.0
#NODE_TAG=18-dev-1.53.0

### --- MARIADB ----

MARIADB_TAG=11.4-3.32.3
#MARIADB_TAG=10.11-3.32.3
#MARIADB_TAG=10.6-3.32.3
#MARIADB_TAG=10.5-3.32.3

### --- POSTGRESQL ----

POSTGRES_TAG=17-1.36.2
#POSTGRES_TAG=16-1.36.2
#POSTGRES_TAG=15-1.36.2
#POSTGRES_TAG=14-1.36.2
#POSTGRES_TAG=13-1.36.2

### --- VALKEY ---

VALKEY_TAG=8-1.1.1
#VALKEY_TAG=7-1.1.1

### --- VARNISH ---

VARNISH_TAG=6.0-4.21.3

### --- OPENSEARCH ---

OPENSEARCH_TAG=2
OPENSEARCH_ADMIN_PASSWORD=VERY%@bad123password

### --- SOLR ---

SOLR_TAG=9-5.3.0

### OTHERS

ADMINER_TAG=5-4.4.0
APACHE_TAG=2.4-4.16.3
MEMCACHED_TAG=1-2.20.2
RSYSLOG_TAG=latest
WEBGRIND_TAG=1-1.38.0
OPENSMTPD_TAG=7-1.26.2
XHPROF_TAG=3.16.0
BUNDLE='public/v2/openapi.yaml'
#BUNDLE='public/v1/openapi.yaml'
Loading