From 733d3310fa06f34e771f64e6f10f35319dfef8ee Mon Sep 17 00:00:00 2001 From: Arjan Lamers <> Date: Thu, 27 Jun 2019 08:47:10 +0200 Subject: [PATCH 1/2] fixed broken link due to renaming yaml to json --- README.md | 4 ++-- Using the standard.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9d02ef6..219fcac 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ This repository contains the ICAR ADE work-in-progress JSON standard. This page describes the principles driving this standard. If you want to use the ICAR ADE standard in your application, there are tips and tricks in the [Using the standard](https://github.com/adewg/ICAR/blob/master/Using%20the%20standard.md) file. For a quick start, open the -[exampleUrlScheme.yaml](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.yaml) file in +[exampleUrlScheme.yaml](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) file in your favorite OpenAPI Specification editor, or use the following URL to have a preview in the free Redoc tool: [view -exampleUrlScheme.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.yaml) +exampleUrlScheme.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) Approach diff --git a/Using the standard.md b/Using the standard.md index 054c53a..31e014d 100644 --- a/Using the standard.md +++ b/Using the standard.md @@ -6,10 +6,10 @@ The ADE standard is meant to be an open standard. As such, you are free to start The standard currently focuses on JSON messages defined in JSON Schema. These messages can be transported via REST or via any other channel. We are also working on a recommended URL scheme if you want to use REST. For now, you can find an example URL scheme to help you navigate and decide how to use the standard. This scheme is defined in the OpenAPI Specification v3. ## Getting Started -Most developers should be familiar with REST and JSON files. To simply view the standard, you can open the [exampleUrlScheme.yaml](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.yaml) file in your favorite OpenAPI Specification editor. +Most developers should be familiar with REST and JSON files. To simply view the standard, you can open the [exampleUrlScheme.yaml](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) file in your favorite OpenAPI Specification editor. Or, for convenience, use the following URL to have a preview in the free Redoc tool: -[view exampleUrlScheme.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.yaml) +[view exampleUrlScheme.json](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) ## Customizing the Standard The standard aims to cover most cases in a generic way. However, there will always be regional differences or vendor specific fields that may be required to be part of a message. You are free to simply add more fields to your messages than described in the standard. When doing so, please take note of the following recommendations: From dab66ba8181e59c5b7c0ffe4cb90f83e321e3756 Mon Sep 17 00:00:00 2001 From: Arjan Lamers <> Date: Thu, 27 Jun 2019 08:48:49 +0200 Subject: [PATCH 2/2] fixed broken link due to renaming yaml to json, missed a few --- README.md | 4 ++-- Using the standard.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 219fcac..c3181ab 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ This repository contains the ICAR ADE work-in-progress JSON standard. This page describes the principles driving this standard. If you want to use the ICAR ADE standard in your application, there are tips and tricks in the [Using the standard](https://github.com/adewg/ICAR/blob/master/Using%20the%20standard.md) file. For a quick start, open the -[exampleUrlScheme.yaml](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) file in +[exampleUrlScheme.json](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) file in your favorite OpenAPI Specification editor, or use the following URL to have a preview in the free Redoc tool: [view -exampleUrlScheme.yaml](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) +exampleUrlScheme.json](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) Approach diff --git a/Using the standard.md b/Using the standard.md index 31e014d..0cede4e 100644 --- a/Using the standard.md +++ b/Using the standard.md @@ -6,7 +6,7 @@ The ADE standard is meant to be an open standard. As such, you are free to start The standard currently focuses on JSON messages defined in JSON Schema. These messages can be transported via REST or via any other channel. We are also working on a recommended URL scheme if you want to use REST. For now, you can find an example URL scheme to help you navigate and decide how to use the standard. This scheme is defined in the OpenAPI Specification v3. ## Getting Started -Most developers should be familiar with REST and JSON files. To simply view the standard, you can open the [exampleUrlScheme.yaml](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) file in your favorite OpenAPI Specification editor. +Most developers should be familiar with REST and JSON files. To simply view the standard, you can open the [exampleUrlScheme.json](https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json) file in your favorite OpenAPI Specification editor. Or, for convenience, use the following URL to have a preview in the free Redoc tool: [view exampleUrlScheme.json](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/adewg/ICAR/master/Release%20Candidate%20Messages/exampleUrlScheme.json)