-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): add more logstf documentation, fix labeler (#9)
- Loading branch information
Showing
4 changed files
with
68 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,15 +1,15 @@ | ||
sdk: | ||
- changed-files: | ||
- any-glob-to-any-file: javscript_sdk/** | ||
- any-glob-to-any-file: ["javscript-sdk/**"] | ||
logstf: | ||
- changed-files: | ||
- any-glob-to-any-file: logstf/** | ||
- any-glob-to-any-file: "**/logstf/**" | ||
etf2l: | ||
- changed-files: | ||
- any-glob-to-any-file: etf2l/** | ||
- any-glob-to-any-file: "**etf2l/**" | ||
rgl: | ||
- changed-files: | ||
- any-glob-to-any-file: rgl/** | ||
- any-glob-to-any-file: "**/rgl/**" | ||
demostf: | ||
- changed-files: | ||
- any-glob-to-any-file: demostf/** | ||
- any-glob-to-any-file: "**/demostf/**" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,33 @@ | ||
/** | ||
* The request to search for logs | ||
*/ | ||
export type LogSearchRequest = { | ||
/** | ||
* The title of the log | ||
*/ | ||
title: string | null; | ||
|
||
/** | ||
* The map of the log | ||
*/ | ||
map: string | null; | ||
|
||
/** | ||
* The steamid of the uploader | ||
*/ | ||
uploader: string | null; | ||
/** | ||
* The list of steamids that played in the log | ||
*/ | ||
player: string[] | null; | ||
|
||
/** | ||
* The number of entries to return | ||
*/ | ||
limit: number; | ||
|
||
/** | ||
* The number of entries to skip | ||
*/ | ||
offset: number; | ||
}; |
18 changes: 18 additions & 0 deletions
18
javascript-sdk/logstf/types/endpoints/logUploadResponse.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,24 @@ | ||
/** | ||
* The response to an upload request | ||
*/ | ||
export type LogUploadResponse = { | ||
/** | ||
* A flag that determines whether the request was successful | ||
*/ | ||
success: boolean; | ||
|
||
/** | ||
* The error of the request | ||
*/ | ||
error: string; | ||
|
||
/** | ||
* The unique id of the created log | ||
*/ | ||
log_id: string; | ||
|
||
/** | ||
* The URL of the uploaded log | ||
*/ | ||
url: string; | ||
}; |