question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Document the soft-deprecated endpoint

See original GitHub issue

https://github.com/yuvipanda/nbresuse/pull/68 switches the main endpoint to /api/metrics/v1, but keeps the original /metrics under a flag.

This should be documented, for example in a new CHANGELOG.md.

Also previous releases of JupyterLab 1.x and 2.x include a status bar item that requests metrics from the deprecated /metrics endpoint. It can be tricky to understand which versions of lab and nbresuse are compatible. However https://github.com/yuvipanda/nbresuse/pull/69 should help with this in the long run.

This is less problematic for classic notebook users since the frontend ships with nbresuse (https://github.com/yuvipanda/nbresuse/pull/69 would do the same for the lab frontend)

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

1reaction
Gsbreddycommented, Nov 20, 2020

Sure thing. Let me do that and get back to you. On Fri, 20 Nov 2020 at 3:08 PM, Jeremy Tuloup notifications@github.com wrote:

Thanks a lot @Gsbreddy https://github.com/Gsbreddy!

Would you like to open a PR to create CHANGELOG.md with this content?

Also we’ll probably want to:

  • Sort in descending order
  • Include 0.3.5 and 0.3.6 too

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/yuvipanda/nbresuse/issues/70#issuecomment-731058377, or unsubscribe https://github.com/notifications/unsubscribe-auth/AB26ANN3HTIBARXRWDMV373SQY2HPANCNFSM4T3X737A .

0reactions
Gsbreddycommented, Nov 24, 2020
Read more comments on GitHub >

github_iconTop Results From Across the Web

Deprecating API Endpoints - Stoplight Blog
There are a few common approaches that API producers use to let API consumers know change is coming. Documentation - Make sure no...
Read more >
API Best Practices for Feature Deprecation | Moesif Blog
Deprecating endpoints and API features requires careful planning to avoid upsetting customers.
Read more >
How do I resolve "Deprecated endpoint called..." when ... - IBM
When making one of the REST API calls listed below, using ICM 10 on-premise, the error "deprecated endpoint called" appears in the Tenant ......
Read more >
How and When to Deprecate APIs - Oracle Help Center
The compiler suppresses deprecation warnings if a deprecated item is used within an entity which itself is deprecated or is used within the...
Read more >
API Best Practices for Feature Deprecation - DZone Integration
What are the steps you can take to deprecate your endpoints and API features without upsetting your customers.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found