Skip to content

Enhance docs for delete mapping association methods #124

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

Merged
jfrench9 merged 1 commit into from
May 27, 2026
Merged

Enhance docs for delete mapping association methods #124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions robosystems_client/api/extensions_robo_ledger/op_delete_mapping_association.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,10 @@ def sync_detailed(
) -> Response[ErrorResponse | OperationEnvelopeDeleteResult]:
"""Delete Mapping Association

Remove a single CoA → reporting-concept mapping edge. The mapping structure itself remains; only the
association row is dropped.
Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains;
only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then
`create-mapping-association` the right one. Find the association id via the `library_element_arcs`
GraphQL field. Library-seeded rows cannot be deleted (403).

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -155,8 +157,10 @@ def sync(
) -> ErrorResponse | OperationEnvelopeDeleteResult | None:
"""Delete Mapping Association

Remove a single CoA → reporting-concept mapping edge. The mapping structure itself remains; only the
association row is dropped.
Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains;
only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then
`create-mapping-association` the right one. Find the association id via the `library_element_arcs`
GraphQL field. Library-seeded rows cannot be deleted (403).

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -192,8 +196,10 @@ async def asyncio_detailed(
) -> Response[ErrorResponse | OperationEnvelopeDeleteResult]:
"""Delete Mapping Association

Remove a single CoA → reporting-concept mapping edge. The mapping structure itself remains; only the
association row is dropped.
Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains;
only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then
`create-mapping-association` the right one. Find the association id via the `library_element_arcs`
GraphQL field. Library-seeded rows cannot be deleted (403).

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down Expand Up @@ -232,8 +238,10 @@ async def asyncio(
) -> ErrorResponse | OperationEnvelopeDeleteResult | None:
"""Delete Mapping Association

Remove a single CoA → reporting-concept mapping edge. The mapping structure itself remains; only the
association row is dropped.
Remove a single CoA → reporting-concept mapping edge by id. The mapping structure itself remains;
only the association row is dropped. Use this to correct a wrong mapping — delete the bad edge, then
`create-mapping-association` the right one. Find the association id via the `library_element_arcs`
GraphQL field. Library-seeded rows cannot be deleted (403).

**Idempotency**: supply an `Idempotency-Key` header to make safe retries; replays within 24 hours
return the same envelope. Reusing the key with a different body returns HTTP 409 Conflict.
Expand Down
Loading