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

some HAL browser docs links return 404 #221

Closed
1 of 2 tasks
chriswatrous opened this issue Jul 6, 2018 · 4 comments
Closed
1 of 2 tasks

some HAL browser docs links return 404 #221

chriswatrous opened this issue Jul 6, 2018 · 4 comments

Comments

@chriswatrous
Copy link

chriswatrous commented Jul 6, 2018

Pre issue-raising checklist

I have already (please mark the applicable with an x):

  • Upgraded to the latest Pact Broker OR
  • Checked the CHANGELOG to see if the issue I am about to raise has been fixed

Software versions

  • pact-broker docker version: 2.23.4-1
  • OS: Mac OSX 10.13.4
  • pact broker client details: Firefox 60.0.2

Expected behaviour

All docs links in the HAL browser return html docs.

Actual behaviour

These links don't work (return 404):

pb:latest-provider-pacts
pb:latest-provider-pacts-with-tag
pb:provider-pacts-with-tag
pb:provider-pacts
pb:latest-version
pb:latest-tagged-version

Steps to reproduce

Run pact broker like this:

docker run \
  --link pactbroker-db:postgres \
  --env PACT_BROKER_DATABASE_USERNAME=pactbrokeruser \
  --env PACT_BROKER_DATABASE_PASSWORD="$PACTBROKER_POSTGRES_USER_PW" \
  --env PACT_BROKER_DATABASE_HOST="$postgres_ip" \
  --env PACT_BROKER_DATABASE_NAME=pactbroker \
  --detach \
  --publish 80:80 \
  --name pactbroker \
  dius/pact-broker:2.23.4-1

browse to localhost, click on "API Browser", click on any of the links in the docs column

@bethesque
Copy link
Member

They are all templated links, and require parameters to be filled in.

@bethesque
Copy link
Member

Oh, sorry, you're talking about the docs, not the resources themselves. They don't all have docs. If you would like to open a PR to add some, I'd be happy to accept.

bethesque added a commit that referenced this issue Jul 7, 2018
…entation

Added tests to ensure that all new relations will be documented in the future.

FIxes: #221
@bethesque
Copy link
Member

I've added the missing docs.

@chriswatrous
Copy link
Author

Just downloaded the latest docker image and I see the new docs. Thanks a lot!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants