search

bcgov / TheOrgBook

A public repository of verifiable claims about organizations. A key component of the Verifiable Organization Network.
http://von.pathfinder.gov.bc.ca
Apache License 2.0
78 stars 66 forks source link

Mismatch between Swagger docs and API response #815

Closed ianco closed 5 years ago

ianco commented 5 years ago

From the Cannabis team (Moffat.Sehudi@quartech.com)

Hi Ian, I have generated an Http client from the swagger exposed by https://www.orgbook.gov.bc.ca/api/v2/. The problem is the swagger seems outdated as the response I am getting is a single record instead of the collection the swagger specifies. This causes an error in the generated client. I was using this endpoint: /v2/topic/ident/{type}/{source_id}/formatted Please advise on how to proceed. Thanks, --Moffat

URL: https://www.orgbook.gov.bc.ca/api/v2/topic/ident/registration/BC1165060/formatted

WadeBarnes commented 5 years ago

This issue was likely do to the age of the code in prod at the time, it was 4 months old. I transferred the prod URLs over to our mirror earlier this week and upgraded prod yesterday before starting the data reload.

If you try this again, currently, it will work, but the response will be from our mirror connected to the prod.bcovrin.vonx.io provisional ledger. The data reload should be complete some time tomorrow after which I'll be transferring the prod URLs back.

WadeBarnes commented 5 years ago

We're live again. prod URLs are pointing to the production site and ledger.

ianco commented 5 years ago

I checked the specific API that Moffat reported and it looks like the swagger is still wrong.

WadeBarnes commented 5 years ago

Updates deployed to dev; https://dev.orgbook.gov.bc.ca/api/

@ianco, @andrewwhitehead, Please review.

WadeBarnes commented 5 years ago

PR #825 fixes the API routes that were inadvertently changed by the previous updates.

WadeBarnes commented 5 years ago

@msehudi, Could you have a look and see if these updates have addressed your issue?

https://dev.orgbook.gov.bc.ca

msehudi commented 5 years ago

Hi Wade, I have not had a chance to regenerate the client. I'll give you an update when I regenerate it sometime next week.

Thanks, --Moffat

On Fri, Jul 5, 2019 at 9:55 AM Wade Barnes notifications@github.com wrote:

@msehudi https://github.com/msehudi, Could you have a look and see if these updates have addressed your issue?

https://dev.orgbook.gov.bc.ca

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/bcgov/TheOrgBook/issues/815?email_source=notifications&email_token=AAGNWUKODNXRML2C25JYNYDP554HDA5CNFSM4H2ZIQU2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODZJ6OUY#issuecomment-508815187, or mute the thread https://github.com/notifications/unsubscribe-auth/AAGNWUIQI73FTAOZZT257DLP554HDANCNFSM4H2ZIQUQ .

--

Moffat