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

(work in progress) Initial start of a v2.x OAS/Swagger. #60

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

darrellodonnell
Copy link
Collaborator

initial v2 OAS/Swagger (work in progress)

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jan 16, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: darrellodonnell / name: Darrell O'Donnell (7375e1a)

Copy link
Contributor

@andorsk andorsk left a comment

Choose a reason for hiding this comment

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

@darrellodonnell this looks very similar to v1 specs ( which is fine ). Would that be mostly the current intent of this proposal, to port over v1 first and work with that as a starting point?

nit: Change the PR to Draft status ( it's a button on the "conversations" ) tab, to indicate you are not ready for full review.

@darrellodonnell darrellodonnell marked this pull request as draft January 23, 2023 18:35
@darrellodonnell
Copy link
Collaborator Author

The intent of this work is manifold. Two of the inputs are:

  1. Maintain alignment with v1. The value of the v1 approach (answering 3 simple questions) has been helpful to date.
  2. Explore the basic remaining questions that we tabled in the v1 work, where our data model needs fleshing out (e.g. how does one represent the laundry list of credential types, schema, roles in an EGF).

Swagger is helpful here (and I'll be using a Swagger (OAS) to PlantUML tooling for some early UML models that can be refined as logical models.

not: I changed the PR to draft. What does that mean? I want this code pushed in for sharing in the community ASAP.

@andorsk
Copy link
Contributor

andorsk commented Jan 23, 2023

@darrellodonnell we can talk about the PR, but normally merging the PR into master means that it's accepted as the right thing to do, which requires review.

Since I wasn't sure if you were planning to iterate on this before review, I suggested moving it to draft status until it was ready to be merged in. If you think it's ready to merge, then you can click "ready for review" (above) and we can discuss in more detail during the next TRTF call

@darrellodonnell
Copy link
Collaborator Author

darrellodonnell commented Jan 23, 2023 via email

@andorsk
Copy link
Contributor

andorsk commented Feb 16, 2023

Making this a little more accessible for those that don't understand how to read swagger docs:

Copy this file here in the editor.

image

image

image

graph TD
  subgraph Query
      direction LR
      Issuer
      Verifier
      TrustRegistry[Trust Registry]
      getofflinefile[Offline File]
  end
  subgraph Lookup
      direction LR
      DIDMethods[DID Methods]
      presentationrequests[Presentation Requests]
      credentialTypes[Credential Types]
      overlays[Overlays]
      resources[Resources]
end
Loading

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