Create API.md #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…into ab/initial-api-spec
docs/src/API.md
Outdated
|
|
||
| ## Endpoint Description | ||
|
|
||
| `GET /tiles/{x}/{y}/{z}` |
There was a problem hiding this comment.
@abarciauskas-bgse I think we should try to follow the OGC specification here and use something like
GET /collections/{collection_id}/tiles/{x}/{y}/{z}
we will also add
GET /collections/
GET /collections/{collection_id}
|
@vincentsarago updated to point to the OGC Tiles spec and a few additional notes on the parameters. Let me know if you agree. |
|
@vincentsarago do you think this documentation is useful or should I close this PR? |
|
@abarciauskas-bgse this documentation will be really useful but I think we should wait for the API to be |
vincentsarago
force-pushed
the
ab/initial-api-spec
branch
from
d1cfaf7 to
67b52d0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This will eventually, I would assume, go in swagger documentation but I thought having it in markdown would be helpful now to get alignment on the specification.