|
| 1 | +<img width="1010" height="305" alt="image" src="https://github.com/user-attachments/assets/4fc04bbc-6e73-4168-8a68-97faa9e47281" /> |
1 | 2 |
|
2 | 3 | # RESO Commander |
3 | 4 |
|
|
8 | 9 | The RESO Commander is an OData client Java library and command-line client, |
9 | 10 | as well as an automated RESO Certification testing tool. |
10 | 11 |
|
11 | | -# Getting Started |
12 | | -To begin using the RESO Commander, choose one of the following topics: |
| 12 | +# RESO Certification |
| 13 | +The RESO Commander is only used for Web API Core testing and will be deprecated in the future in favor of the RESO SDK. |
13 | 14 |
|
14 | | -## [RESO Certification](/doc/Certification.md) |
15 | | -One of the Commander's primary uses is as an automated testing tool. This section |
16 | | -explains how to run the following tests: |
| 15 | +[**MORE INFO**](/doc/Certification.md) |
17 | 16 |
|
18 | | -* Data Dictionary |
19 | | -* Web API Core |
| 17 | +_For Data Dictionary certification, see [**RESO Certification Utils**](https://github.com/RESOStandards/reso-certification-utils?tab=readme-ov-file#reso-data-dictionary-certification)._ |
20 | 18 |
|
21 | | -**Note**: Data Dictionary testing is now handled by the [**RESO Certification Utils**](https://github.com/RESOStandards/reso-certification-utils) command-line utility. The Commander still works for metadata validation, but will be retired in the near future and the new tools merged into this repository. |
22 | | - |
23 | | -## [Command-Line OData Web API Tools](/doc/CLI.md) |
| 19 | +# Command-Line OData Web API Tools |
24 | 20 | The RESO Commander contains command line tools for working with OData Web APIs. |
25 | 21 | This section covers how to validate metadata, make requests, and generate sample requests for testing. |
26 | 22 |
|
27 | | -## [Web API Client Library](/doc/ODataClient.md) |
| 23 | +[**MORE INFO**](/doc/CLI.md) |
| 24 | + |
| 25 | +# Web API Client Library |
28 | 26 | The RESO Commander offers a convenient wrapper around the Apache Olingo Java client for OData, |
29 | 27 | with added support for OAuth2 Bearer Tokens and Client Credentials. |
30 | 28 |
|
31 | 29 | The client library can be used to fetch and validate metadata, fetch data, and perform other |
32 | 30 | OData client tasks. |
33 | 31 |
|
34 | | -## [Docker](/doc/Docker.md) |
| 32 | +[**MORE INFO**]((/doc/ODataClient.md)) |
| 33 | + |
| 34 | +# Docker |
35 | 35 | For those who prefer Docker, both the Command Line and Automated Testing Tools can be |
36 | 36 | run in a Docker container. |
37 | 37 |
|
38 | | -## [Codegen](/doc/Codegen.md) |
| 38 | +[**MORE INFO**](/doc/Docker.md) |
| 39 | + |
| 40 | +# Codegen |
39 | 41 | The RESO Commander may also be used to generate reference XML Metadata, DDL, database seeds, |
40 | 42 | automated acceptance tests, reference server models, and to convert XML Metadata to Open API 3 format. |
| 43 | + |
| 44 | +[**MORE INFO**](/doc/Codegen.md) |
| 45 | + |
| 46 | +--- |
| 47 | + |
| 48 | +[**Questions? Contact RESO**](mailto:dev@reso.org) |
0 commit comments