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

Issuer Component - GET credential request endpoint (Requester) #6

Closed
Tracked by #416
jjeroch opened this issue Feb 26, 2024 · 2 comments
Closed
Tracked by #416

Issuer Component - GET credential request endpoint (Requester) #6

jjeroch opened this issue Feb 26, 2024 · 2 comments
Assignees
Labels
Sub-task A small piece of work that's part of a larger task.

Comments

@jjeroch
Copy link
Contributor

jjeroch commented Feb 26, 2024

Ticket under creation

Summary

After the initial establishment of the issuer component an endpoint is needed to retrieve existing company credential states, etc.
In detail: I as company user want to know all details of my existing credential requests.

Note: this one is the previous known GET /api/administration/companydata/certificates of the portal with slight changes

Details

Endpoint: /credentialRequests

Method: GET

Response Body:

[
  {
    "credentialType": "TRACEABILITY_FRAMEWORK",
    "credentialRequestDetails": [
      {
        "credentialRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requestStatus": "PENDING",
        "document": {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "documentName": "string"
        }
      }
    ]
  }
]

- credentialType - is the type of the credential. E.g. TraceabilityCredential, etc....
- credentialRequestId - unique ID of the customer credential request 
- requestStatus - status of the customer credential request 
- document - document id and name in case a proof was uploaded by the customer

Explanation:

  • The API endpoint /credentialRequests is used to fetch my company credential requests
  • The request method is GET since we are purely fetching data
  • in case the customer doesn't have any requests, an empty response is send
  • important: I should only be able to receive my company requests => not any other credential requests
@jjeroch jjeroch added enhancement New feature or request Sub-task A small piece of work that's part of a larger task. and removed enhancement New feature or request labels Feb 26, 2024
@jjeroch jjeroch self-assigned this Feb 26, 2024
@jjeroch jjeroch added this to Portal Feb 26, 2024
@jjeroch jjeroch added this to the CX Release 24.05 (dev) milestone Feb 26, 2024
@github-project-automation github-project-automation bot moved this to NEW USER REQUEST in Portal Feb 26, 2024
@jjeroch jjeroch changed the title Issuer Component - GET credential endpoint Issuer Component - GET credential request endpoint Feb 29, 2024
@jjeroch
Copy link
Contributor Author

jjeroch commented Feb 29, 2024

@Phil91 please note that I have some medium changes (described in the description above) compared to the previous used endpoint

@jjeroch
Copy link
Contributor Author

jjeroch commented Feb 29, 2024

@Phil91 since the customer wants to see his/her document as well - I wonder if instead of creating a standalone GET document endpoint; if we rather say we directly respond with the document file in this endpoint. What do you think?

@jjeroch jjeroch moved this from NEW USER REQUEST to BACKLOG in Portal Feb 29, 2024
@Phil91 Phil91 mentioned this issue Mar 8, 2024
9 tasks
@Phil91 Phil91 moved this from BACKLOG to IN REVIEW in Portal Mar 8, 2024
@jjeroch jjeroch changed the title Issuer Component - GET credential request endpoint Issuer Component - GET credential request endpoint (Requester) Mar 21, 2024
Phil91 added a commit that referenced this issue Mar 25, 2024
* feat: add issuer component
* build: add helm chart for issuer component
* feat(notification): adjust notification endpoint
* fix(build): enable build of docker images (#21)
* feat: add callback process step
* chore: enable helm chart (#22)
* fix: remove lint issue
* fix: solve templating issues
* chore: change setup of cronjobs: remove hooks
* chore: change name setup of job resources
* chore: add line breaks
* chore: move placeholder value into resources
* chore: change to unique templates for db subchart
* chore: change secret setup
* chore: move passwords from db dependency to according section
* chore: remove upgrade env file
* chore: change centralidp setup
* chore: rearrange health checks
* chore: rearrange values file
* chore: change ingress to trg-5.04
* chore: fix container name and namespace
* chore: change image tag retrieval
* chore: change version
* chore(db-dependency): change image tag to get latest minor updates
* chore: set resource limits
* chore: update readme files
* chore: change credentialexpiry to camelcase
* chore: fix helm chart, improve workflows and docs (#23)
* chore(helm-test): fix image name and tag override at upgrade
* chore: fix owasp scan
* chore(helm-test and owasp): change set command
* chore: re-arrange values file
* chore(pre-checks): run only on changes to src/**
* docs(CONTRIBUTING.md): update to contribution details
* chore: fix db dependency secret name in cronjobs
* chore(dependencies-check): align file naming and docs
* chore: remove white space

---------

Refs: #2 #3 #4 #5 #6 #7 #8 #9 #13 #21 #22 #23
Reviewed-by: Evelyn Gurschler <[email protected]>
Reviewed-by: Norbert Truchsess <[email protected]>
Co-authored-by: Evelyn Gurschler <[email protected]>
Co-authored-by: Norbert Truchsess <[email protected]>
Phil91 added a commit that referenced this issue Apr 8, 2024
* feat: add issuer component
* build: add helm chart for issuer component
* feat(notification): adjust notification endpoint
* fix(build): enable build of docker images (#21)
* feat: add callback process step
* chore: enable helm chart (#22)
* fix: remove lint issue
* fix: solve templating issues
* chore: change setup of cronjobs: remove hooks
* chore: change name setup of job resources
* chore: add line breaks
* chore: move placeholder value into resources
* chore: change to unique templates for db subchart
* chore: change secret setup
* chore: move passwords from db dependency to according section
* chore: remove upgrade env file
* chore: change centralidp setup
* chore: rearrange health checks
* chore: rearrange values file
* chore: change ingress to trg-5.04
* chore: fix container name and namespace
* chore: change image tag retrieval
* chore: change version
* chore(db-dependency): change image tag to get latest minor updates
* chore: set resource limits
* chore: update readme files
* chore: change credentialexpiry to camelcase
* chore: fix helm chart, improve workflows and docs (#23)
* chore(helm-test): fix image name and tag override at upgrade
* chore: fix owasp scan
* chore(helm-test and owasp): change set command
* chore: re-arrange values file
* chore(pre-checks): run only on changes to src/**
* docs(CONTRIBUTING.md): update to contribution details
* chore: fix db dependency secret name in cronjobs
* chore(dependencies-check): align file naming and docs
* chore: remove white space

---------

Refs: #2 #3 #4 #5 #6 #7 #8 #9 #13 #21 #22 #23
Reviewed-by: Evelyn Gurschler <[email protected]>
Reviewed-by: Norbert Truchsess <[email protected]>
Co-authored-by: Evelyn Gurschler <[email protected]>
Co-authored-by: Norbert Truchsess <[email protected]>
@evegufy evegufy closed this as completed Oct 18, 2024
@github-project-automation github-project-automation bot moved this from IN REVIEW to USER READY in Portal Oct 18, 2024
leandro-cavalcante added a commit to leandro-cavalcante/ssi-credential-issuer that referenced this issue Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Sub-task A small piece of work that's part of a larger task.
Projects
Archived in project
Development

No branches or pull requests

3 participants