docs(tests): document test eval endpoint (#8227)

This commit is contained in:
Aseem Bansal 2023-06-14 19:19:23 +05:30 committed by GitHub
parent 5fc6601d8d
commit 0c22bda209
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 23 additions and 0 deletions

View File

@ -288,6 +288,11 @@ module.exports = {
label: "Restore Indices",
id: "docs/api/restli/restore-indices",
},
{
type: "doc",
label: "Evaluate Tests",
id: "docs/api/restli/evaluate-tests",
},
{
type: "doc",
label: "Aspect Versioning and Rest.li Modeling",

View File

@ -0,0 +1,18 @@
# Evaluate Tests Endpoint
<FeatureAvailability saasOnly />
You can do a HTTP POST request to `/gms/test?action=evaluate` endpoint with the `urn` as part of JSON Payload to run metadata tests for the particular URN.
```
curl --location --request POST 'https://DOMAIN.acryl.io/gms/test?action=evaluate' \
--header 'Authorization: Bearer TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"urn": "YOUR_URN"
}'
```
w
The supported parameters are
- `urn` - Required URN string
- `shouldPush` - Optional Boolean - whether or not to push the results to persist them
- `testUrns` - Optional List of string - If you wish to get specific test URNs evaluated