Skip to content
Snippets Groups Projects
Commit c05b45b1 authored by Pierre-Jean CHANCELLIER's avatar Pierre-Jean CHANCELLIER
Browse files

graphQL doc update

parent 20426b90
No related branches found
No related tags found
No related merge requests found
# WotWizard GraphQL TypeSystem # WotWizard GraphQL TypeSystem
# https://git.duniter.org/gerard94/WotWizard/-/blob/master/Help/TypeSystem.txt
type Query { type Query {
...@@ -29,13 +30,13 @@ type Query { ...@@ -29,13 +30,13 @@ type Query {
"'wwResult' displays the content of the WotWizard window" "'wwResult' displays the content of the WotWizard window"
wwResult: WWResult! wwResult: WWResult!
"'memEnds' displays the list of members, among the reference list 'group', who are about to loose their memberships, in the increasing order of event dates (bct); 'startFromNow' gives the period (in seconds) before the beginning of the list (0 if absent or null) , and 'period' gives the period covered by the list (infinite if absent or null). If 'group' is null or empty, the reference list is the whole Web Of Trust; if any string in 'group' is empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not empty and unknown, an error is raised" "'memEnds' displays the list of members, among the reference list 'group', who are about to loose their memberships, in the increasing order of event dates (bct); 'startFromNow' gives the period (in seconds) before the beginning of the list (0 if absent or null) , and 'period' gives the period covered by the list (infinite if absent or null). If 'group' is null or empty, the reference list is the whole Web Of Trust; if any string in 'group' is empty or doesn't refer to an identity known by the blockchain, it's not taken into account for the calculation, and, furthermore, if it is not empty and unknown to the blockchain, an error is raised"
memEnds (group: [String!], startFromNow: Int64, period: Int64): [Identity!]! memEnds (group: [String!], startFromNow: Int64, period: Int64): [Identity!]!
"'missEnds' displays the list of identities, among the reference list 'group', who are MISSING and about to be revoked, in the increasing order of event dates (bct); 'startFromNow' gives the period (in seconds) before the beginning of the list (0 if absent or null) , and 'period' gives the period covered by the list (infinite if absent or null). If 'group' is null or empty, the reference list is the whole Web Of Trust; if any string in 'group' is empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not empty and unknown, an error is raised" "'missEnds' displays the list of identities, among the reference list 'group', who are MISSING and about to be revoked, in the increasing order of event dates (bct); 'startFromNow' gives the period (in seconds) before the beginning of the list (0 if absent or null) , and 'period' gives the period covered by the list (infinite if absent or null). If 'group' is null or empty, the reference list is the whole Web Of Trust; if any string in 'group' is empty or doesn't refer to an identity known by the blockchain, it's not taken into account for the calculation, and, furthermore, if it is not empty and unknown to the blockchain, an error is raised"
missEnds (group: [String!], startFromNow: Int64, period: Int64): [Identity!]! missEnds (group: [String!], startFromNow: Int64, period: Int64): [Identity!]!
"'certEnds' displays the list of identities , among the reference list 'group', who are MEMBER or (possibly) MISSING and about to loose their 'ParameterName.sigQty'th oldest certification, in the increasing order of event dates (bct); 'startFromNow' gives the period (in seconds) before the beginning of the list (0 if absent or null) , and 'period' gives the period covered by the list (infinite if absent or null). If 'group' is null or empty, the reference list is the whole Web Of Trust; if any string in 'group' is empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not empty and unknown, an error is raised" "'certEnds' displays the list of identities , among the reference list 'group', who are MEMBER or (possibly) MISSING and about to loose their 'ParameterName.sigQty'th oldest certification, in the increasing order of event dates (bct); 'startFromNow' gives the period (in seconds) before the beginning of the list (0 if absent or null) , and 'period' gives the period covered by the list (infinite if absent or null). If 'group' is null or empty, the reference list is the whole Web Of Trust; if any string in 'group' is empty or doesn't refer to an identity known by the blockchain, it's not taken into account for the calculation, and, furthermore, if it is not empty and unknown to the blockchain, an error is raised"
certEnds (group: [String!], startFromNow: Int64, period: Int64, missingIncluded: Boolean! = true): [Identity!]! certEnds (group: [String!], startFromNow: Int64, period: Int64, missingIncluded: Boolean! = true): [Identity!]!
"'countMin' gives the first block of the blockchain" "'countMin' gives the first block of the blockchain"
...@@ -80,16 +81,16 @@ type Query { ...@@ -80,16 +81,16 @@ type Query {
"'version' returns a string describing the version of the graphQL server" "'version' returns a string describing the version of the graphQL server"
version: String! version: String!
"'calcDist' returns the distance of the identity whose pseudo is 'uid' when the members 'certifiers' are added to her own certifiers. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown, an error is raised; the same for any string in 'certifiers'" "'calcDist' returns the distance of the identity whose pseudo is 'uid' when the members 'certifiers' are added to her own certifiers. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown, an error is raised; the same for any string in 'certifiers', which must also correspond to a member"
calcDist (uid: String, certifiers: [String!]): Distance! calcDist (uid: String, certifiers: [String!]): Distance!
"'calcQual' returns the quality of the identity whose pseudo is 'uid' when the members 'certifiers' are added to her own certifiers. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown, an error is raised; the same for any string in 'certifiers'" "'calcQual' returns the quality of the identity whose pseudo is 'uid' when the members 'certifiers' are added to her own certifiers. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown, an error is raised; the same for any string in 'certifiers', which must also correspond to a member"
calcQual (uid: String, certifiers: [String!]): Fraction! calcQual (uid: String, certifiers: [String!]): Fraction!
"'bestDist' returns a list of members, among the reference list 'group', who could certify the identity whose pseudo is 'uid', together with the distance such a certification would give to the identity. 'certifiers' is a list of members supposed having already certified the identity in addition to her own certifiers. If 'group' is null or empty, the reference list is the whole Web Of Trust. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown, an error is raised; the same for any string in 'group' or 'certifiers', and, furthermore, if the latter is not empty, it should refer to a member. 'answerNb' is the greatest number of answers in the result. If 'answerNb' is null, zero or negative, all answers are returned. Answers are sorted in the decreasing order of 'IdDist.dist.value.ratio'" "'bestDist' returns a list of members, among the reference list 'group', who could certify the identity whose pseudo is 'uid', together with the distance such a certification would give to the identity. 'certifiers' is a list of members supposed having already certified the identity in addition to her own certifiers. If 'group' is null or empty, the reference list is the whole Web Of Trust. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to an identity known by the blockchain, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown to the blockchain, an error is raised; the same for any string in 'group' or 'certifiers', and, furthermore, if the latter is not empty, it should refer to a member. 'answerNb' is the greatest number of answers in the result. If 'answerNb' is null, zero or negative, all answers are returned. Answers are sorted in the decreasing order of 'IdDist.dist.value.ratio'"
bestDist (group: [String!], uid: String, certifiers: [String!], answerNb: Int): [IdDist!]! bestDist (group: [String!], uid: String, certifiers: [String!], answerNb: Int): [IdDist!]!
"'bestQual' returns a list of members, among the reference list 'group', who could certify the identity whose pseudo is 'uid', together with the quality such a certification would give to the identity. 'certifiers' is a list of members supposed having already certified the identity in addition to her own certifiers. If 'group' is null or empty, the reference list is the whole Web Of Trust. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to a known identity, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown, an error is raised; the same for any string in 'group' or 'certifiers', and, furthermore, if the latter is not empty, it should refer to a member. 'answerNb' is the greatest number of answers in the result. If 'answerNb' is null, zero or negative, all answers are returned. Answers are sorted in the decreasing order of 'IdQual.qual.ratio'" "'bestQual' returns a list of members, among the reference list 'group', who could certify the identity whose pseudo is 'uid', together with the quality such a certification would give to the identity. 'certifiers' is a list of members supposed having already certified the identity in addition to her own certifiers. If 'group' is null or empty, the reference list is the whole Web Of Trust. 'uid' may be any string, even null or empty; if 'uid' is null or empty or doesn't refer to an identity known by the blockchain, it's not taken into account for the calculation, and, furthermore, if it is not null, not empty and unknown to the blockchain, an error is raised; the same for any string in 'group' or 'certifiers', and, furthermore, if the latter is not empty, it should refer to a member. 'answerNb' is the greatest number of answers in the result. If 'answerNb' is null, zero or negative, all answers are returned. Answers are sorted in the decreasing order of 'IdQual.qual.ratio'"
bestQual (group: [String!], uid: String, certifiers: [String!], answerNb: Int): [IdQual!]! bestQual (group: [String!], uid: String, certifiers: [String!], answerNb: Int): [IdQual!]!
} #Query } #Query
...@@ -123,28 +124,42 @@ type Subscription { ...@@ -123,28 +124,42 @@ type Subscription {
} #Subscription } #Subscription
"Output of Query.filterGroup, used with a list of statuses; 'selected' owns the uid(s) of identities whose statuses are in the list, 'others' owns those who are not in the list, and 'unknown' corresponds to unknown identities." "Output of Query.filterGroup, used with a list of statuses; 'selected' owns the uid(s) of identities whose statuses are in the list, 'others' owns those who are not in the list, and 'unknown' corresponds to unknown identities; 'duplicate' displays all uid(s) with multiple occurrences in the original list."
type GroupFilter { type GroupFilter {
selected: [String!]!
others: [Error!]! "List of identities in the group whose statuses have been selected"
unknown: [Error!]! selected: [GroupId!]!
duplicate: [Error!]!
"List of identities in the group whose statuses have not been selected"
others: [GroupId!]!
"List of uid(s) in the group who were not found"
unknown: [GroupString!]!
"List of uid(s) with multiple occurrences in the original group"
duplicate: [GroupString!]!
} #Group_Filter } #Group_Filter
type Error { type GroupId {
mes: String!
path: [FieldOrRank!]! "Found Identity"
} #Error id: Identity!
"Index in the original list, starting from 0"
index: Int!
union FieldOrRank = Field | Rank } #GroupId
type Field { type GroupString {
name: String!
} #Field
type Rank { "Uid whose identity has or has not been found"
uid: String!
"Index in the original list, starting from 0"
index: Int! index: Int!
} #Rank
} #GroupString
"WoT identity" "WoT identity"
type Identity { type Identity {
...@@ -178,8 +193,8 @@ type Identity { ...@@ -178,8 +193,8 @@ type Identity {
"Limit date of the membership application; null for REVOKED; limit date before revocation for MISSING" "Limit date of the membership application; null for REVOKED; limit date before revocation for MISSING"
limitDate: Int64 limitDate: Int64
"Limit date of the 'ParameterName.sigQty'th oldest received certification; or null if less than 'ParameterName.sigQty' certifications received" "Limit date of the 'ParameterName.sigQty'th oldest received certification; or null if less than 'ParameterName.sigQty' certifications received; null for REVOKED and NEWCOMER"
certsLimit: Int64 certsLimit: Int64
"Member is leaving? null for REVOKED or NEWCOMER" "Member is leaving? null for REVOKED or NEWCOMER"
...@@ -576,7 +591,7 @@ type Forecast { ...@@ -576,7 +591,7 @@ type Forecast {
"Entry or exit of an identity" "Entry or exit of an identity"
type EventId { type EventId {
member: Identity! id: Identity!
"Entry or exit; true if entry" "Entry or exit; true if entry"
inOut: Boolean! inOut: Boolean!
...@@ -715,16 +730,16 @@ type Fraction { ...@@ -715,16 +730,16 @@ type Fraction {
} #fraction } #fraction
"64 bits signed integer" "64 bits signed integer"
scalar Int64 scalar Int64 @specifiedBy(url: "https://go.dev/ref/spec#Numeric_types")
"Avatar of String" "Avatar of String"
scalar Hash scalar Hash @specifiedBy(url: "https://git.duniter.org/nodes/common/doc/blob/master/rfc/0009_Duniter_Blockchain_Protocol_V11.md")
"Avatar of String" "Avatar of String"
scalar Pubkey scalar Pubkey @specifiedBy(url: "https://git.duniter.org/nodes/common/doc/blob/master/rfc/0009_Duniter_Blockchain_Protocol_V11.md#public-key")
"Empty result" "Empty result"
scalar Void scalar Void
"Int, Int64 or Float" "Int, Int64 or Float"
scalar Number scalar Number @specifiedBy(url: "https://ieeexplore.ieee.org/document/4610935")
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment