Comments (10)
+1 on that. It would be nice to have it test both the markdown embedded and examples but that is more of a nice to have.
from image-spec.
So we could add the files from the embedded markdown examples as files, and have a test target against them.
https://gist.github.com/vbatts/b3e4fc231fbc92a9cbc28b9184f0b2d2 is what I was using when writing the schema.
I'm not really sure of a clean way to work with the examples while they're embedded in the markdown though.
from image-spec.
On Sat, Apr 16, 2016 at 07:57:13AM -0700, Vincent Batts wrote:
I'm not really sure of a clean way to work with the examples while
they're embedded in the markdown though.
Probably just make sure all embedded examples are subsets of the
stand-alone example JSON. It shouldn't be too hard to pull out the
JSON blocks by looking for ‘json’ and ‘
’ delimiters, and then
checking to see if that snippet is contained in one of a set of
stand-alone files. If this approach sounds useful, I'm happy to write
tooling for it (although it would probably be in Python ;).
from image-spec.
@stevvooe Are you going to work on this?
from image-spec.
I can look into it, but I'm not very familiar with JSONSchema. If anyone could suggest tools or an approach, that would be helpful.
I'll probably just use a Go package and a Makefile, barring common tools above.
from image-spec.
On Wed, Apr 20, 2016 at 03:56:44PM -0700, Stephen Day wrote:
I can look into it, but I'm not very familiar with JSONSchema. If
anyone could suggest tools or an approach, that would be helpful.
#18 and #32 already landed the JSON Schema and Go tooling for
validating stand-alone JSON 1, so you probably don't need to write
new stuff there. There's a README for that approach in 2, if that
helps get you started.
You will need to add the example JSON manifests, etc. that are used to
test the schema, and some tooling to run validate.go against the
example manifests, etc.
from image-spec.
@wking Thanks!
validate.go should be sufficient to get started. Do we want to consider the specification to be the source of all golden standards?
from image-spec.
Took a small pass at this in #41.
#41 proposes maintaining examples in specifications. All examples are a part of the specification, rather than maintaining them in external files.
If we like that approach, I can round out that PR and we can move forward.
from image-spec.
I like it.
On Thu, Apr 21, 2016 at 8:42 PM, Stephen Day [email protected]
wrote:
Took a small pass at this in #41
#41.#41 #41 proposes
maintaining examples in specifications. All examples are a part of the
specification, rather than maintaining them in external files.If we like that approach, I can round out that PR and we can move forward.
—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#34 (comment)
from image-spec.
Also, it would dictate that a new item for the style.md
showing how to do
the mime-type json examples.
On Fri, Apr 22, 2016 at 10:39 AM, Vincent Batts [email protected]
wrote:
I like it.
On Thu, Apr 21, 2016 at 8:42 PM, Stephen Day [email protected]
wrote:Took a small pass at this in #41
#41.#41 #41 proposes
maintaining examples in specifications. All examples are a part of the
specification, rather than maintaining them in external files.If we like that approach, I can round out that PR and we can move forward.
—
You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#34 (comment)
from image-spec.
Related Issues (20)
- Allow `subject` on index manifest HOT 2
- `subject` field ought to reference any digest HOT 12
- BUG: schema/ for image manifest is missing `subject`
- BUG: schema/ for descriptor is missing `data` and `artifactType`
- Fact finding: Registry & client support for Image Manifest type artifacts HOT 18
- the
- Issue Title
- Proposal: additional Pre-Defined Annotation Keys HOT 17
- Documentation for OCI Limitations HOT 4
- disambiguate wasi by renaming it to wasip1
- Schema validation is broken? HOT 4
- Rename the scratch descriptor HOT 4
- Export constants for "blobs" and "index.json"
- Support toml markup for Platform struct HOT 5
- Trx HOT 1
- missing json schema for artifact type on image index
- Final review for v1.1 release HOT 1
- consider new linters (current ones appear abandoned...)
- Request for Comments for v1.1.0 release HOT 19
- Language
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from image-spec.