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

ADAPP-18865 rework Reports Service API docs #1155

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

ADAPP-18865 rework Reports Service API docs #1155

wants to merge 14 commits into from

Conversation

Sporiff
Copy link
Contributor

@Sporiff Sporiff commented Oct 24, 2024

Related issues

Changes

This PR reworks the current report service documentation into a single guide.

@Sporiff Sporiff self-assigned this Oct 24, 2024
@vercel Vercel
Copy link

vercel bot commented Oct 24, 2024 •
edited
Loading

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

Name Status Preview Comments Updated (UTC)
dev-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 21, 2024 10:20am

@Sporiff Sporiff marked this pull request as ready for review November 1, 2024 08:33
jmikovic
jmikovic reviewed Nov 1, 2024
View reviewed changes
src/content/docs/en/api/reports-service.mdoc Outdated Show resolved Hide resolved
src/content/docs/en/api/reports-service.mdoc Outdated Show resolved Hide resolved
src/content/docs/en/api/reports-service.mdoc Show resolved Hide resolved
src/content/docs/en/api/reports-service.mdoc Outdated Show resolved Hide resolved
src/content/docs/en/api/reports-service.mdoc Outdated Show resolved Hide resolved
src/content/docs/en/api/reports-service.mdoc Outdated Show resolved Hide resolved
src/content/docs/en/api/reports-service.mdoc Outdated Show resolved Hide resolved
src/content/docs/en/api/reports-service.mdoc Outdated Show resolved Hide resolved
@Sporiff Sporiff changed the title Adapp 18865 rework rs api docs ADAPP-18865 rework Reports Service API docs Nov 6, 2024
@Sporiff
Copy link
Contributor Author

Sporiff commented Nov 21, 2024

@SlavaSkvortsov @jmikovic I've updated the docs with the following changes:

  1. I've incorporated links to documentation that you added here.
  2. I've updated the types as pointed out for numerical comparisons.
  3. I've updated the GROSS_* values.
  4. I've removed the filters_data endpoint docs in favor of linking out to the glossaries on the HC.
  5. I've swapped CSV and JSON endpoint docs so that CSV comes first.
  6. I've removed the pivot report endpoint doc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SlavaSkvortsov SlavaSkvortsov SlavaSkvortsov left review comments

@jmikovic jmikovic jmikovic left review comments

Assignees

@Sporiff Sporiff

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Sporiff @jmikovic @SlavaSkvortsov