Skip to content

Commit

Permalink
replaced models link with raw link
Browse files Browse the repository at this point in the history
  • Loading branch information
@ashutshkumr
ashutshkumr committed Jul 6, 2022
1 parent 8fa11b7 commit faa79b4
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ What version of the Open Traffic Generator spec does Ixia-c implement?
</summary>
<br>

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).

</details>

Expand Down
6 changes: 3 additions & 3 deletions docs/hello-snappi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,17 @@ 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.
<details>
<summary><b>Expand</b> this section for details on how to effectively navigate through <a href="https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml">snappi API documentation</a>.</summary><br/>
<summary><b>Expand</b> this section for details on how to effectively navigate through <a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml">snappi API documentation</a>.</summary><br/>

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.

The snappi API documentation linked above will always point to API version **v0.8.1**. To use a different API version instead:

* Identify API version by opening <a href="https://github.com/open-traffic-generator/snappi/releases/download/v0.8.2/models-release">this link</a> in a browser and replacing **v0.8.2** in URL with intended snappi version.

* Open <a href="https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml">this link</a> in a browser after replacing **v0.8.1** in URL with intended API version.
* Open <a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml">this link</a> in a browser after replacing **v0.8.1** in URL with intended API version.

</details>

Expand Down
4 changes: 2 additions & 2 deletions docs/news.md
View file
Original file line number Diff line number Diff line change
@@ -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)

Expand Down
4 changes: 2 additions & 2 deletions docs/releases.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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/[email protected]) |
| ixia-c-controller | [0.0.1-2994](https://hub.docker.com/r/ixiacom/ixia-c-controller/tags) |
Expand All @@ -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/[email protected]) |
| ixia-c-controller | [0.0.1-2992](https://hub.docker.com/r/ixiacom/ixia-c-controller/tags) |
Expand Down
4 changes: 2 additions & 2 deletions readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

<p align="center">
<a href="https://hub.docker.com/r/ixiacom/ixia-c-controller/tags"><img alt="Release v0.0.1-2994" src="https://img.shields.io/badge/release-v0.0.1--2994-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://github.com/open-traffic-generator/models/releases/download/v0.8.1/openapi.yaml"><img alt="Open Traffic Generator v0.8.1" src="https://img.shields.io/badge/open--traffic--generator-v0.8.1-brightgreen"></a>
<a href="https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/open-traffic-generator/models/v0.8.1/artifacts/openapi.yaml"><img alt="Open Traffic Generator v0.8.1" src="https://img.shields.io/badge/open--traffic--generator-v0.8.1-brightgreen"></a>
<a href="https://pypi.org/project/snappi/0.8.2"><img alt="snappi v0.8.2" src="https://img.shields.io/badge/snappi-v0.8.2-brightgreen"></a>
<a href="docs/news.md"><img alt="news" src="https://img.shields.io/badge/-news-blue?logo=github"></a>
<a href="docs/contribute.md"><img alt="news" src="https://img.shields.io/badge/-contribute-blue?logo=github"></a>
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit faa79b4

Please sign in to comment.