griffithlab / griffithlab/civic-docs

Update API docs

Open
#147 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
5
Forks
9
PR merge metrics
No merged PRs in 30d

Description

As of today (December 8th, 2023), here's what I see when I go to https://docs.civicdb.org/en/latest/api.html:

In April 2022 CIViC V2 was launched, which includes a new GraphQL API. The old API is still available at v1.civicdb.org/api. It accesses a frozen datadump and does not include any new data since the switchover. While we expect the V1 API to be accessible for a few more months (deprecation date forthcoming) any new integrations should use the V2 API and existing integrations should switch to the V2 API as soon as possible. Please contact us at help@civicdb.org for assistance.

It looks to me like v1.civicdb.org is timing out:

> curl -o - -I https://v1.civicdb.org/api/variants/13
curl: (28) Failed to connect to v1.civicdb.org port 443 after 75108 ms: Couldn't connect to server

If this is intentional, then the docs should be updated to say that the v1 API is no longer available, and that at this point everyone should be using the v2 API.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the API documentation page at https://docs.civicdb.org/en/latest/api.html and verify whether the v1 endpoint is still available. Update the page to accurately describe the status of the v1 API and direct users to the v2 GraphQL API if appropriate, then verify the rendered documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.