Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 32 additions & 23 deletions rst-api-spec.yaml.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,22 @@ openapi: 3.0.3
#define INTERNAL_USER_ACCESS_CONTROL_POLICY Internal users can perform this operation on any object.

tags:
- name: Checking that the server is up
- name: Creating test request objects
- name: Providing input parameters & files
- name: Retrieving test information
- name: Starting test runs
- name: Test administration
- name: IDN table management
- name: testCreation
description: Creating test request objects.
- name: testConfiguration
description: Providing input parameters and files.
- name: testInformation
description: Retrieving test information.
- name: testRuns
description: Starting and reviewing test runs.
- name: testAdministration
description: Test administration.
- name: idnTableManagement
description: IDN table management.
- name: serverStatus
description: Checking that the server is up.
- name: testResources
description: Test resources.

info:
version: #include tmp/version.txt
Expand Down Expand Up @@ -101,7 +110,7 @@ paths:
/v1/heartbeat:
get:
tags:
- Checking that the server is up
- serverStatus
description: |
This operation can be used to determine if the server is up.

Expand All @@ -116,7 +125,7 @@ paths:
/v1/test:
post:
tags:
- Creating test request objects
- testCreation
description: |
This operation creates a new test request object.

Expand Down Expand Up @@ -154,7 +163,7 @@ paths:
type: string
get:
tags:
- Retrieving test information
- testInformation
description: |
This operation returns information about a specific test request object.

Expand All @@ -174,7 +183,7 @@ paths:
/v1/test/{id}/inputs:
post:
tags:
- Providing input parameters & files
- testConfiguration
description: |
This operation submits test input parameters. Parameters in the payload
will previously submitted values. Values that are present in the object
Expand Down Expand Up @@ -212,7 +221,7 @@ paths:
/v1/test/{id}/files:
post:
tags:
- Providing input parameters & files
- testConfiguration
description: |
This resource may be used to upload files. Multiple files may
be uploaded in a single request. If a filename matches a previously
Expand Down Expand Up @@ -251,7 +260,7 @@ paths:
/v1/test/{id}/file/{file}:
get:
tags:
- Retrieving test information
- testInformation
description: |
This retrieves an uploaded file.

Expand Down Expand Up @@ -292,7 +301,7 @@ paths:
type: string
post:
tags:
- Starting test runs
- testRuns
operationId: startTestRun
description: |
This operation asks the test system to start a new test run. If test
Expand All @@ -319,7 +328,7 @@ paths:
type: string
get:
tags:
- Retrieving test information
- testRuns
operationId: getTestRun
description: This operation retrieves details of a test run.
responses:
Expand All @@ -341,7 +350,7 @@ paths:
type: string
post:
tags:
- Test administration
- testAdministration
operationId: setTestResult
description: |
**Internal users only**
Expand Down Expand Up @@ -371,7 +380,7 @@ paths:
/v1/tests:
get:
tags:
- Retrieving test information
- testInformation
description: |
This operation performs a search on the database and returns all
matching results.
Expand Down Expand Up @@ -429,7 +438,7 @@ paths:
/v1/table:
post:
tags:
- IDN table management
- idnTableManagement
operationId: createIDNTable
description: |
This operation creates a new IDN table object.
Expand Down Expand Up @@ -467,7 +476,7 @@ paths:

get:
tags:
- IDN table management
- idnTableManagement
operationId: getIDNTable
description: |
This operation returns information about an IDN table object.
Expand All @@ -487,7 +496,7 @@ paths:

put:
tags:
- IDN table management
- idnTableManagement
operationId: updateIDNTable
description: |
This operation updates an existing IDN table object.
Expand All @@ -509,7 +518,7 @@ paths:

delete:
tags:
- IDN table management
- idnTableManagement
operationId: deleteIDNTable
description: |
This operation deletes an IDN table object.
Expand All @@ -528,7 +537,7 @@ paths:
/v1/tables:
get:
tags:
- IDN table management
- idnTableManagement
operationId: getIDNTables
description: |
This operation returns the IDN tables matching the provided query
Expand Down Expand Up @@ -566,7 +575,7 @@ paths:
/v1/resource/{file}:
get:
tags:
- Providing input parameters & files
- testResources
operationId: getResource
description: |
This endpoint allows users to download [resources](https://icann.github.io/rst-test-specs/rst-test-specs.html#resources)
Expand Down