Skip to content
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.

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

docs: Mark APIs internal (ET-694) #9933

Merged

Conversation

jesse-amano-hpe
Copy link
Contributor

@jesse-amano-hpe jesse-amano-hpe commented Sep 16, 2024

Ticket

ET-694

Description

In our audit of experiment tracking related APIs and how they're used, we found that these endpoints should be marked as internal in our docs, and will not have "run-centric" equivalents.

Test Plan

Generated Swagger docs show these endpoints as internal

GET /api/v1/experiments/{id}/file_tree
GET /api/v1/experiments/{id}/model_def
GET /api/v1/experiments/{id}/validation-history
POST /api/v1/preview-hp-search
GET /api/v1/trials/time-series
GET /api/v1/trials/{id}/logs/fields
GET /experiments/{id}/file/download (note there isn’t even a /api/v1 prefix)

Checklist

  • Changes have been manually QA'd
  • New features have been approved by the corresponding PM
  • User-facing API changes have the "User-facing API Change" label
  • Release notes have been added as a separate file under docs/release-notes/
    See Release Note for details.
  • Licenses have been included for new code which was copied and/or modified from any external code

@jesse-amano-hpe jesse-amano-hpe requested a review from a team as a code owner September 16, 2024 03:37
@jesse-amano-hpe jesse-amano-hpe requested review from amandavialva01 and removed request for a team September 16, 2024 03:37
@cla-bot cla-bot bot added the cla-signed label Sep 16, 2024
@jesse-amano-hpe jesse-amano-hpe force-pushed the feature/ET-684/run-centric-api branch 2 times, most recently from 2265d5f to 13db674 Compare September 17, 2024 16:49
Copy link
Contributor

@corban-beaird corban-beaird left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great Work!

@jesse-amano-hpe jesse-amano-hpe changed the title Mark APIs internal (ET-694) docs: Mark APIs internal (ET-694) Sep 19, 2024
Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 49.48%. Comparing base (13db674) to head (700fdd1).
Report is 1 commits behind head on feature/ET-684/run-centric-api.

Additional details and impacted files
@@                        Coverage Diff                         @@
##           feature/ET-684/run-centric-api    #9933      +/-   ##
==================================================================
- Coverage                           54.51%   49.48%   -5.04%     
==================================================================
  Files                                1252     1078     -174     
  Lines                              156668   141538   -15130     
  Branches                             3600     3601       +1     
==================================================================
- Hits                                85410    70034   -15376     
- Misses                              71125    71371     +246     
  Partials                              133      133              
Flag Coverage Δ
harness 40.30% <ø> (-32.45%) ⬇️
web 54.27% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
master/internal/core_experiment.go 61.73% <ø> (ø)

... and 264 files with indirect coverage changes

@jesse-amano-hpe jesse-amano-hpe merged commit 904fb1f into feature/ET-684/run-centric-api Sep 19, 2024
9 of 10 checks passed
@jesse-amano-hpe jesse-amano-hpe deleted the jta/ET-694-mark-apis-internal branch September 19, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants