Skip to content

Update EDS OpenAPI README - #818

Open
friedemannf wants to merge 5 commits into
mainfrom
eds-openapi
Open

Update EDS OpenAPI README#818
friedemannf wants to merge 5 commits into
mainfrom
eds-openapi

Conversation

@friedemannf

Copy link
Copy Markdown
Member

No description provided.

Copilot AI review requested due to automatic review settings July 27, 2026 16:46
@friedemannf
friedemannf marked this pull request as ready for review July 27, 2026 16:46
@friedemannf
friedemannf requested a review from a team as a code owner July 27, 2026 16:46
@friedemannf
friedemannf enabled auto-merge (squash) July 27, 2026 16:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.version from 0.0.1 to 1.0.0 across 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.

Comment thread openapi/src/eds/README.md Outdated
Comment thread openapi/src/eds/README.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings July 27, 2026 17:03
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread openapi/src/eds/README.md Outdated
Copilot AI review requested due to automatic review settings July 27, 2026 17:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot AI review requested due to automatic review settings July 27, 2026 17:12

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread openapi/src/eds/README.md Outdated
Comment thread openapi/src/eds/README.md Outdated
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
Copilot AI review requested due to automatic review settings July 27, 2026 17:26

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants