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 querying.md #1268

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update querying.md #1268

wants to merge 2 commits into from

Conversation

mcclowes
Copy link
Contributor

@mcclowes mcclowes commented Aug 5, 2024

Description

  • Include a summary of the new content you're adding or the reason for the change.
  • Include relevant context.
  • Do not link to work items.
  • Any PNG images should be compressed using Tiny PNG or equivalent.

Type of change

Please delete options that are not relevant.

  • New document(s)/updating existing
  • Fixes
  • Styling
  • Bug fix (non-breaking change which fixes an issue)

Reviews and merging

You are responsible for getting your PR merged. Address review comments promptly and make sure to merge the PR when ready.
Feel free to 'Enable automerge' - your PR will automatically merge when accepted and passing the build.

Copy link

vercel bot commented Aug 5, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
codat-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 5, 2024 11:58am

Copy link

github-actions bot commented Aug 5, 2024

Overall readability score: 60.33 (🟢 +0)

File Readability
querying.md 60.58 (🟢 +0)
View detailed metrics

🟢 - Shows an increase in readability
🔴 - Shows a decrease in readability

File Readability FRE GF ARI CLI DCRS
querying.md 60.58 48.09 9.6 11.6 11.36 7.69
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0

Averages:

  Readability FRE GF ARI CLI DCRS
Average 60.33 51.1 10.1 11.15 11.69 7.71
  🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0 🟢 +0
View metric targets
Metric Range Ideal score
Flesch Reading Ease 100 (very easy read) to 0 (extremely difficult read) 60
Gunning Fog 6 (very easy read) to 17 (extremely difficult read) 8 or less
Auto. Read. Index 6 (very easy read) to 14 (extremely difficult read) 8 or less
Coleman Liau Index 6 (very easy read) to 17 (extremely difficult read) 8 or less
Dale-Chall Readability 4.9 (very easy read) to 9.9 (extremely difficult read) 6.9 or less

Copy link

github-actions bot commented Aug 5, 2024

Link check results (filtered):

[
  "[404] https://docs.codat.io/terms/connection",
  "[404] https://docs.codat.io/404",
  "[404] https://www.exact.com/nl/developers"
]

@@ -63,6 +63,17 @@ Our `GET /{dataType}` endpoints typically return an array of items of that given

## Example queries

### Companies with connected platforms

Copy link
Collaborator

Choose a reason for hiding this comment

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

Add: Query: platform != "" to align with the formatting of the rest of the page

<TabItem value="http" label="HTTP">

```http
GET /companies/?query=platform!=""
Copy link
Collaborator

Choose a reason for hiding this comment

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

I assume we need to encode this, so GET /companies/?query=platform%21%3d"" ?
Will the "" actually work like this?

Copy link
Collaborator

@pzaichkina pzaichkina left a comment

Choose a reason for hiding this comment

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

See comments

@pzaichkina pzaichkina added the comments Comments left on the PR label Aug 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comments Comments left on the PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants