API intro pages refactor #458
Conversation
Though the style guide says to just use imperatives, "get started" just sounds weird. Also this is more consistent with "troubleshooting"
|
hm, I'm getting a server error when trying to access http://bullie.svl.corp.google.com/: https://screenshot.googleplex.com/4EjKdibwstn9CFb |
|
Try now.
…On Mon, Jul 29, 2024 at 9:12 AM chejennifer ***@***.***> wrote:
hm, I'm getting a server error when trying to access
http://bullie.svl.corp.google.com/:
https://screenshot.googleplex.com/4EjKdibwstn9CFb
—
Reply to this email directly, view it on GitHub
<#458 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BHMM7UFWSA7FEKDGKECTOYLZOZSW3AVCNFSM6AAAAABLNGRLZGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENJWGM2DKNBXGI>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
still getting the same server error |
ah, did not use port 4000, I just copy pasted the link in the description |
|
D'oh! Sorry, I thought I had the port number there.
…On Mon, Jul 29, 2024 at 11:51 AM chejennifer ***@***.***> wrote:
bullie.svl.corp.google.com
ah, did not use port 4000, I just copy pasted the link in the description
—
Reply to this email directly, view it on GitHub
<#458 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/BHMM7UE4V7OJHGHALG3E6DLZO2FJNAVCNFSM6AAAAABLNGRLZGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENJWGY3DSMRQGM>
.
You are receiving this because you authored the thread.Message ID:
***@***.***>
|
api/rest/v2/troubleshooting.md
Outdated
| } | ||
| ``` | ||
|
|
||
| This is most commonly seen when your request is missing a required path parameter. Make sure endpoints and parameters are both spelled correctly and provided in the right order. |
There was a problem hiding this comment.
curious what the difference between this and "method does not exist is"? reading the descriptions of the two, it seems like both have to do with path parameters being incorrect? maybe should make clear the difference between the two error messages.
There was a problem hiding this comment.
I honestly don't know. I'll need to check the code and update this.
There was a problem hiding this comment.
So if I'm looking in the right place, it seems like "invalid request URI" is about a parameter being "missing" (i.e. there are fewer than 2 parameters in the URI string): https://github.com/search?q=repo%3Adatacommonsorg%2Fmixer%20%22Invalid%20request%20URI%22&type=code
But I can't actually find anything about "Method does not exist." Maybe I should just remove that one?
There was a problem hiding this comment.
looks like "invalid request URI" only appears for v1 endpoints? https://screenshot.googleplex.com/6H4sFJixiuWBtjX
have you seen this error when working with v2 endpoints?
There was a problem hiding this comment.
OMG, looks like this is indeed to v1, and the doc wasn't updated. I had assumed that v2 just inherited the v1 errors, but it appears not: https://github.com/search?q=repo%3Adatacommonsorg%2Fmixer+path%3A%2F%5Einternal%5C%2Fserver%5C%2Fv2%5C%2F%2F+errorf&type=code I suspect that one of the big improvements in v2 was more meaningful error messages in fact. :-) The only ones I can reproduce easily are empty data and "marshalling errors". For now, I'll just remove these two, though I wonder if maybe we don't actually need a troubleshooting page altogether...
…into api_docs_overhaul
Refactor the index and getting started pages as follows:
Partly previously reviewed by Bo.
Staged at bullie.svl.corp.google.com