HSDA Utility¶
The HSDA utility protocol is defined by openapi-hsda-utility.yaml. The details below show the available methods and responses.
You can also explore this using our OpenAPI viewer.
Warning
This is an experimental feature. Feedback is welcome to shape its further development.
- GET /services/¶
Services
The services being used across ochestration.
- Status Codes
200 OK – Service Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response
200 Response Body:
Description |
Type |
Required |
|
|---|---|---|---|
id |
|||
Each entry must have a unique identifier. |
string |
True |
|
name |
|||
The service name. |
string |
True |
|
path |
|||
The path name. |
string |
True |
|
verb |
|||
The verb. |
string |
True |
|
- GET /schema/build/¶
Schema Build
This will generate static files for all definitions in OpenAPIs
- Status Codes
200 OK – Schema Build Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response
200 Response Body:
Description |
Type |
Required |
|
|---|---|---|---|
service |
|||
The service of the schema |
string |
False |
|
definition |
|||
The definition of the schema. |
string |
False |
|
file |
|||
The file name being created. |
string |
False |
|
- POST /validate/hsda/definition/¶
Validate HSDA Response
Validate HSDA Response
- Query Parameters
name (string) – The name of the service which is being validated.
path (string) – The path which is being validated.
verb (string) – The verb which is being validated.
- Status Codes
200 OK – Validate HSDA Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response
200 Response Body:
Description |
Type |
Required |
|
|---|---|---|---|
id |
|||
Each validation has a unique id. |
string |
True |
|
service |
|||
The service that is being validated. |
string |
True |
|
path |
|||
The path that is being validated. |
string |
True |
|
verb |
|||
The verb that is being validated. |
string |
True |
|
valid |
|||
Whether or not the schema was valid. |
boolean |
False |
|
message |
|||
A message describing the validation. |
string |
False |
|
- POST /validate/hsda/openapi/¶
Validate HSDA OpenAPI
Validate HSDA OpenAPI
- Status Codes
200 OK – Validate HSDA OpenAPI Response
403 Forbidden – No Access Response
500 Internal Server Error – Error Response
200 Response Body:
Description |
Type |
Required |
|
|---|---|---|---|
id |
|||
Each validation has a unique id. |
string |
True |
|
service |
|||
The service that is being validated. |
string |
True |
|
valid |
|||
Whether or not the schema was valid. |
boolean |
False |
|
message |
|||
A message describing the validation. |
string |
False |
|