diff --git a/src/doc/cfood-schema.yml b/src/doc/cfood-schema.yml new file mode 120000 index 0000000000000000000000000000000000000000..c34280ed44cdd07eccb20e314e08a60c899dfe8a --- /dev/null +++ b/src/doc/cfood-schema.yml @@ -0,0 +1 @@ +../caoscrawler/cfood-schema.yml \ No newline at end of file diff --git a/src/doc/cfood-specification.rst b/src/doc/cfood-specification.rst index 453921f99b006906704c08094c12005725d7b5d8..89588b2da9e4bb828eba05cc353dedb3abd6c821 100644 --- a/src/doc/cfood-specification.rst +++ b/src/doc/cfood-specification.rst @@ -2,5 +2,9 @@ CFood-Specification ((((((((((((((((((( +CFoods are defined using a YAML find that has to abide by the following +specification. The specifiacition is defined using a JSON schema (see +`src/caoscrawler/cfood-schema.yml`). A CFood is basically composed of converter +definitions. A converter definition must have the following structure: .. jsonschema:: cfood-schema.yml#/cfood/$defs/converter