Namirasoft API Service V1

Namira Software Corporation API Service Version 1 (1.5.0)

Install


To use this cli, we need to first Install Nodejs, then run the following command.

npm i -g namirasoft-api-service-v1

Copied!

Commands


Health

Liveness

Returns the application liveness status

ns-api-service health liveness

Copied!

Readiness

Returns the application readiness status

ns-api-service health readiness

Copied!

Metrics

Get

Returns the application metrics

ns-api-service metrics get

Copied!

Category

List

Returns the category list

ns-api-service category list {filters} {page} {size} {sorts}

Copied!

Get

Returns a category by an id

ns-api-service category get {id}

Copied!

Service

List

Returns the service list

ns-api-service service list {filters} {page} {size} {sorts}

Copied!

Get

Returns a service by an id

ns-api-service service get {id}

Copied!

Schemas


Category

{
    "name": "Category",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "Integer",
            "required": true
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        }
    }
}

ServiceFull

{
    "name": "ServiceFull",
    "type": "Object",
    "required": true,
    "fields": {
        "id": {
            "type": "Integer",
            "required": true
        },
        "category_id": {
            "type": "Integer",
            "required": true
        },
        "name": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "headline": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "url": {
            "type": "String",
            "required": true,
            "max": 255
        },
        "logo": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "image": {
            "type": "String",
            "required": false,
            "max": 255
        },
        "description": {
            "type": "String",
            "required": true
        },
        "created_at": {
            "type": "DateTime",
            "required": true
        },
        "updated_at": {
            "type": "DateTime",
            "required": true
        },
        "category": {
            "name": "Category",
            "type": "Object",
            "required": true,
            "fields": {
                "id": {
                    "type": "Integer",
                    "required": true
                },
                "name": {
                    "type": "String",
                    "required": true,
                    "max": 255
                },
                "created_at": {
                    "type": "DateTime",
                    "required": true
                },
                "updated_at": {
                    "type": "DateTime",
                    "required": true
                }
            }
        }
    }
}

Enums

Namira Software Corporation

©Copyright 2010 to 2026 Namira Software Corporation. All rights reserved.