Update EDS OpenAPI README - #818
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Explicit Disclosure Service (EDS) OpenAPI documentation by bumping the published spec versions to 1.0.0 and clarifying API naming in the EDS README to consistently refer to the “Canton” variants.
Changes:
- Bump
info.versionfrom0.0.1to1.0.0across EDS OpenAPI specs. - Update EDS README headings/text to “Global Canton CCIP API”, “Canton Token Pool API”, “Canton CCV API”, and “Canton Executor API”.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| openapi/src/eds/README.md | Renames API sections/mentions to include “Canton”; updates related narrative and diagrams. |
| openapi/src/eds/ccip/eds-ccip.yaml | Updates OpenAPI info.version to 1.0.0. |
| openapi/src/eds/ccv/eds-ccv.yaml | Updates OpenAPI info.version to 1.0.0. |
| openapi/src/eds/executor/eds-executor.yaml | Updates OpenAPI info.version to 1.0.0. |
| openapi/src/eds/global/eds-global.yaml | Updates OpenAPI info.version to 1.0.0. |
| openapi/src/eds/tokenpool/eds-tokenpool.yaml | Updates OpenAPI info.version to 1.0.0. |
Comments suppressed due to low confidence (3)
openapi/src/eds/README.md:82
- Grammar: "provided and ran" should be "provided and run" (or "provided and operated") so the sentence reads correctly.
The Canton CCV API is provided and ran by the operator of a CCV, and provides endpoints for users to query explicit disclosures
for a specific CCV contract.
openapi/src/eds/README.md:104
- Grammar: "provided and ran" should be "provided and run" (or "provided and operated") so the sentence reads correctly.
The Canton Executor API is provided and ran by the operator of an Executor, and provides endpoints for users to query explicit
disclosures for a specific Executor contract.
openapi/src/eds/README.md:163
- In the "Sending a message" Mermaid diagram, this participant label is inconsistent with the rest of the document (which uses "Canton Token Pool API").
participant TP as Token Pool API
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (3)
openapi/src/eds/README.md:59
- In this updated sentence, "provided and ran" is grammatically incorrect; it should be "provided and run" (or "operated").
The Canton Token Pool API is provided and run by the operator of a token pool, and provides endpoints for users to query
openapi/src/eds/README.md:81
- "provided and ran" is grammatically incorrect here; consider "provided and run" (or "operated") for correct tense/voice.
The Canton CCV API is provided and ran by the operator of a CCV, and provides endpoints for users to query explicit disclosures
openapi/src/eds/README.md:103
- "provided and ran" is grammatically incorrect here; use "provided and run" (or "operated") to match standard phrasing.
The Canton Executor API is provided and ran by the operator of an Executor, and provides endpoints for users to query explicit
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.
Comments suppressed due to low confidence (2)
openapi/src/eds/README.md:82
- Grammar: “provided and ran” should be “provided and run” (past tense mismatch).
The Canton CCV API is provided and ran by the operator of a CCV, and provides endpoints for users to query explicit disclosures
for a specific CCV contract.
openapi/src/eds/README.md:104
- Grammar: “provided and ran” should be “provided and run” (past tense mismatch).
The Canton Executor API is provided and ran by the operator of an Executor, and provides endpoints for users to query explicit
disclosures for a specific Executor contract.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Comments suppressed due to low confidence (1)
openapi/src/eds/README.md:237
- In the execution sequence diagram, the CCIP participant is labeled "Canton CCIP API" but the rest of the README calls it the "Global Canton CCIP API". Consider aligning the diagram label with the section heading/steps.
participant CCIP as Canton CCIP API
| title: CCIP Explicit Disclosure API | ||
| description: Provides access to explicit disclosures required to send/execute CCIP messages from/to Canton. | ||
| version: 0.0.1 | ||
| version: 1.0.0 |
No description provided.