Skip to content
This repository has been archived by the owner on Mar 1, 2019. It is now read-only.

Unable to link to tags in docs #299

Closed
Anviking opened this issue Feb 4, 2019 · 2 comments
Closed

Unable to link to tags in docs #299

Anviking opened this issue Feb 4, 2019 · 2 comments
Assignees
Labels
BUG Something isn't working RESTROSPECTIVE ADR needs restrospective session
Milestone

Comments

@Anviking
Copy link
Member

Anviking commented Feb 4, 2019

Release Operating System Cause
next Windows & OSX & Linux) Code v Configuration v Environment v Human v Unknown

Context

Steps to Reproduce

  1. Visit https://input-output-hk.github.io/cardano-wallet/#tag/Info

Expected behavior

The docs load scrolled down to the "Info" section

skarmavbild 2019-02-04 kl 15 53 14

Actual behavior

The page loads at the top of the page.

skarmavbild 2019-02-04 kl 15 53 10


Resolution Plan

cardano-foundation/cardano-wallet#299 (comment)

PR

Number Base
#300 develop
input-output-hk/cardano-sl#4064 develop

QA

Wallet API Docs

Visiting https://input-output-hk.github.io/cardano-wallet/#tag/Info, now loads to the Info section/tag.

Node API Docs

stack exec -- cardano-wallet-server \
                                                              --node-id                    edge                                   \
                                                              --system-start               0                                      \
                                                                                                                                  \
                                                              --topology                   state-integration/topology/edge.json   \
                                                              --configuration-file         test/integration/configuration.yaml    \
                                                                                                                                  \
                                                              --db-path                    state-integration/db                   \
                                                              --wallet-db-path             state-integration/wallet-db            \
                                                              --wallet-rebuild-db                                                 \
                                                                                                                                  \
                                                              --wallet-api-address         127.0.0.1:8090                         \
                                                              --wallet-doc-address         127.0.0.1:8190                         \
                                                              --node-api-address           127.0.0.1:8080                         \
                                                              --node-doc-address           127.0.0.1:8180                         \
                                                                                                                                  \
                                                              --tls-ca-cert                state-integration/tls/edge/ca.crt      \
                                                              --tls-wallet-server-cert     state-integration/tls/edge/server.crt  \
                                                              --tls-wallet-server-key      state-integration/tls/edge/server.key  \
                                                              --tls-node-client-cert       state-integration/tls/edge/client.crt  \
                                                              --tls-node-client-key        state-integration/tls/edge/client.key  \

Visiting https://127.0.0.1:8180/docs/v1/index/#tag/Settings now leads to the Settings tag/section.

cardano-sl

This is also fixed in cardano-sl. Details (similar to above) in the QA section of input-output-hk/cardano-sl#4064.

@Anviking Anviking added the BUG Something isn't working label Feb 4, 2019
@KtorZ
Copy link
Contributor

KtorZ commented Feb 4, 2019

I think this might be caused by the small script that runs to handle relative paths. This completely disregards the fragment part of the URL.

        // Force Strict-URL Routing for assets relative paths
        (function onload() {
            if (!window.location.href.endsWith("/")) {
                window.location.href += "/";
            }
        }());

@KtorZ KtorZ self-assigned this Feb 4, 2019
@KtorZ KtorZ added this to the Cardano 1.5 milestone Feb 4, 2019
iohk-bors bot referenced this issue in input-output-hk/cardano-sl Feb 5, 2019
4064: Preserve query and fragment part of the URI while redirecting for relative paths (swagger doc) r=KtorZ a=Anviking

## Description

<!--- A brief description of this PR and the problem is trying to solve -->

Ported from cardano-wallet c49e93a350e8294a380385258b9232df2d00ac20 to
- lib/src/Pos/Util/Swagger.hs (for the node monitoring api docs)
- wallet/src/Cardano/Wallet/API/V1/Swagger.hs (for the wallet docs)

### Todo:
- [x] Update changelog
- [x] Fill in QA

## Linked issue

cardano-foundation/cardano-wallet#299



Co-authored-by: Johannes Lund <johannes.lund@iohk.io>
@piotr-iohk
Copy link
Contributor

lgtm 👍

@piotr-iohk piotr-iohk added the RESTROSPECTIVE ADR needs restrospective session label Feb 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
BUG Something isn't working RESTROSPECTIVE ADR needs restrospective session
Projects
None yet
Development

No branches or pull requests

3 participants