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

Add hyperlinks for API query examples (but without API key) #138

Open
nvkelso opened this issue Jan 5, 2017 · 2 comments
Open

Add hyperlinks for API query examples (but without API key) #138

nvkelso opened this issue Jan 5, 2017 · 2 comments
Assignees

Comments

@rmglennon
Copy link
Collaborator

From some testing with markdown and HTML tags, it works best with a format like this:

> [/route?json={"locations":[{"lat":40.749706,"lon":-73.991562,"type":"break","street":"Penn Plaza"},{"lat":40.73093,"lon":-73.991379,"type":"break","street":"Wanamaker Place"}],"costing":"multimodal","costing_options":{"transit":{"use_bus":"1.0","use_rail":"0.0","use_transfers":"0.3"},"pedestrian":{"walking_speed":"4.1"}}}&api_key=mapzen-xxxxxxx](https://valhalla.mapzen.com/route?json={"locations":[{"lat":40.749706,"lon":-73.991562,"type":"break","street":"Penn Plaza"},{"lat":40.73093,"lon":-73.991379,"type":"break","street":"Wanamaker Place"}],"costing":"multimodal","costing_options":{"transit":{"use_bus":"1.0","use_rail":"0.0","use_transfers":"0.3"},"pedestrian":{"walking_speed":"4.1"}}})

The base URL is stated earlier in the topic, so removing it from the link text that displays on the page. This matches the Search examples.

To do:

@rmglennon
Copy link
Collaborator

As part of the requirement to use an API key with all requests, I have had to remove the URL to make these links just be code blocks (for now).

In the near-future, they will be updated to use the fancy API key switching we do for all documentation.

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

No branches or pull requests

2 participants