Skip to content

Commit 45dcefe

Browse files
author
Alan Christie
committed
docs: Doc tweak (talks about yaml-language-server)
1 parent 845a101 commit 45dcefe

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,9 @@ Informatics Matters Data Manager Job Decoder
1313
:target: https://github.com/InformaticsMatters/squonk2-data-manager-job-decoder/actions/workflows/publish.yaml
1414
:alt: Publish
1515

16-
A package that simplifies the decoding of encoded text strings.
16+
A package that simplifies the decoding of encoded text strings and validation
17+
of Job Definitions and Manifests.
18+
1719
Given an encoded string the ``decode()`` method
1820
returns the decoded value or an error.
1921

@@ -31,6 +33,14 @@ The package also provides ``validate_job_schema()`` and
3133
validate the Manifests and Job definitions against the
3234
built-in schemas.
3335

36+
If you have a Job Definition or Manifest file you can add a reference to the
37+
corresponding schema in this package to your file to help you identify schema
38+
violations prior to deployment. To do this you just need to add a line starting
39+
``# yaml-language-server:`` at the top of your file. For example,
40+
you can link to the **v2.3.0** Job Definition schema by adding the following line::
41+
42+
# yaml-language-server: $schema=https://raw.githubusercontent.com/InformaticsMatters/squonk2-data-manager-job-decoder/refs/tags/2.3.0/decoder/job-definition-schema.yaml
43+
3444
.. _jinja2: https://jinja.palletsprojects.com/en/3.0.x/
3545

3646
Installation (Python)

0 commit comments

Comments
 (0)