Aaltronav/dougal-software
1
0
Fork 0
mirror of https://gitlab.com/wgp/dougal/software.git synced 2025-12-06 10:57:07 +00:00
Code Issues Packages Projects Releases Activity

Update API description

Browse Source
This commit is contained in:
D. Berge
2022-05-04 18:13:14 +02:00
parent 6c8515a879
commit d80f44547b
1 changed files with 131 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

132
lib/www/server/spec/openapi.yaml
View File

@@ -1,6 +1,6 @@
openapi: 3.0.0
info:
version: 0.3.0
version: 0.3.1
title: Dougal API
description: >
Public API of the Dougal seismic production & data analysis tool.
@@ -55,6 +55,9 @@ tags:
-
name: log
description: Project events log
-
name: qc
description: Project quality control definition and results
-
name: metadata
description: Project items metadata
@@ -1401,6 +1404,133 @@ paths:
$ref: "#/components/responses/401"
/project/{project}/qc/results:
get:
summary: Get QC results.
tags: [ "qc" ]
security:
- BearerAuthGuest: []
- CookieAuthGuest: []
parameters:
- $ref: "#/components/parameters/Project"
responses:
"200":
description: Project QC results.
content:
application/json:
schema:
type: object
description: |
The returned object is a tree structure of QC tests and their results.
"401":
$ref: "#/components/responses/401"
delete:
summary: Delete all QC results.
tags: [ "qc" ]
security:
- BearerAuthUser: []
- BearerAuthUser: []
parameters:
- $ref: "#/components/parameters/Project"
responses:
"204":
description: |
All QC results for the project have been deleted.
Note that unless the project has been archived, the QCs will be regenerated in the next run of the deferred tasks process.
"401":
$ref: "#/components/responses/401"
/project/{project}/qc/results/accept:
post:
summary: Accept shotpoint QC results.
tags: [ "qc" ]
security:
- BearerAuthUser: []
- BearerAuthUser: []
parameters:
- $ref: "#/components/parameters/Project"
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: integer
description: Event ID of the QC result to mark as accepted.
responses:
"204":
description: |
The QC events referenced in the request body have been marked as accepted. These events will not be exported to Seis+JSON files or derived human-readable reports.
"401":
$ref: "#/components/responses/401"
/project/{project}/qc/results/unaccept:
post:
summary: Unaccept shotpoint QC results.
tags: [ "qc" ]
security:
- BearerAuthUser: []
- BearerAuthUser: []
parameters:
- $ref: "#/components/parameters/Project"
responses:
"204":
description: |
The QC events referenced in the request body are no longer marked as accepted.
"401":
$ref: "#/components/responses/401"
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: integer
description: Event ID of the QC result to no longer mark accepted.
/project/{project}/qc/results/sequence/{sequence}:
get:
summary: Get sequence QC results.
tags: [ "qc" ]
security:
- BearerAuthGuest: []
- CookieAuthGuest: []
parameters:
- $ref: "#/components/parameters/Project"
- $ref: "#/components/parameters/SequenceNumber"
responses:
"200":
description: Sequence QC results.
content:
application/json:
schema:
type: object
description: |
The returned object is a tree structure of QC tests and their results for a specific sequence
"401":
$ref: "#/components/responses/401"
delete:
summary: Delete sequence QC results.
tags: [ "qc" ]
security:
- BearerAuthUser: []
- BearerAuthUser: []
parameters:
- $ref: "#/components/parameters/Project"
- $ref: "#/components/parameters/SequenceNumber"
responses:
"204":
description: |
All QC results for the sequence have been deleted.
Note that unless the project has been archived, the QCs will be regenerated in the next run of the deferred tasks process.
"401":
$ref: "#/components/responses/401"
/project/{project}/configuration/{path}:
get:
summary: Get project configuration data.