Generated go sdk for the vikunja api
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

5.9 KiB

\NamespaceApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
NamespaceIdPost Post /namespace/{id} Updates a namespace
NamespacesGet Get /namespaces Get all namespaces a user has access to
NamespacesIdDelete Delete /namespaces/{id} Deletes a namespace
NamespacesIdGet Get /namespaces/{id} Gets one namespace
NamespacesIdListsGet Get /namespaces/{id}/lists Get all lists in a namespace
NamespacesPut Put /namespaces Creates a new namespace

NamespaceIdPost

ModelsNamespace NamespaceIdPost(ctx, id, namespace) Updates a namespace

Updates a namespace.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 Namespace ID
namespace ModelsNamespace The namespace with updated values you want to update.

Return type

ModelsNamespace

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NamespacesGet

[]ModelsNamespaceWithLists NamespacesGet(ctx, optional) Get all namespaces a user has access to

Returns all namespaces a user has access to.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
p int32 The page number. Used for pagination. If not provided, the first page of results is returned.
s string Search namespaces by name.

Return type

**[]ModelsNamespaceWithLists**

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NamespacesIdDelete

ModelsMessage NamespacesIdDelete(ctx, id) Deletes a namespace

Delets a namespace

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 Namespace ID

Return type

ModelsMessage

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NamespacesIdGet

ModelsNamespace NamespacesIdGet(ctx, id) Gets one namespace

Returns a namespace by its ID.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 Namespace ID

Return type

ModelsNamespace

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NamespacesIdListsGet

[]ModelsList NamespacesIdListsGet(ctx, id) Get all lists in a namespace

Returns all lists inside of a namespace.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id int32 Namespace ID

Return type

**[]ModelsList**

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NamespacesPut

ModelsNamespace NamespacesPut(ctx, namespace) Creates a new namespace

Creates a new namespace.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
namespace ModelsNamespace The namespace you want to create.

Return type

ModelsNamespace

Authorization

JWTKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]