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

[Do not merge] RHIROS-502 api_version endpoint #363

Conversation

srdeotarse
Copy link
Contributor

api_version endpoint 💥

RHIROS-502 [BE] | API Version Endpoint

Add api_version endpoint to return reponse -

branch:
commit_sha:
commit_timestamp:
api_version:
deployed_at: 

Endpoint: 

/api/ros/v1/api_version

Feel free to remove this section from PR description once done.

Why do we need this change? 💭

Please include the context of this change here.

Documentation update? 📝

  • Yes
  • No

Security Checklist 🔒

Upon raising this PR please go through RedHatInsights/secure-coding-checklist

💂‍♂️ Checklist 🎯

  • Bugfix
  • New Feature
  • Refactor
  • Unittests Added
  • DRY code
  • Dependency Added
  • DB Migration Added

Additional 📣

Feel free to add any other relevant details such as links, notes, screenshots, here.

@srdeotarse srdeotarse changed the title RHIROS-502 api_version endpoint [Do not merge] RHIROS-502 api_version endpoint Sep 14, 2023
@srdeotarse srdeotarse force-pushed the RHIROS-502-API-version-endpoint branch 3 times, most recently from 3335e1a to 65dd21d Compare September 14, 2023 07:06
@codecov-commenter
Copy link

codecov-commenter commented Sep 14, 2023

Codecov Report

Attention: 4 lines in your changes are missing coverage. Please review.

Files Coverage Δ
ros/api/routes.py 100.00% <100.00%> (ø)
ros/lib/config.py 52.06% <100.00%> (+0.39%) ⬆️
ros/api/v1/api_deployment_version.py 66.66% <66.66%> (ø)

📢 Thoughts on this report? Let us know!.

clowdapp.yaml Outdated Show resolved Hide resolved
ros/api/v1/api_version.py Outdated Show resolved Hide resolved
api.add_resource(OpenAPISpec, f'/api/ros/{API_VERSION}/openapi.json')
api.add_resource(CallToActionApi, f'/api/ros/{API_VERSION}/call_to_action')
api.add_resource(ExecutiveReportAPI, f'/api/ros/{API_VERSION}/executive_report')
api.add_resource(ApiVersion, f'/api/ros/{API_VERSION}/api_version')
Copy link
Contributor

@saltgen saltgen Sep 14, 2023

Choose a reason for hiding this comment

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

@kgaikwad Would like to know your thoughts on global value for API_VERSION.
Do you see this becoming a challenge if endpoints get versioned differently in future?

@srdeotarse srdeotarse force-pushed the RHIROS-502-API-version-endpoint branch from 6953e8a to 1b7fdfe Compare September 15, 2023 04:20
clowdapp.yaml Outdated Show resolved Hide resolved
@srdeotarse srdeotarse force-pushed the RHIROS-502-API-version-endpoint branch 6 times, most recently from d0d7538 to a5b7fda Compare September 19, 2023 07:56
pyproject.toml Outdated Show resolved Hide resolved
@srdeotarse srdeotarse force-pushed the RHIROS-502-API-version-endpoint branch 2 times, most recently from 5c1c7bb to 74abe35 Compare September 21, 2023 05:02
ros/api/v1/api_deployment_version.py Outdated Show resolved Hide resolved
@@ -157,3 +157,4 @@ def build_endpoint_url(ep):
CW_LOGGING_FORMAT = '%(asctime)s - %(levelname)s - %(funcName)s - %(message)s'
ROS_PROCESSOR_PORT = int(os.getenv("ROS_PROCESSOR_PORT", "8000"))
ROS_API_PORT = int(os.getenv("ROS_API_PORT", "8000"))
API_VERSION = 'v1'
Copy link
Contributor

Choose a reason for hiding this comment

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

In future we may get more than one api version and both could be supported? can we depend on api paths maybe to get verion and actually show all deployed api versions?

@r14chandra
Copy link
Contributor

\retest

@srdeotarse srdeotarse force-pushed the RHIROS-502-API-version-endpoint branch 2 times, most recently from 554b516 to d12e5bf Compare October 4, 2023 06:18
Copy link
Collaborator

@kgaikwad kgaikwad left a comment

Choose a reason for hiding this comment

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

@srdeotarse - PR facing few conflicts. Please have a look.

@srdeotarse srdeotarse force-pushed the RHIROS-502-API-version-endpoint branch from 0131433 to 5d43fda Compare November 28, 2023 10:23
@kgaikwad kgaikwad added the STALE Pull requests are too old and no new updates on it since long period label Jun 11, 2024
@kgaikwad
Copy link
Collaborator

kgaikwad commented Jul 5, 2024

Closing this PR as I don't not see any pr updates since long time.

@kgaikwad kgaikwad closed this Jul 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Do not merge STALE Pull requests are too old and no new updates on it since long period
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants