man.sr.ht API Documentation

This is the GraphQL API documentation for the SourceHut service man.sr.ht. It was generated from the service's GraphQL Schema definition.

To get started, also check out SourceHut's general GraphQL API conventions.

version

Returns API version information.

Returns Version!

query version {
    version {
        major
        minor
        patch
        buildVersion
        buildDate
        deprecationDate
    }
}

deleteUser

Deletes the authenticated user's account. Internal use only.

Returns Int!

mutation deleteUser {
    deleteUser
}

Boolean

The Boolean scalar type represents true or false.

Cursor

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

ID

A unique identifier representing a resource available via the API, represented as an arbitrary, opaque string. These IDs are guaranteed to remain stable as a resource is renamed, moved between owners, etc. Often referred to as a "resource ID" or "rid".

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Time

Upload

Version

1. major - Int!
2. minor - Int!
3. patch - Int!
4. buildVersion - String!
5. buildDate - String!
6. deprecationDate - Time
   • If this API version is scheduled for deprecation, this is the date on which it will stop working; or null if this API version is not scheduled for deprecation.

@defer

Directs the executor to defer this fragment when the if argument is true or undefined.

1. if - Boolean
   • Deferred when true or undefined.
2. label - String
   • Unique name

@deprecated

Marks an element of a GraphQL schema as no longer supported.

1. reason - String
   • Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).

@include

Directs the executor to include this field or fragment only when the if argument is true.

1. if - Boolean!
   • Included when true.

@internal

This used to decorate fields which are for internal use, and are not available to normal API users.

@oneOf

Indicates exactly one field must be supplied and this field must not be null.

@skip

Directs the executor to skip this field or fragment when the if argument is true.

1. if - Boolean!
   • Skipped when true.

@specifiedBy

Exposes a URL that specifies the behavior of this scalar.

1. url - String!
   • The URL that specifies the behavior of this scalar.