Namirasoft API News V1

Namira Software Corporation API News Version 1 (1.4.14)

Install


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

npm i -g namirasoft-api-news-v1

Copied!

Commands


Healthz

Get

Returns the application health status

ns-api-news healthz get

Copied!

News

List

Returns the news list

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

Copied!

Get

Returns a news by an id

ns-api-news news get {id}

Copied!

Category

List

Returns the category list

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

Copied!

Get

Returns a category by an id

ns-api-news category get {id}

Copied!

Schemas


NewsFull

{
  "name": "NewsFull",
  "type": "Object",
  "required": true,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "title": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "description": {
      "type": "String",
      "required": true
    },
    "image": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "source_name": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "source_link": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "tags": {
      "type": "String",
      "required": true,
      "max": 255
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "news_category": {
      "type": "Array",
      "required": false,
      "items": [
        {
          "name": "NewsCategoryFull",
          "type": "Object",
          "required": false,
          "fields": {
            "id": {
              "type": "Integer",
              "required": true
            },
            "news_id": {
              "type": "Integer",
              "required": true
            },
            "category_id": {
              "type": "Integer",
              "required": true
            },
            "created_at": {
              "type": "DateTime",
              "required": true
            },
            "updated_at": {
              "type": "DateTime",
              "required": true
            },
            "category": {
              "name": "Category",
              "type": "Object",
              "required": false,
              "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
                }
              }
            }
          }
        }
      ]
    }
  }
}

NewsCategoryFull

{
  "name": "NewsCategoryFull",
  "type": "Object",
  "required": false,
  "fields": {
    "id": {
      "type": "Integer",
      "required": true
    },
    "news_id": {
      "type": "Integer",
      "required": true
    },
    "category_id": {
      "type": "Integer",
      "required": true
    },
    "created_at": {
      "type": "DateTime",
      "required": true
    },
    "updated_at": {
      "type": "DateTime",
      "required": true
    },
    "category": {
      "name": "Category",
      "type": "Object",
      "required": false,
      "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
        }
      }
    }
  }
}

Category

{
  "name": "Category",
  "type": "Object",
  "required": false,
  "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 2025 Namira Software Corporation. All rights reserved.