diff --git a/docs/openapi/openapi.json b/docs/openapi/openapi.json index 9bb24c21..36d6c853 100644 --- a/docs/openapi/openapi.json +++ b/docs/openapi/openapi.json @@ -1494,6 +1494,12 @@ }, "x-srcprop-pid" : "org.1edtech.ob.v3p0.credentialschema.class" }, + "awardedDate" : { + "type" : "string", + "description" : "Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.", + "format" : "date-time", + "x-srcprop-pid" : "org.1edtech.ob.v3p0.derived.datetimez.class" + }, "endorsement" : { "minItems" : 0, "type" : "array", @@ -1503,12 +1509,6 @@ }, "x-srcprop-pid" : "org.1edtech.ob.v3p0.endorsementcredential.class" }, - "awardedDate" : { - "type" : "string", - "description" : "Timestamp of when the credential was awarded. `issuanceDate` is used to determine the most recent version of a Credential in conjunction with `issuer` and `id`. Consequently, the only way to update a Credental is to update the `issuanceDate`, losing the date when the Credential was originally awarded. `awardedDate` is meant to keep this original date.", - "format" : "date-time", - "x-srcprop-pid" : "org.1edtech.ob.v3p0.derived.datetimez.class" - }, "evidence" : { "minItems" : 0, "type" : "array", @@ -1543,10 +1543,10 @@ "items" : { "description" : "JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied.", "oneOf" : [ { + "$ref" : "#/components/schemas/Map" + }, { "type" : "string", "description" : "A `NormalizedString` that respresents a Uniform Resource Identifier (URI)." - }, { - "$ref" : "#/components/schemas/Map" } ] }, "x-srcprop-pid" : "org.1edtech.ob.v3p0.context.class" @@ -1881,10 +1881,10 @@ "items" : { "description" : "JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied.", "oneOf" : [ { + "$ref" : "#/components/schemas/Map" + }, { "type" : "string", "description" : "A `NormalizedString` that respresents a Uniform Resource Identifier (URI)." - }, { - "$ref" : "#/components/schemas/Map" } ] }, "x-srcprop-pid" : "org.1edtech.ob.v3p0.context.class" diff --git a/docs/openapi/openapi.yaml b/docs/openapi/openapi.yaml index 7e1540eb..940df102 100644 --- a/docs/openapi/openapi.yaml +++ b/docs/openapi/openapi.yaml @@ -1474,15 +1474,6 @@ components: items: $ref: '#/components/schemas/CredentialSchema' x-srcprop-pid: org.1edtech.ob.v3p0.credentialschema.class - endorsement: - minItems: 0 - type: array - description: "Allows endorsers to make specific claims about the credential,\ - \ and the achievement and profiles in the credential. These endorsements\ - \ are signed with a Data Integrity proof format." - items: - $ref: '#/components/schemas/EndorsementCredential' - x-srcprop-pid: org.1edtech.ob.v3p0.endorsementcredential.class awardedDate: type: string description: "Timestamp of when the credential was awarded. `issuanceDate`\ @@ -1493,6 +1484,15 @@ components: \ date." format: date-time x-srcprop-pid: org.1edtech.ob.v3p0.derived.datetimez.class + endorsement: + minItems: 0 + type: array + description: "Allows endorsers to make specific claims about the credential,\ + \ and the achievement and profiles in the credential. These endorsements\ + \ are signed with a Data Integrity proof format." + items: + $ref: '#/components/schemas/EndorsementCredential' + x-srcprop-pid: org.1edtech.ob.v3p0.endorsementcredential.class evidence: minItems: 0 type: array @@ -1531,10 +1531,10 @@ components: description: JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied. oneOf: + - $ref: '#/components/schemas/Map' - type: string description: A `NormalizedString` that respresents a Uniform Resource Identifier (URI). - - $ref: '#/components/schemas/Map' x-srcprop-pid: org.1edtech.ob.v3p0.context.class issuer: $ref: '#/components/schemas/Profile' @@ -1881,10 +1881,10 @@ components: description: JSON-LD Context. Either a URI with the context definition or a Map with a local context definition MUST be supplied. oneOf: + - $ref: '#/components/schemas/Map' - type: string description: A `NormalizedString` that respresents a Uniform Resource Identifier (URI). - - $ref: '#/components/schemas/Map' x-srcprop-pid: org.1edtech.ob.v3p0.context.class issuer: $ref: '#/components/schemas/Profile'