smartcontractkit / smartcontractkit/chainlink

[DEVEL] Comments in TOML jobs

Open
#4,965 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

investigating
Dominant language
Go
Stars
8.2k
Forks
2k
Avg merge
1d 23h
Merged PRs (30d)
202

Description

Hey
What are the official conventions for using comments in TOML jobs, inside and outside the observationSource string blob?

Question came up when looking at oracle-spec.toml which uses // style comments inside the blob and ocr-spec-local-test.toml which uses hash outside the blob, and just wanted to be sure those examples reflect what can be expected to be found in an official chainlink job spec.

Side question: What are the rules for quotation of parameters within a [ ] task block?. All "type=" are unquoted, and almost all others are quoted. Except http.method and numerics.

Is quoting all parameters supported? :

[type="http" method="GET" url="http://example.com" allowunrestrictednetworkaccess="true"];

Edit: And how about that semicolon after the closing square bracket... Completely random across the files if used or not. Even the flow control lines task_x -> task_y have semicolon in some examples. What is the official definition, semicolon necessary or not?

Thank you : )

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing oracle-spec.toml with ocr-spec-local-test.toml, focusing on comments inside and outside observationSource, parameter quoting, and semicolons. This is complete when the official conventions for TOML job specs are decided and documented, including the examples raised in the issue.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.