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

Documentation improvements. #604

Merged
merged 1 commit into from
Jul 27, 2023
Merged

Documentation improvements. #604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 6 additions & 5 deletions doc/swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1935,9 +1935,9 @@ definitions:
properties:
applicationJwt:
description: |-
Contains the following properties:
Application manifestsdk.CredentialApplication `json:"credential_application" validate:"required"`
Credentials []interface{} `json:"vcs" validate:"required"`
A JWT signed by the applicant. The payload MUST contain the following properties:
- `credential_application`: an object of type manifest.CredentialApplication (specified in https://identity.foundation/credential-manifest/#credential-application).
- `vcs`: an array of Verifiable Credentials.
type: string
required:
- applicationJwt
Expand Down Expand Up @@ -3121,8 +3121,9 @@ paths:
put:
consumes:
- application/json
description: Submit a credential application in response to a credential manifest.
The request body is expected to
description: |-
Submit a credential application in response to a credential manifest. The request body is expected to
be a valid JWT signed by the applicant's DID, containing two top level properties: `credential_application` and `vcs`.
parameters:
- description: request body
in: body
Expand Down
10 changes: 4 additions & 6 deletions pkg/server/router/manifest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,9 +243,9 @@ func (mr ManifestRouter) DeleteManifest(c *gin.Context) {
}

type SubmitApplicationRequest struct {
// Contains the following properties:
// Application manifestsdk.CredentialApplication `json:"credential_application" validate:"required"`
// Credentials []interface{} `json:"vcs" validate:"required"`
// A JWT signed by the applicant. The payload MUST contain the following properties:
// - `credential_application`: an object of type manifest.CredentialApplication (specified in https://identity.foundation/credential-manifest/#credential-application).
// - `vcs`: an array of Verifiable Credentials.
ApplicationJWT keyaccess.JWT `json:"applicationJwt" validate:"required"`
}

Expand Down Expand Up @@ -317,9 +317,7 @@ type SubmitApplicationResponse struct {
//
// @Summary Submit application
// @Description Submit a credential application in response to a credential manifest. The request body is expected to
//
// be a valid JWT signed by the applicant's DID, containing two top level properties: credential_application and vcs.
//
// @Description be a valid JWT signed by the applicant's DID, containing two top level properties: `credential_application` and `vcs`.
// @Tags ApplicationAPI
// @Accept json
// @Produce json
Expand Down
Loading