OpenAPI specs - Open links in new tab

bcgov / DBC-APIM

DataBC OPEN API Services

Apache License 2.0

1 stars 0 forks source link

OpenAPI specs - Open links in new tab #32

Closed BK01 closed 7 years ago

BK01 commented 7 years ago

Skills / SW:

OpenAPI spec (swagger 2.0)

Description:

Fork OpenAPI specs located at the following repo. https://github.com/bcgov/api-specs
Edit hyperlinks to open in a new tab. Currently the links below result in an error (scroll bar expands continuously) instead of opening the link in a new tab.

OpenAPI specs impacted:

Geomark: Links: see more at open gov license

BCGNWS: Links: Crown copyright

BCLaws: Links: Queens printer license

Geocoder: Links: see more at open gov license

BCDC data api: Links: hyperlinks in description section see more at open gov license

Deliverables:

Pull request submitted for a new version of all OpenAPI specs

BK01 commented 7 years ago

@ll911 @banders Browser used for OpenAPI console UAT - Chrome

banders commented 7 years ago

@BK01 I don't think this problem can be solved just by modifying the API spec files -- it requires a change to swagger-ui.

There is an existing issue in the swagger-ui project, but it doesn't look like there's been any work on it yet.

banders commented 7 years ago

I have updated swagger-ui to use target=blank for all links displayed in the "Info" section (between the API title and the list of operations).

I have made a custom build of swagger-ui which incorporates this change, and I have embedded the custom build into ckanext-openapiviewer. The pull request is here.

BK01 commented 7 years ago

@ll911 @banders Successful UAT complete using geocoder console in cad.data. Ready to migrate to TEST.

BK01 commented 7 years ago

@BK01 to review this week

BK01 commented 7 years ago

UAT complete in cat.data... Ready for PROD.

BK01 commented 7 years ago

Ready to migrate to PROD.