@affinidi/internal-api-clients
Version:
SDK core monorepo for affinity DID solution
352 lines (351 loc) • 14.5 kB
TypeScript
declare const _default: {
readonly components: {
readonly examples: {};
readonly headers: {};
readonly parameters: {};
readonly requestBodies: {};
readonly responses: {};
readonly schemas: {
readonly DidAuthRequestTokenInput: {
readonly properties: {
readonly audienceDid: {
readonly type: "string";
};
};
readonly required: readonly ["audienceDid"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly RevocationListCredentialSubject: {
readonly properties: {
readonly id: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
};
readonly encodedList: {
readonly type: "string";
};
};
readonly required: readonly ["id", "type", "encodedList"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly Proof: {
readonly properties: {
readonly type: {
readonly type: "string";
};
readonly created: {
readonly type: "string";
readonly nullable: true;
};
readonly proofPurpose: {
readonly type: "string";
};
readonly verificationMethod: {
readonly type: "string";
};
readonly jws: {
readonly type: "string";
};
};
readonly required: readonly ["type", "proofPurpose", "verificationMethod", "jws"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly Credential: {
readonly properties: {
readonly id: {
readonly type: "string";
};
readonly "@context": {
readonly items: {
readonly type: "string";
};
readonly type: "array";
};
readonly type: {
readonly items: {
readonly type: "string";
};
readonly type: "array";
};
readonly issuer: {
readonly type: "string";
};
readonly issuanceDate: {
readonly type: "string";
};
readonly credentialSubject: {
readonly $ref: "#/components/schemas/RevocationListCredentialSubject";
};
readonly proof: {
readonly $ref: "#/components/schemas/Proof";
};
};
readonly required: readonly ["id", "@context", "type", "issuer", "issuanceDate", "credentialSubject", "proof"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly CredentialStatus: {
readonly properties: {
readonly id: {
readonly type: "string";
};
readonly type: {
readonly type: "string";
};
readonly revocationListIndex: {
readonly type: "string";
};
readonly revocationListCredential: {
readonly type: "string";
};
};
readonly required: readonly ["id", "type", "revocationListIndex", "revocationListCredential"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly RevocationListOutput: {
readonly properties: {
readonly credentialStatus: {
readonly $ref: "#/components/schemas/CredentialStatus";
};
readonly revocationListCredential: {
readonly additionalProperties: true;
readonly type: "object";
};
};
readonly required: readonly ["credentialStatus", "revocationListCredential"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly RevocationListInput: {
readonly properties: {
readonly credentialId: {
readonly type: "string";
};
readonly subjectDid: {
readonly type: "string";
};
};
readonly required: readonly ["credentialId", "subjectDid"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly RevokeCredentialOutput: {
readonly properties: {
readonly revocationListCredential: {
readonly type: "string";
};
};
readonly required: readonly ["revocationListCredential"];
readonly type: "object";
readonly additionalProperties: false;
};
readonly RevokeCredentialInput: {
readonly properties: {
readonly id: {
readonly type: "string";
};
readonly revocationReason: {
readonly type: "string";
readonly nullable: true;
};
};
readonly required: readonly ["id"];
readonly type: "object";
readonly additionalProperties: false;
};
};
readonly securitySchemes: {};
};
readonly info: {
readonly title: "@affinidi/revocation-api";
readonly version: "0.0.1";
readonly description: "Affinity Revocation API";
readonly license: {
readonly name: "ISC";
};
};
readonly openapi: "3.0.0";
readonly paths: {
readonly "/did-auth/create-did-auth-request": {
readonly post: {
readonly operationId: "CreateDidAuthRequest";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly type: "string";
};
};
};
readonly description: "Ok";
};
};
readonly tags: readonly ["DidAuthentication"];
readonly security: readonly [];
readonly parameters: readonly [];
readonly requestBody: {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/DidAuthRequestTokenInput";
};
};
};
};
};
};
readonly "/revocation/revocation-list-2020-credentials/{issuerDid}/{id}": {
readonly get: {
readonly operationId: "GetRevocationListCredential";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/Credential";
};
};
};
readonly description: "Ok";
};
};
readonly description: "Get revocation list 2020 Credential (required to check if VC revoked).";
readonly summary: "Return revocation list credential.";
readonly tags: readonly ["Revocation"];
readonly security: readonly [];
readonly parameters: readonly [{
readonly in: "path";
readonly name: "issuerDid";
readonly required: true;
readonly schema: {
readonly type: "string";
};
}, {
readonly in: "path";
readonly name: "id";
readonly required: true;
readonly schema: {
readonly type: "string";
};
}];
};
};
readonly "/revocation/build-revocation-list-2020-status": {
readonly post: {
readonly operationId: "BuildRevocationListStatus";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/RevocationListOutput";
};
};
};
readonly description: "Ok";
};
};
readonly description: "Build revocation list 2020 status (required parameters for revocable credentials).";
readonly summary: "Build revocation list 2020 credential parameters.";
readonly tags: readonly ["Revocation"];
readonly security: readonly [{
readonly bearerAuth: readonly [];
}];
readonly parameters: readonly [];
readonly requestBody: {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/RevocationListInput";
};
};
};
};
};
};
readonly "/revocation/revoke-credential": {
readonly post: {
readonly operationId: "RevokeCredential";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/RevokeCredentialOutput";
};
};
};
readonly description: "Ok";
};
};
readonly description: "Update index/credetial at appropriate revocation list (set revoken is true).";
readonly summary: "Revoke Credential.";
readonly tags: readonly ["Revocation"];
readonly security: readonly [{
readonly bearerAuth: readonly [];
}];
readonly parameters: readonly [{
readonly in: "header";
readonly name: "Api-Key";
readonly required: true;
readonly schema: {
readonly type: "string";
};
}];
readonly requestBody: {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/RevokeCredentialInput";
};
};
};
};
};
};
readonly "/revocation/publish-revocation-list-credential": {
readonly post: {
readonly operationId: "PublishRevocationListCredential";
readonly responses: {
readonly "200": {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/Credential";
};
};
};
readonly description: "Ok";
};
};
readonly description: "Publish revocation list credential for new created or updated revocation list.";
readonly summary: "Publish Revocation list credential.";
readonly tags: readonly ["Revocation"];
readonly security: readonly [{
readonly bearerAuth: readonly [];
}];
readonly parameters: readonly [];
readonly requestBody: {
readonly content: {
readonly "application/json": {
readonly schema: {
readonly $ref: "#/components/schemas/Credential";
};
};
};
};
};
};
};
readonly servers: readonly [{
readonly url: "/api/v1";
}];
};
export default _default;