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.

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

Jump to bottom

VC-API relation #665

Closed
wants to merge 3 commits into from
Closed

VC-API relation #665

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f092ae2
Remove section 9.1
PatStLouis Jun 27, 2024
e43c0e7
Merge branch 'w3c-ccg:main' into main
PatStLouis Jun 27, 2024
5488d3c
Update index.html
PatStLouis Jun 27, 2024
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
30 changes: 9 additions & 21 deletions docs/spec/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,15 @@ <h2>Interoperability Testing</h2>
roles (`issuer`, `holder`, and `verifier`), in turn invoking the
participating platform.
</p>
<h3>Implementation guidelines</h3>
<p>
This specification aims at demonstrating technical implementation between participating parties in the context of traceability.
For broader interoperability testing or for implementers looking for a way to get started managing verifiable credentials, please refer
to the <a href="https://w3c-ccg.github.io/vc-api/">VC-API specification</a> when starting to design your software.
The VC-API group maintains an extensive set of test-suites for other technical aspects not covered by this specification,
such as issuance, did resolving, verification and status updates. They also provide extensive guidance for new participants.
It is recommended to implement the vc-api prior to joining this group, unless you are experienced in Verifiable Credentials.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this sentence goes too far and recommend removing it.

</p>
</section>

<section class="informative">
Expand Down Expand Up @@ -475,27 +484,6 @@ <h2>OAS Implementation</h2>
clientCredentials:
tokenUrl: https://conformant-platform.example.com/oauth/token
</pre>
<h3>Code Generation</h3>
<p>
The <a href=""><code>openapi-typescript-codegen</code></a> project provides
a means for generating typescript clients based on OpenAPI specifications.
</p>
<pre class="example">
# Install openapi-typescript-codegen globally
npm install -g openapi-typescript-codegen

# Produce a dereferenced openapi specification JSON file from this repo.
npm run preserve

# Generate a typescript client from the dereferenced openapi specification JSON file.
npx openapi-typescript-codegen --input ./docs/openapi/openapi.json
</pre>
<p>
Please refer to the `openapi-typescript-codegen` project page for more detailed
<a href="https://github.com/ferdikoomen/openapi-typescript-codegen/tree/master#install">installation</a>
and <a href="https://github.com/ferdikoomen/openapi-typescript-codegen/tree/master#usage">usage</a>
instructions.
</p>
</section>

<section class="normative">
Expand Down