diff --git a/docs/faq.md b/docs/faq.md index 562399a1..c86ad948 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -69,7 +69,7 @@ What version of the Open Traffic Generator spec does Ixia-c implement?
-Ixia-c implements version **[v0.8.1](https://github.com/open-traffic-generator/models/releases/tag/v0.8.1)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml). +Ixia-c implements version **[v0.8.1](https://github.com/open-traffic-generator/models/releases/tag/v0.8.1)** of the Open Traffic Generator Data Model. You can view the model [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml). diff --git a/docs/hello-snappi.md b/docs/hello-snappi.md index 4641ec32..4a731a5f 100644 --- a/docs/hello-snappi.md +++ b/docs/hello-snappi.md @@ -100,9 +100,9 @@ We now need to construct traffic configuration to be sent to controller. We'll n > By default, API requests in snappi are made over HTTPS with payloads as a JSON string. Since each object in snappi inherits `SnappiObject` or `SnappiIter`, they all share a common method called `.serialize()` and `deserialize()`, used internally during API requests, for valid conversion to / from a JSON string. We'll discuss about more such conveniences offered by snappi along the way.
-Expand this section for details on how to effectively navigate through snappi API documentation.
+Expand this section for details on how to effectively navigate through snappi API documentation.
-The objects and methods (for API calls) in snappi are auto-generated from an [Open API Generator YAML file](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml). This file adheres to [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification), which can (by design) also be rendered as an interactive API documentation. +The objects and methods (for API calls) in snappi are auto-generated from an [Open API Generator YAML file](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml). This file adheres to [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification), which can (by design) also be rendered as an interactive API documentation. [ReDoc](https://redocly.github.io/redoc/) is an open-source tool that does this. It accepts a link to valid OpenAPI YAML file and generates a document where all the methods (for API calls) are mentioned in the left navigation bar and for each selected method, there's a request / response body description in the center of the page. These descriptions lay out the entire object tree documenting each node in details. @@ -110,7 +110,7 @@ The snappi API documentation linked above will always point to API version **v0. * Identify API version by opening this link in a browser and replacing **v0.8.2** in URL with intended snappi version. -* Open this link in a browser after replacing **v0.8.1** in URL with intended API version. +* Open this link in a browser after replacing **v0.8.1** in URL with intended API version.
diff --git a/docs/news.md b/docs/news.md index 41ef7151..ec3df515 100644 --- a/docs/news.md +++ b/docs/news.md @@ -1,11 +1,11 @@ # News -* **1st July, 2022**: Ixia-c version 0.0.1 (build 2994) released. This conforms to **[v0.8.1](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml)** of the Open Traffic Generator Models specification. +* **1st July, 2022**: Ixia-c version 0.0.1 (build 2994) released. This conforms to **[v0.8.1](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml)** of the Open Traffic Generator Models specification. * This build includes stability fixes. [Read more](releases.md) -* **30th June, 2022**: Ixia-c version 0.0.1 (build 2992) released. This conforms to **[v0.8.1](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml)** of the Open Traffic Generator Models specification. +* **30th June, 2022**: Ixia-c version 0.0.1 (build 2992) released. This conforms to **[v0.8.1](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml)** of the Open Traffic Generator Models specification. * This build includes stability fixes. [Read more](releases.md) diff --git a/docs/releases.md b/docs/releases.md index 4880c477..749c1d12 100644 --- a/docs/releases.md +++ b/docs/releases.md @@ -11,7 +11,7 @@ This build contains stability fixes. | Component | Version | |-------------------------------|---------------| -| Open Traffic Generator API | [0.8.1](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml) | +| Open Traffic Generator API | [0.8.1](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml) | | snappi | [0.8.2](https://pypi.org/project/snappi/0.8.2) | | gosnappi | [0.8.2](https://pkg.go.dev/github.com/open-traffic-generator/snappi/gosnappi@v0.8.2) | | ixia-c-controller | [0.0.1-2994](https://hub.docker.com/r/ixiacom/ixia-c-controller/tags) | @@ -38,7 +38,7 @@ This build contains stability fixes. | Component | Version | |-------------------------------|---------------| -| Open Traffic Generator API | [0.8.1](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml) | +| Open Traffic Generator API | [0.8.1](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml) | | snappi | [0.8.2](https://pypi.org/project/snappi/0.8.2) | | gosnappi | [0.8.2](https://pkg.go.dev/github.com/open-traffic-generator/snappi/gosnappi@v0.8.2) | | ixia-c-controller | [0.0.1-2992](https://hub.docker.com/r/ixiacom/ixia-c-controller/tags) | diff --git a/readme.md b/readme.md index 54803966..190a0c4b 100644 --- a/readme.md +++ b/readme.md @@ -10,7 +10,7 @@

Release v0.0.1-2994 - Open Traffic Generator v0.8.1 + Open Traffic Generator v0.8.1 snappi v0.8.2 news news @@ -124,7 +124,7 @@ Before proceeding, please ensure [system prerequisites](docs/prerequisites.md) a * Optionally, Generate Traffic Using [curl](https://curl.se/) >We can also pass equivalent **JSON configuration** directly to ixia-c controller, without installing snappi, using **curl**. - >The detailed description of each node (and their attributes) in JSON configuration are well documented [here](https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml). + >The detailed description of each node (and their attributes) in JSON configuration are well documented [here](https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml). ```bash # push the contents of config file snappi-tests/configs/quickstart_snappi.json