-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: George J Padayatti <[email protected]>
- Loading branch information
1 parent
3c4a45e
commit 549c5a5
Showing
10 changed files
with
193 additions
and
129 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
type: object | ||
title: Pagination | ||
properties: | ||
currentPage: | ||
type: integer | ||
description: Current page number | ||
totalItems: | ||
type: integer | ||
description: Total number of items available | ||
totalPages: | ||
type: integer | ||
description: Total number of pages based on limit | ||
limit: | ||
type: integer | ||
description: Number of items per page | ||
hasPrevious: | ||
type: boolean | ||
description: Indicates if there's a previous page | ||
hasNext: | ||
type: boolean | ||
description: Indicates if there's a next page |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,7 @@ | ||
components: | ||
schemas: | ||
Pagination: | ||
$ref: "./definitions/Pagination.yaml" | ||
Agreement: | ||
$ref: ./definitions/Agreement.yaml | ||
AgreementData: | ||
|
@@ -45,7 +47,8 @@ info: | |
email: [email protected] | ||
name: iGrant.io | ||
url: https://igrant.io | ||
description: The Consent Building Block enables services for individuals to approve | ||
description: | ||
The Consent Building Block enables services for individuals to approve | ||
the use of their personal data by defining the principles, functions, and architecture of | ||
an information system. For organisations that process personal data, it provides | ||
the ability to know the individual's will and legitimately process such personal | ||
|
@@ -196,26 +199,29 @@ paths: | |
post: | ||
$ref: ./paths/serviceVerificationAgreementListFilter.yaml | ||
servers: | ||
- description: Development server | ||
url: https://api.bb-consent.dev/v2 | ||
- description: Staging server | ||
url: https://staging-consent-bb-api.igrant.io/v2 | ||
- description: Demo server | ||
url: https://demo-consent-bb-api.igrant.io/v2 | ||
- description: Development server | ||
url: https://api.bb-consent.dev/v2 | ||
- description: Staging server | ||
url: https://staging-consent-bb-api.igrant.io/v2 | ||
- description: Demo server | ||
url: https://demo-consent-bb-api.igrant.io/v2 | ||
tags: | ||
- description: Operations for external auditing systems to query detailed data from | ||
the system and subscribe to notifications. | ||
name: audit | ||
x-tag-expanded: false | ||
- description: Secured operations available to organization API integration | ||
name: config | ||
x-tag-expanded: false | ||
- description: Secured operations for individuals, data consumers and applications | ||
to record and verify consent | ||
name: service | ||
x-tag-expanded: false | ||
- description: These are used for onboard the organisation, organisation admin and | ||
individual users to the system. It also deals with all authentication and authorisation | ||
APIs that can be configured towards external IDPs. | ||
name: onboard | ||
x-tag-expanded: false | ||
- description: | ||
Operations for external auditing systems to query detailed data from | ||
the system and subscribe to notifications. | ||
name: audit | ||
x-tag-expanded: false | ||
- description: Secured operations available to organization API integration | ||
name: config | ||
x-tag-expanded: false | ||
- description: | ||
Secured operations for individuals, data consumers and applications | ||
to record and verify consent | ||
name: service | ||
x-tag-expanded: false | ||
- description: | ||
These are used for onboard the organisation, organisation admin and | ||
individual users to the system. It also deals with all authentication and authorisation | ||
APIs that can be configured towards external IDPs. | ||
name: onboard | ||
x-tag-expanded: false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
description: Requested index for start of resources to be provided in response requested by client | ||
in: query | ||
name: offset | ||
required: false | ||
schema: | ||
type: integer |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,37 @@ | ||
description: LIST - Fetch all policies | ||
operationId: configListPolicy | ||
parameters: | ||
- description: An object with id revisionId | ||
in: query | ||
name: revisionId | ||
required: false | ||
schema: | ||
type: string | ||
- description: Requested index for start of resources to be provided in response requested | ||
by client | ||
in: query | ||
name: offset | ||
required: false | ||
schema: | ||
type: integer | ||
- description: Requested number of resources to be provided in response requested | ||
by client | ||
in: query | ||
name: limit | ||
required: false | ||
schema: | ||
type: integer | ||
- description: An object with id revisionId | ||
in: query | ||
name: revisionId | ||
required: false | ||
schema: | ||
type: string | ||
- $ref: "../parameters/offset.yaml" | ||
- $ref: "../parameters/limit.yaml" | ||
- $ref: "../parameters/page.yaml" | ||
responses: | ||
'200': | ||
"200": | ||
content: | ||
application/json: | ||
schema: | ||
items: | ||
oneOf: | ||
- $ref: ../definitions/Policy.yaml | ||
type: array | ||
type: object | ||
properties: | ||
policies: | ||
items: | ||
$ref: ../definitions/Policy.yaml | ||
type: array | ||
pagination: | ||
$ref: "../definitions/Pagination.yaml" | ||
description: A list of Policy objects readable for the current session's credentials. | ||
'400': | ||
"400": | ||
description: bad input parameter | ||
security: | ||
- BearerAuth: [] | ||
summary: LIST - Fetch all policies | ||
tags: | ||
- config | ||
- config | ||
x-specification-crudl-model: Policy | ||
x-specification-pii-or-sensitive: 'False' | ||
x-specification-scenario: '' | ||
x-specification-pii-or-sensitive: "False" | ||
x-specification-scenario: "" | ||
x-specification-usecase: UC-C-PIC-A-001, UC-C-PIC-A-002 |
Oops, something went wrong.