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

Develop #215

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

Develop #215

wants to merge 54 commits into from

Conversation

Sonalit23
Copy link
Collaborator

Reporting API

  • Add doc for UTC date time format
  • Correct type, limit and order of fields in reporpting-api documentation

SamUK93 and others added 30 commits October 29, 2024 14:45
* docs: Add new excludeCustomFields param to the API docs

* Fix param name

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>
Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com>
* DEV-37012: Add docs for error when updating a user with non-existent roles (#150)

* docs: Add docs for error when updating a user with non-existent roles

* docs: Move 400 response example to the update roles request

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* Update comment to reflect new change in api token creation

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>
* feat: documentation for Reporting API

* correct grammer

* fix tab and format issues

* fix: query param format

* feat: format docs

* fix: semantic issues

* feat: add documentation on API restrictions

* fix: character issue

* refactor: change the sample data full names

* refactor: text as per per review comments

* refactor: text as per per review comments

* refactor: correct format for issues and scores

* refactor: API docs and response messages as per review comments

* refactor: response for concurrent requests and dowload volume limit

* refactor: internal server error response

* refactor: response messages

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
#163)

* fix: bump the ruby version to 3.1.2

* fix: add sepearate group for reporting api

* fix: bump the ruby version to 3.3

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
…limit (#166)

* feat: add documentation for cURL access, Acrolinx access token and day limits

* feat: add documentation for cURL access, Acrolinx access token and day limits

* refactor: change strings as per suggerstions from UX team

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
* feat: add partial check documentation

* Refactor: checks scope description

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
… add missing quotes (#171)

* refactor: remove unused messages, rephrase the valid date message and add missing quotes

* feat: add variation in messages for invalid date

* refactor: add missing quotes

* refactor: invalid start and end date response message

* refactor: invalid start and end date response message

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
* feat: add documentation for CSV fields and note for reason behind empty csv

* refactore: note for empty csv file

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
The section describing the Dictionary API has been moved to the internal core-server repository.
* fix: indentation in index result

* feat: added example GP info

* fix: styling of Note

* feat: added small explanation of this endpoint

* Updated wording

- just Acrolinx not Acrolinx Platform
- added comma for introductory sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Added reference to Guidance Package

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
* docs: Update index response with new platform / core version structure

* docs: Add new versions + guidance package section to second 200 response

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>
* doc: add json escape character info

* refactor: sentence structure

* refactor: sentence structure

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* refactor: update sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* add type of code

Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>
…with our new terminology and language review (#188)
* origin/main:
  Reporting API documentation (#161)
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Sonali Tanavade and others added 24 commits November 20, 2024 13:28
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
* doc: add new fields description

* doc: add new fields description

* fix: keep the ruby version 3.3.5

* add period

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
* feat: rename docs for checks csv column names

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
* doc: initial draft with 2 semantic issues for json format documentation

* doc: add samle json data

* doc: remove duplicate code

* doc: rename fields and rephrase sentences

* doc: add parent node documentation for checks and issues json

* fix: formatting issue

* fix: formatting issue

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Change format

* fix: semantic issue

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
* Develop (#189)

* DEV-36440 exclude custom fields param (#151)

* docs: Add new excludeCustomFields param to the API docs

* Fix param name

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* fix: Bump Ruby version 2.7.0 (#152)

Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com>

* Update comment to reflect new change in api token creation (#154)

* DEV-37012: Add docs for error when updating a user with non-existent roles (#150)

* docs: Add docs for error when updating a user with non-existent roles

* docs: Move 400 response example to the update roles request

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* Update comment to reflect new change in api token creation

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* feat: documentation for Reporting API (#160)

* feat: documentation for Reporting API

* correct grammer

* fix tab and format issues

* fix: query param format

* feat: format docs

* fix: semantic issues

* feat: add documentation on API restrictions

* fix: character issue

* refactor: change the sample data full names

* refactor: text as per per review comments

* refactor: text as per per review comments

* refactor: correct format for issues and scores

* refactor: API docs and response messages as per review comments

* refactor: response for concurrent requests and dowload volume limit

* refactor: internal server error response

* refactor: response messages

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* fix: bump the ruby version to 3.3 and separate group for reporting API (#163)

* fix: bump the ruby version to 3.1.2

* fix: add sepearate group for reporting api

* fix: bump the ruby version to 3.3

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* fix: typo fix in query param (#164)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* feat: document new response messages (#165)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* feat: add documentation for cURL access, Acrolinx access token, days limit (#166)

* feat: add documentation for cURL access, Acrolinx access token and day limits

* feat: add documentation for cURL access, Acrolinx access token and day limits

* refactor: change strings as per suggerstions from UX team

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* refactor: remove words and phrases (#167)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* Partial checks documentation (#168)

* feat: add partial check documentation

* Refactor: checks scope description

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* feat: remove outdated postman collection (#170)

* refactor: remove unused messages, rephrase the valid date message and add missing quotes (#171)

* refactor: remove unused messages, rephrase the valid date message and add missing quotes

* feat: add variation in messages for invalid date

* refactor: add missing quotes

* refactor: invalid start and end date response message

* refactor: invalid start and end date response message

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* feat: add message for empty start and end date

* refactor: remove incorrect response message

* fix: typo for goal columns description

* fix: type of the column

* feat: add documentation for CSV fields and note (#177)

* feat: add documentation for CSV fields and note for reason behind empty csv

* refactore: note for empty csv file

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* DEV-40218 remove dictionary api documentation (#179)

The section describing the Dictionary API has been moved to the internal core-server repository.

* Add example for version info about linguistic configuration (#183)

* fix: indentation in index result

* feat: added example GP info

* fix: styling of Note

* feat: added small explanation of this endpoint

* Updated wording

- just Acrolinx not Acrolinx Platform
- added comma for introductory sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Added reference to Guidance Package

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* DEV-40118: Update index response with new version structure (#184)

* docs: Update index response with new platform / core version structure

* docs: Add new versions + guidance package section to second 200 response

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* doc: add json escape character info (#185)

* doc: add json escape character info

* refactor: sentence structure

* refactor: sentence structure

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* refactor: update sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* add type of code

Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>

* Added changes from DEV-40491

* DEV-40642: Update apiary documentation & github readme in accordance with our new terminology and language review (#188)

---------

Co-authored-by: SamUK93 <sammyryan93@hotmail.co.uk>
Co-authored-by: Sam Ford <sam.ford@acrolinx.com>
Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com>
Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com>
Co-authored-by: Sonali <69430512+Sonalit23@users.noreply.github.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: George Haddad <george-haddad@users.noreply.github.com>
Co-authored-by: Claus Brunzema <146445577+cbrunzema@users.noreply.github.com>
Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>

* Resolve conflict branch develop to main (#201)

* DEV-36440 exclude custom fields param (#151)

* docs: Add new excludeCustomFields param to the API docs

* Fix param name

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* fix: Bump Ruby version 2.7.0 (#152)

Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com>

* Update comment to reflect new change in api token creation (#154)

* DEV-37012: Add docs for error when updating a user with non-existent roles (#150)

* docs: Add docs for error when updating a user with non-existent roles

* docs: Move 400 response example to the update roles request

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* Update comment to reflect new change in api token creation

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* feat: documentation for Reporting API (#160)

* feat: documentation for Reporting API

* correct grammer

* fix tab and format issues

* fix: query param format

* feat: format docs

* fix: semantic issues

* feat: add documentation on API restrictions

* fix: character issue

* refactor: change the sample data full names

* refactor: text as per per review comments

* refactor: text as per per review comments

* refactor: correct format for issues and scores

* refactor: API docs and response messages as per review comments

* refactor: response for concurrent requests and dowload volume limit

* refactor: internal server error response

* refactor: response messages

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* fix: bump the ruby version to 3.3 and separate group for reporting API (#163)

* fix: bump the ruby version to 3.1.2

* fix: add sepearate group for reporting api

* fix: bump the ruby version to 3.3

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* fix: typo fix in query param (#164)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* feat: document new response messages (#165)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* feat: add documentation for cURL access, Acrolinx access token, days limit (#166)

* feat: add documentation for cURL access, Acrolinx access token and day limits

* feat: add documentation for cURL access, Acrolinx access token and day limits

* refactor: change strings as per suggerstions from UX team

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* refactor: remove words and phrases (#167)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* Partial checks documentation (#168)

* feat: add partial check documentation

* Refactor: checks scope description

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* feat: remove outdated postman collection (#170)

* refactor: remove unused messages, rephrase the valid date message and add missing quotes (#171)

* refactor: remove unused messages, rephrase the valid date message and add missing quotes

* feat: add variation in messages for invalid date

* refactor: add missing quotes

* refactor: invalid start and end date response message

* refactor: invalid start and end date response message

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* feat: add message for empty start and end date

* refactor: remove incorrect response message

* fix: typo for goal columns description

* fix: type of the column

* feat: add documentation for CSV fields and note (#177)

* feat: add documentation for CSV fields and note for reason behind empty csv

* refactore: note for empty csv file

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* DEV-40218 remove dictionary api documentation (#179)

The section describing the Dictionary API has been moved to the internal core-server repository.

* Add example for version info about linguistic configuration (#183)

* fix: indentation in index result

* feat: added example GP info

* fix: styling of Note

* feat: added small explanation of this endpoint

* Updated wording

- just Acrolinx not Acrolinx Platform
- added comma for introductory sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Added reference to Guidance Package

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* DEV-40118: Update index response with new version structure (#184)

* docs: Update index response with new platform / core version structure

* docs: Add new versions + guidance package section to second 200 response

---------

Co-authored-by: Sam Ford <sam.ford@acrolinx.com>

* doc: add json escape character info (#185)

* doc: add json escape character info

* refactor: sentence structure

* refactor: sentence structure

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* refactor: update sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Refactor sentence

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* add type of code

Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>

* Added changes from DEV-40491

* DEV-40642: Update apiary documentation & github readme in accordance with our new terminology and language review (#188)

* Changes from DEV-40491

* feat: add docs for check type

* Rephrase the description for check type

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Change description for automated check type

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Change description for baseline check type

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* refactor: description for check types

* doc: add new fields description

* doc: add new fields description

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Fix: ruby version 3.3.5 (#193)

* doc: add new fields description

* doc: add new fields description

* fix: keep the ruby version 3.3.5

* add period

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* feat: add goal field for issues data in reporting api docs (#194)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

* doc: rename goal column name to goal ID

* feat: rename docs for checks csv column names (#195)

* feat: rename docs for checks csv column names

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* doc: initial draft with 2 semantic issues for json format documentation

* doc: add samle json data

* doc: remove duplicate code

* doc: rename fields and rephrase sentences

* doc: add parent node documentation for checks and issues json

* Doc/dev 40854 reporting api json format (#198)

* doc: initial draft with 2 semantic issues for json format documentation

* doc: add samle json data

* doc: remove duplicate code

* doc: rename fields and rephrase sentences

* doc: add parent node documentation for checks and issues json

* fix: formatting issue

* fix: formatting issue

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Change format

* fix: semantic issue

---------

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* doc: incorporate review comments (#199)

Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>

---------

Co-authored-by: SamUK93 <sammyryan93@hotmail.co.uk>
Co-authored-by: Sam Ford <sam.ford@acrolinx.com>
Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com>
Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: George Haddad <george-haddad@users.noreply.github.com>
Co-authored-by: Claus Brunzema <146445577+cbrunzema@users.noreply.github.com>
Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>
Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com>

* feat: add doc for guideline id

---------

Co-authored-by: Paresh Deshmukh <paresh.deshmukh@acrolinx.com>
Co-authored-by: SamUK93 <sammyryan93@hotmail.co.uk>
Co-authored-by: Sam Ford <sam.ford@acrolinx.com>
Co-authored-by: Tóth Krisztián Gyula <t.krisztian95@gmail.com>
Co-authored-by: Krisztián Gyula Tóth <krisztian.toth@acrolinx.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: George Haddad <george-haddad@users.noreply.github.com>
Co-authored-by: Claus Brunzema <146445577+cbrunzema@users.noreply.github.com>
Co-authored-by: Robert Barbey <robert.barbey@acrolinx.com>
* docs: rejects requests with role names containing semicolons

* docs: indicate invalid value

---------

Co-authored-by: Patrick Nyakoria <patrick.nyakoria@acrolinx.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Document status code in case the platform is unable to process a document.
* Document using HEAD for check polling

* Update apiary.apib

* Update apiary.apib

* Update apiary.apib

* Update apiary.apib

Co-authored-by: Sonali <69430512+Sonalit23@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

* Update apiary.apib

Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>

---------

Co-authored-by: Sonali <69430512+Sonalit23@users.noreply.github.com>
Co-authored-by: madeline-brennan <85683928+madeline-brennan@users.noreply.github.com>
Co-authored-by: Sonali Tanavade <sonali.tanavade@acrolinx.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

10 participants