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

docs(api): update api README for 6.2.0 #1131

Merged
merged 1 commit into from
Nov 27, 2024
Merged

docs(api): update api README for 6.2.0 #1131

merged 1 commit into from
Nov 27, 2024

Conversation

nicoprow
Copy link
Contributor

@nicoprow nicoprow commented Nov 26, 2024

Description

this pull request updates the API README for 6.2.0 version:

  • divided README into API descriptions and API use cases
  • added API uses cases
  • removed Gate Input/Output mappings and Pool mappings
  • moved Cleaning Service Dummy restrictions to technical debts section

contributes to #1082

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

- divided README into API descriptions and API use cases
- added API uses cases
- removed Gate Input/Output mappings and Pool mappings
- moved Cleaning Service Dummy restrictions to technical debts section
@nicoprow nicoprow marked this pull request as ready for review November 26, 2024 09:24
@nicoprow nicoprow added the documentation Improvements or additions to documentation label Nov 26, 2024
@nicoprow nicoprow added this to the BPDM v6.2.0 / R24.12 milestone Nov 26, 2024
@nicoprow nicoprow merged commit 8e0f470 into main Nov 27, 2024
11 checks passed
@nicoprow nicoprow deleted the docs/api-usage branch November 28, 2024 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants