Skip to content

Commit

Permalink
move parameters out of operations into paths
Browse files Browse the repository at this point in the history
  • Loading branch information
gbicann committed Feb 13, 2024
1 parent 2f1e2c5 commit 5dd57f3
Showing 1 changed file with 39 additions and 111 deletions.
150 changes: 39 additions & 111 deletions rst-api-spec.yaml.in
Original file line number Diff line number Diff line change
Expand Up @@ -480,6 +480,25 @@ paths:
#endif

/table/{rsp}/{tag}/{version}:
parameters:
- name: rsp
description: the RSP ID.
in: path
required: true
schema:
type: string
- name: tag
description: the language tag.
in: path
required: true
schema:
type: string
- name: version
description: the version.
in: path
required: true
schema:
type: string

#ifeq VIEW INTERNAL
put:
Expand All @@ -492,25 +511,6 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/idnTable"
parameters:
- name: rsp
description: the RSP ID.
in: path
required: true
schema:
type: string
- name: tag
description: the language tag.
in: path
required: true
schema:
type: string
- name: version
description: the version.
in: path
required: true
schema:
type: string
responses:
'201':
description: A successful result.
Expand All @@ -525,26 +525,6 @@ paths:

External users can only access IDN tables that are linked to test
objects associated with their credentials.

parameters:
- name: rsp
description: the RSP ID.
in: path
required: true
schema:
type: string
- name: tag
description: the language tag.
in: path
required: true
schema:
type: string
- name: version
description: the version.
in: path
required: true
schema:
type: string
responses:
'200':
description: A successful result.
Expand All @@ -559,25 +539,6 @@ paths:
- IDN table management
operationId: deleteIDNTable
description: This operation deletes an IDN table object.
parameters:
- name: rsp
description: the RSP ID.
in: path
required: true
schema:
type: string
- name: tag
description: the language tag.
in: path
required: true
schema:
type: string
- name: version
description: the version.
in: path
required: true
schema:
type: string
responses:
'201':
description: A successful result.
Expand All @@ -593,19 +554,6 @@ paths:
description: |
This operation returns the IDN tables matching the provided query
parameters.
parameters:
- name: rsp
description: the RSP ID.
in: query
required: true
schema:
type: string
- name: tag
description: the language tag.
in: query
required: false
schema:
type: string
responses:
'200':
description: A successful result.
Expand All @@ -618,6 +566,25 @@ paths:
#endif

/table/{rsp}/{tag}/{version}/labels:
parameters:
- name: rsp
description: the RSP ID.
in: path
required: true
schema:
type: string
- name: tag
description: the language tag.
in: path
required: true
schema:
type: string
- name: version
description: the version
in: path
required: true
schema:
type: string

#ifeq VIEW INTERNAL
post:
Expand All @@ -627,20 +594,6 @@ paths:
description: |
This operation adds a new `idnTestLabels` object for the IDN table
identified by the `{rsp, tag, version}` triple.

parameters:
- name: rsp
description: the RSP ID.
in: query
required: true
schema:
type: string
- name: tag
description: the language tag.
in: query
required: false
schema:
type: string
requestBody:
content:
application/json:
Expand All @@ -649,26 +602,14 @@ paths:
responses:
'201':
description: A successful result.

put:
tags:
- IDN table management
operationId: updateIDNTestLabels
description: |
This operation updates an existing `idnTestLabels` object for the IDN
table identified by the `{rsp, tag, version}` triple.
parameters:
- name: rsp
description: the RSP ID.
in: query
required: true
schema:
type: string
- name: tag
description: the language tag.
in: query
required: false
schema:
type: string
requestBody:
content:
application/json:
Expand All @@ -689,19 +630,6 @@ paths:

External users can only access test label lists that are linked to IDN
tables that are linked test objects associated with their credentials.
parameters:
- name: rsp
description: the RSP ID.
in: query
required: true
schema:
type: string
- name: tag
description: the language tag.
in: query
required: false
schema:
type: string
responses:
'200':
description: A successful result.
Expand Down

0 comments on commit 5dd57f3

Please sign in to comment.