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.

Sign up for GitHub

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

Jump to bottom

Add POST requests for examples and fix URL-encoding content #513

Merged
merged 129 commits into from
Sep 18, 2024
Merged

Add POST requests for examples and fix URL-encoding content #513

merged 129 commits into from
Sep 18, 2024

Conversation

kmoscoe
Copy link
Contributor

@kmoscoe kmoscoe commented Sep 18, 2024 •
edited
Loading

This PR better describes the URL-encoding issue and fixes several other things in the REST API V2 docs:

  • Syntax given for observation POST requests was wrong
  • Adds a better description of which characters need to be encoded in intro page, and removes special-case notes from examples (thanks to Keyur for this!)
  • Ensures all examples use the correct encoding consistently
  • Examples were a mix of GET and POST requests -- this PR ensures there are both for every example

It also fixes page numbering that got screwed up in a previous PR.

Staged at bullie.svl.corp.google.com:4000

kmoscoe and others added 30 commits July 11, 2024 13:23
@kmoscoe
integrate custom docs with new UI
6af1ba7
@kmoscoe
more edits
cd0fe76
@kmoscoe
use website wording for intro
c45d61b
@kmoscoe
fix numbering in table
f5cbbca
@kmoscoe
Merge branch 'master' into custom_dc
90c57e7
@kmoscoe
rename and some edits
57ca62f
@kmoscoe
Merge branch 'custom_dc' of https://github.com/kmoscoe/docsite into c…
2277cb1 
…ustom_dc
@kmoscoe
rename manage_repo file, per Bo
fb33722
@kmoscoe
Merge.
0ebdd67
@kmoscoe
merge
e3148c4
@kmoscoe
Merge branch 'datacommonsorg:master' into master
ee5f580
@kmoscoe
Merge branch 'master' of https://github.com/datacommonsorg/docsite
5993fb7
@kmoscoe
Merge branch 'custom_dc'
61ce06d
@kmoscoe
Merge branch 'datacommonsorg:master' into master
2b37137
@kmoscoe
formatting edits
37f3e87
@kmoscoe
updates per Keyur's feedback
d83db88
@kmoscoe
Fix typos
03b906f
@kmoscoe
fix nav order
03538af
@kmoscoe
fix link to API key request form
d7fb58f
@kmoscoe
update form link
c746a7e
@kmoscoe
update key request form and output dir env var
d5e04af
@kmoscoe
Merge branch 'master' into custom_dc
0183130
@kmoscoe
Revert to gerund
b6f53cf 
Though the style guide says to just use imperatives, "get started" just sounds weird. Also this is more consistent with "troubleshooting"
@kmoscoe
Merge branch 'master' into master
e538860
@kmoscoe
new troubleshooting entry
d368ba4
@kmoscoe
Merge branch 'datacommonsorg:master' into master
db99da0
@kmoscoe
Merge branch 'custom_dc' of https://github.com/kmoscoe/docsite into c…
535962c 
…ustom_dc
@kmoscoe
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
fd071e9 
…om_dc
@kmoscoe
fix typo
771ccca
@kmoscoe
Merge branch 'datacommonsorg:master' into master
7f2bccf
kmoscoe and others added 17 commits September 10, 2024 10:22
@kmoscoe
Merge branch 'datacommonsorg:master' into master
e588231
@kmoscoe
Merge branch 'master' of https://github.com/kmoscoe/docsite
837a782
@kmoscoe
merge
bde4843
@kmoscoe
Merge branch 'datacommonsorg:master' into master
0da5d90
@kmoscoe
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
d8a639c 
…om_dc
@kmoscoe
Merge branch 'datacommonsorg:master' into master
b95565d
@kmoscoe
Merge branch 'master' of https://github.com/kmoscoe/docsite into cust…
50e490a 
…om_dc
@kmoscoe
update to use env.sample
7f1b9d1
@kmoscoe
typo
5137208
@kmoscoe
typo
081f883
@kmoscoe
Merge branch 'custom_dc' of https://github.com/kmoscoe/docsite into c…
47daec0 
…ustom_dc
@kmoscoe
get file back in head shape
7c24813
@kmoscoe
fix file name
89c04d6
@kmoscoe
Merge branch 'datacommonsorg:master' into master
14a22e4
@kmoscoe
Merge branch 'datacommonsorg:master' into master
a2d42cf
@kmoscoe
Merge branch 'master' of https://github.com/kmoscoe/docsite into api
96c7a34
@kmoscoe
add POST requests
4d36b05
@kmoscoe kmoscoe changed the title Api Add POST requests for examples and fix URL-encoding content Sep 18, 2024
@chejennifer
Copy link
Contributor

hey Kara, bullie.svl.corp.google.com:4000 is not working, can you restart it?

@kmoscoe
Copy link
Contributor Author

kmoscoe commented Sep 18, 2024 via email

chejennifer
chejennifer reviewed Sep 18, 2024
View reviewed changes
Copy link
Contributor

@chejennifer chejennifer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice, just some small things!

api/rest/v2/index.md Outdated Show resolved Hide resolved
api/rest/v2/index.md Outdated Show resolved Hide resolved
api/rest/v2/index.md Outdated Show resolved Hide resolved
api/rest/v2/index.md Outdated Show resolved Hide resolved
api/rest/v2/resolve.md Show resolved Hide resolved
@kmoscoe kmoscoe requested a review from chejennifer September 18, 2024 21:43
chejennifer
chejennifer approved these changes Sep 18, 2024
View reviewed changes
Copy link
Contributor

@chejennifer chejennifer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for updating!

@kmoscoe kmoscoe merged commit 32e304c into datacommonsorg:master Sep 18, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chejennifer chejennifer chejennifer approved these changes

@keyurva keyurva Awaiting requested review from keyurva

@shifucun shifucun Awaiting requested review from shifucun

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kmoscoe @chejennifer