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

Update v3 API documentation #4402

Closed
18 tasks done
s-taube opened this issue Sep 1, 2024 · 4 comments
Closed
18 tasks done

Update v3 API documentation #4402

s-taube opened this issue Sep 1, 2024 · 4 comments
Assignees

Comments

@s-taube
Copy link
Contributor

s-taube commented Sep 1, 2024

Update all v3 API documentation with v4 info. Relevant pages can be found here, as well as on subpages (in table of contents, also via the "learn more" links). Additionally, some notes on reorganizing web pages can be found in this issue

To update html: From this page, select vlatest page to update in the left nav. Select "edit," make any edits, and then hit "commit."

Updates Needed:

api page:

  • "v3" references should be updated to "v4" (heading, commands, etc.) (note: this had already been completed)
  • typo under “filtering”: “Again, one of the fitlers is the ID field”
  • typo with Jurisdiction count: “We currently have 0 jurisdictions that can be accessed with our APIs.” (looks like it should be 3351, and automatically updated.)
  • remove "performance tip" no. 1
  • add an explanation of CBP after "field selection"

individual API pages:

  • update references of "v3" to "v4" all pages.
  • remove "count" from the example results, since this field was removed. Relevant for pages: Case Law, PACER, Financial Disclosures.
  • on advanced field page, change "human editors" to "editors"
  • on advanced field page, fix typo: “within an document type.”

search api page:

  • update references of "v3" to "v4" (note: this had already been completed)
  • update type r, add rd
  • A new example should be provided for the "basic usage" results, since many of the fields have been removed, changed, or added. This can be found by going to this url.
  • some fields are in those results that should have been removed -- e.g. source, non_participating_judge_ids. Comment to Alberto.
  • explain highlight=on
  • add cardinality of query counts
  • add information on ordering: "If your sorting field has null values..."
  • add information on key in type=r: "If there are more than three matching documents, the more_docs field for the docket result will be true..."

Search Operators page:

  • Update fields (update: not needed)

Other decisions:

  • don't need to add error codes. All the information users need is in the error message itself.
@s-taube s-taube self-assigned this Sep 1, 2024
@s-taube
Copy link
Contributor Author

s-taube commented Sep 9, 2024

@albertisfu Mike asked me to update API pages (like this one) by duplicating the page, making the updates in html, and having you double check for accuracy. 1) does that sound okay? 2) is it helpful if I flag the changes I'm making by adding <! -- comments --> ? 3) anything else that might make this process smoother? Thank you!

@albertisfu
Copy link
Contributor

Sure, this sounds good to me!

Regarding the comments and making the process smoother, the <!-- comments --> would be useful if you want to flag me with actual comments. For the purpose of reviewing the changes, I suggest first duplicating the pages and submitting a commit with only that. Afterward, you can make one or multiple commits as you prefer. When I review your changes, I can simply compare your first and latest commits to check what has changed between the original and new versions.

@s-taube
Copy link
Contributor Author

s-taube commented Sep 13, 2024

I'm unclear what changes to make to the example results on the search api page (since some fields have been removed, but still show up in a v4 api request). I tagged Alberto in a comment in PR #4235 to get more info.

@s-taube s-taube closed this as completed by moving to Done in @s-taube Sep 17, 2024
@mlissner
Copy link
Member

Congrats and thank you!

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

No branches or pull requests

3 participants