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

API versioning #481

Open
3 tasks
isabelcosta opened this issue Mar 5, 2020 · 11 comments
Open
3 tasks

API versioning #481

isabelcosta opened this issue Mar 5, 2020 · 11 comments
Labels
Category: Outreach/Research Changes or improvements related to external research of the app. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Enhancement New feature or request.

Comments

@isabelcosta
Copy link
Member

Description

Add versioning to backend API, so endpoints URL contains v1 as a part of the path. Make sure we can keep backward compatibility, so endpoints determinate which code is called for v1 and next versions (keeping in different folders or adding parameter or any other idea).

initially brought up by @annabauza

Before implementing this I think it's important to think about this solution, so before submitting a PR for this, please let us know what you intend to do for this.

Flask RESTplus allows using Blueprints: https://flask-restplus.readthedocs.io/en/stable/scaling.html#use-with-blueprints

Acceptance Criteria

Update [Required]

  • Come with a solution to add API versioning to backend

Definition of Done

  • All of the required items are completed.
  • Approval by 1 mentor.

Estimation

3 hours

@isabelcosta isabelcosta added Category: Outreach/Research Changes or improvements related to external research of the app. Type: Enhancement New feature or request. Status: Available Issue was approved and available to claim or abandoned for over 3 days. labels Mar 5, 2020
@pallavisavant
Copy link
Contributor

I have participated in OSH can i take up this ,if its available.Thanks.

@SanketDG
Copy link
Contributor

SanketDG commented Sep 8, 2020

This issue is not part of OSH, but if you are interested enough and want to take a stab at this, we can add the label definitely.

@pallavisavant
Copy link
Contributor

@SanketDG yes i would like to try...lemme see i will do some more research and get back here...Thanks.

@pallavisavant
Copy link
Contributor

This issue is not part of OSH, but if you are interested enough and want to take a stab at this, we can add the label definitely.

I would like to work on this as part of OSH...pls assign it to me ....Thanks.

@vj-codes
Copy link
Member

@pallavisavant any updates?

@pallavisavant pallavisavant removed their assignment Sep 28, 2020
@pallavisavant
Copy link
Contributor

@pallavisavant any updates?

I have unassigned myself,pls feel free to assign it to anyone else,sorry for inconvenience I had got busy with my college work:)

@sanjibansg
Copy link

sanjibansg commented Sep 28, 2020

Do assign the issue to me if available. @vj-codes

@vj-codes
Copy link
Member

Assigning you @Kahanikaar
Happy researching!

@vj-codes vj-codes removed the Status: Available Issue was approved and available to claim or abandoned for over 3 days. label Sep 28, 2020
@devkapilbansal
Copy link
Member

@Kahanikaar what's the status of this issue??

@devkapilbansal
Copy link
Member

@vj-codes I think that this issue is available now as the assignee is not responding. Please update the labels accordingly.

@vj-codes
Copy link
Member

Removing your assignment @Kahanikaar due to inactivity .

@vj-codes vj-codes added Status: Available Issue was approved and available to claim or abandoned for over 3 days. and removed Open Source Hack labels Nov 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category: Outreach/Research Changes or improvements related to external research of the app. Status: Available Issue was approved and available to claim or abandoned for over 3 days. Type: Enhancement New feature or request.
Projects
None yet
Development

No branches or pull requests

6 participants