Skip to content

Adds missing model snapshot parameters and descriptions #1028

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 17, 2021
Merged

Adds missing model snapshot parameters and descriptions #1028

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce5ac67
Edits ML get model snapshot API
lcawl Nov 17, 2021
7783b28
Removes default value
lcawl Nov 17, 2021
bc12964
Makes contrib
lcawl Nov 17, 2021
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
49 changes: 44 additions & 5 deletions output/schema/schema.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 4 additions & 1 deletion output/typescript/types.ts
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

26 changes: 20 additions & 6 deletions specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
* under the License.
*/

import { Page } from '@ml/_types/Page'
import { RequestBase } from '@_types/Base'
import { Field, Id } from '@_types/common'
import { integer } from '@_types/Numeric'
Expand All @@ -36,13 +37,16 @@ export interface Request extends RequestBase {
*/
job_id: Id
/**
* A numerical character string that uniquely identifies the model snapshot.
* A numerical character string that uniquely identifies the model snapshot. You can get information for multiple
* snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`,
* by specifying `*` as the snapshot ID, or by omitting the snapshot ID.
*/
snapshot_id?: Id
}
query_parameters: {
/**
* If true, the results are sorted in descending order.
* @server_default false
*/
desc?: boolean
/**
Expand All @@ -51,10 +55,12 @@ export interface Request extends RequestBase {
end?: Time
/**
* Skips the specified number of snapshots.
* @server_default 0
*/
from?: integer
/**
* Specifies the maximum number of snapshots to obtain.
* @server_default 100
*/
size?: integer
/**
Expand All @@ -69,14 +75,22 @@ export interface Request extends RequestBase {
}
body: {
/**
* Returns snapshots with timestamps after this time. Defaults to unset,
* which means results are not limited to specific timestamps.
* Refer to the description for the `desc` query parameter.
* @server_default false
*/
start?: Time
desc?: boolean
/**
* Returns snapshots with timestamps earlier than this time. Defaults to
* unset, which means results are not limited to specific timestamps.
* Refer to the description for the `end` query parameter.
*/
end?: Time
page?: Page
/**
* Refer to the description for the `sort` query parameter.
*/
sort?: Field
/**
* Refer to the description for the `start` query parameter.
*/
start?: Time
}
}