Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
docs.it4i.cz
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
SCS
docs.it4i.cz
Commits
16af92a6
Commit
16af92a6
authored
3 months ago
by
Jan Siwiec
Browse files
Options
Downloads
Patches
Plain Diff
Update 2 files
- /docs.it4i/apiv2.md - /mkdocs.yml
parent
3495a554
No related branches found
No related tags found
1 merge request
!491
Update 2 files
Pipeline
#43741
failed
3 months ago
Stage: test
Stage: build
Stage: deploy
Stage: after_test
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
docs.it4i/apiv2.md
+203
-0
203 additions, 0 deletions
docs.it4i/apiv2.md
mkdocs.yml
+1
-1
1 addition, 1 deletion
mkdocs.yml
with
204 additions
and
1 deletion
docs.it4i/apiv2.md
0 → 100644
+
203
−
0
View file @
16af92a6
# SCS API v2
## Info
-
**OpenAPI:**
3.1.0
-
**Title:**
scs-api-2
-
**Version:**
0.1.0
-
**Server URL:**
`https://scs.it4i.cz/api/v2`
## Paths
### `/dedicated-time`
#### GET
-
**Summary:**
Get dedicated times
-
**Description:**
Retrieves dedicated time entries, optionally filtered by cluster name or period preset
-
**OperationId:**
`dedicated_time_handler`
**Parameters:**
-
`cluster`
(query): Filter by cluster name; Available values: karolina, barbora, dgx
*(optional)*
-
`period`
(query): Filter by time period preset; Available values: planned, active
*(optional)*
**Responses:**
-
`200`
: List of dedicated time entries
-
`400`
: Failed to deserialize query, Invalid cluster, Invalid period
Example:
```
json
{
"message"
:
"Invalid cluster: el_gordo"
}
```
-
`500`
: Failed to retrieve dedicated time due to a server error
Example:
```
json
{
"message"
:
"Failed to retreive dedicated time"
}
```
### `/dedicated-time-calendar`
#### GET
-
**Summary:**
Get dedicated times
-
**Description:**
Retrieves dedicated time entries and generates a VCalendar response.
-
**OperationId:**
`dedicated_time_calendar`
**Responses:**
-
`200`
: Dedicated time VCalendar
Example:
```
BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//SUTD Timetable Calendar//randName//EN
CALSCALE:GREGORIAN
BEGIN:VEVENT
UID:1234@example.com
DTSTAMP:20230101T000000Z
DTSTART:20230101T000000Z
DTEND:20230102T000000Z
SUMMARY:Sample Dedicated Time - Cluster Outage
DESCRIPTION:Sample Dedicated Time - Cluster Outage
END:VEVENT
END:VCALENDAR
```
-
`500`
: Failed to retrieve dedicated time calendar
Example:
```
json
{
"message"
:
"Failed to retreive dedicated time calendar"
}
```
### `/motd`
#### GET
-
**Summary:**
Get messages of the day
-
**Description:**
Retrieves messages of the day, optionally filtered by category
-
**OperationId:**
`motd`
**Parameters:**
-
`category`
(query):
*(optional)*
**Responses:**
-
`200`
: List of motd entries
-
`400`
: Failed to deserialize query, Invalid motd category
-
`500`
: Failed to retrieve motd entries due to a server error
Example:
```
json
{
"message"
:
"Failed to retrieve motd"
}
```
## Components
### Schemas
#### DedicatedTime
```
yaml
type
:
object
required
:
-
updated_at
properties
:
cluster_type
:
type
:
[
string
,
'
null'
]
date_efficiency
:
type
:
[
string
,
'
null'
]
format
:
date-time
date_expiration
:
type
:
[
string
,
'
null'
]
format
:
date-time
updated_at
:
type
:
string
format
:
date-time
```
#### Motd
```
yaml
type
:
object
required
:
-
id
-
author
-
category
-
created_at
-
updated_at
-
date_modification
-
title
-
message_body
-
systems
properties
:
id
:
type
:
integer
format
:
int32
examples
:
[
1
]
author
:
type
:
string
examples
:
[
Admin
]
category
:
type
:
string
examples
:
[
public-service-announcement
]
created_at
:
type
:
string
format
:
date-time
updated_at
:
type
:
string
format
:
date-time
date_modification
:
type
:
string
format
:
date-time
date_efficiency
:
type
:
[
string
,
'
null'
]
format
:
date-time
date_expiration
:
type
:
[
string
,
'
null'
]
format
:
date-time
date_outage_efficiency
:
type
:
[
string
,
'
null'
]
format
:
date-time
date_outage_expiration
:
type
:
[
string
,
'
null'
]
format
:
date-time
title
:
type
:
string
examples
:
[
Important Update
]
message_body
:
type
:
string
examples
:
[
We are experiencing some service disruptions.
]
systems
:
type
:
array
items
:
type
:
string
examples
:
[
Karolina
]
```
#### MsgResponse
```
yaml
type
:
object
description
:
|
Common struct for DTO-less responses
eg. ```200 {"message":"Operation succeeded"}```
required
:
-
message
properties
:
message
:
type
:
string
examples
:
[
API response
]
```
This diff is collapsed.
Click to expand it.
mkdocs.yml
+
1
−
1
View file @
16af92a6
...
@@ -123,7 +123,7 @@ nav:
...
@@ -123,7 +123,7 @@ nav:
-
OpenSSH Keys (UNIX)
:
general/accessing-the-clusters/shell-access-and-data-transfer/ssh-keys.md
-
OpenSSH Keys (UNIX)
:
general/accessing-the-clusters/shell-access-and-data-transfer/ssh-keys.md
-
PuTTY (Windows)
:
general/accessing-the-clusters/shell-access-and-data-transfer/putty.md
-
PuTTY (Windows)
:
general/accessing-the-clusters/shell-access-and-data-transfer/putty.md
-
Certificates FAQ
:
general/obtaining-login-credentials/certificates-faq.md
-
Certificates FAQ
:
general/obtaining-login-credentials/certificates-faq.md
-
API Documentation
:
apiv
1
.md
-
API Documentation
:
apiv
2
.md
-
Satisfaction and Feedback
:
general/feedback.md
-
Satisfaction and Feedback
:
general/feedback.md
-
Energy Saving
:
general/energy.md
-
Energy Saving
:
general/energy.md
-
DICE
:
dice.md
-
DICE
:
dice.md
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment