Git Product home page Git Product logo

event-checker-'s Introduction

Task -2 : API Documentation

Base URL

https://example.com/api/v1/app

API Endpoints

  1. Create Nudge

    • URL: /nudges
    • Method: POST
    • Payload:
      {
        "title": "string",
        "image_url": "string",
        "scheduled_time": "datetime",
        "description": "string",
        "icon": "string",
        "invitation": "string"
      }
    • Description: Creates a new nudge with the provided details.
  2. Get Nudge by ID

    • URL: /nudges/{nudge_id}
    • Method: GET
    • Description: Retrieves details of a specific nudge identified by its ID.
  3. Update Nudge

    • URL: /nudges/{nudge_id}
    • Method: PUT
    • Payload:
      {
        "title": "string",
        "image_url": "string",
        "scheduled_time": "datetime",
        "description": "string",
        "icon": "string",
        "invitation": "string"
      }
    • Description: Updates details of a specific nudge identified by its ID.
  4. Delete Nudge

    • URL: /nudges/{nudge_id}
    • Method: DELETE
    • Description: Deletes a specific nudge identified by its ID.

CRUD Functionalities Documentation

Create

  • Endpoint: /nudges
  • Method: POST
  • Payload: JSON object containing nudge details.
  • Description: Creates a new nudge with the provided details.

Read

  • Endpoint: /nudges/{nudge_id}
  • Method: GET
  • Description: Retrieves details of a specific nudge identified by its ID.

Update

  • Endpoint: /nudges/{nudge_id}
  • Method: PUT
  • Payload: JSON object containing updated nudge details.
  • Description: Updates details of a specific nudge identified by its ID.

Delete

  • Endpoint: /nudges/{nudge_id}
  • Method: DELETE
  • Description: Deletes a specific nudge identified by its ID.

event-checker-'s People

Contributors

abhinow01 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.