Giter Site home page Giter Site logo

ga-backend's Introduction

caf v0.0.1

Article

Create Article

Back to top

POST /articles

Success 201

Name Type Description
Article Article

Article's data.

Delete Article

Back to top

DELETE /articles/:id

Success 204

Name Type Description
204

No Content.

Retrieve Article

Back to top

GET /articles/:id

Success 200

Name Type Description
Article Article

Article's data.

List articles

Back to top

GET /articles

Parameter Parameters

Name Type Description
page Number optional

Page number.

Default value: 1
Size range: 1..30
limit Number optional

Amount of returned items.

Default value: 30
Size range: 1..100
sort String[] optional

Order of returned items.

Default value: -createdAt
fields String[] optional

Fields to be returned.
singleFieldValue String[fieldName] optional

filter by element value.

Success 200

Name Type Description
articles Article[]

List of articles.

Update Article

Back to top

PUT /articles/:id

Success 200

Name Type Description
Article Object

Article's data.

Auth

Authenticate

Back to top

POST /auth

Success 201

Name Type Description
token String

User access_token to be passed to other requests.
user User

Current user's data.

Register an user

Back to top

POST /auth/register

Parameter Parameters

Name Type Description
access_token String

Master access_token.

Success 201

Name Type Description
user User

User's data.

Renew JWT

Back to top

GET /auth/renewJWT

Parameter Parameters

Name Type Description
access_token String

access_token.

Success 201

Name Type Description
token String

User access_token to be passed to other requests.
user User

Current user's data.

Client

Create Client

Back to top

POST /clients

Success 201

Name Type Description
Client Client

Client's data.

Delete Client

Back to top

DELETE /clients/:id

Success 204

Name Type Description
204

No Content.

Retrieve Client

Back to top

GET /clients/:id

Success 200

Name Type Description
Client Client

Client's data.

List clients

Back to top

GET /clients

Parameter Parameters

Name Type Description
page Number optional

Page number.

Default value: 1
Size range: 1..30
limit Number optional

Amount of returned items.

Default value: 30
Size range: 1..100
sort String[] optional

Order of returned items.

Default value: -createdAt
fields String[] optional

Fields to be returned.
singleFieldValue String[fieldName] optional

filter by element value.

Success 200

Name Type Description
clients Client[]

List of clients.

Update Client

Back to top

PUT /clients/:id

Success 200

Name Type Description
Client Object

Client's data.

CommonSchemas

Back to top

JS personalInfoSchema

Examples

Entity schema: */

  {
    streetName: {
      type: String
    },
    zipCode: {
      type: String
    },
    city: {
      type: String
    },
    province: {
      type: String
    },
    region: {
      type: String
    },
    state: {
      type: String
    },
    vatNumber: {
      type: String
    },
    telephone: {
      type: String
    }
  };
/*

Recepit

Create Recepit

Back to top

POST /recepits

Success 201

Name Type Description
Recepit Recepit

Recepit's data.

Delete Recepit

Back to top

DELETE /recepits/:id

Success 204

Name Type Description
204

No Content.

generate recepit pdf from groups

Back to top

POST /recepits/:id/pdf

Success 200

Name Type Description
Recepit Object

Recepit's data.

Retrieve Recepit

Back to top

GET /recepits/:id

Success 200

Name Type Description
Recepit Recepit

Recepit's data.

List recepits

Back to top

GET /recepits

Parameter Parameters

Name Type Description
page Number optional

Page number.

Default value: 1
Size range: 1..30
limit Number optional

Amount of returned items.

Default value: 30
Size range: 1..100
sort String[] optional

Order of returned items.

Default value: -createdAt
fields String[] optional

Fields to be returned.
singleFieldValue String[fieldName] optional

filter by element value.

Success 200

Name Type Description
recepits Recepit[]

List of recepits.

Update Recepit

Back to top

PUT /recepits/:id

Success 200

Name Type Description
Recepit Object

Recepit's data.

User

Create user

Back to top

POST /users

Success 201

Name Type Description
user User

User's data.

Delete user

Back to top

DELETE /users/:id

Success 204

Name Type Description
204

No Content.

Delete current user

Back to top

DELETE /users/me

Success 204

Name Type Description
204

No Content.

Retrieve user

Back to top

GET /users/:id

Success 200

Name Type Description
user User

User's data.

List users

Back to top

GET /users

Parameter Parameters

Name Type Description
page Number optional

Page number.

Default value: 1
Size range: 1..30
limit Number optional

Amount of returned items.

Default value: 30
Size range: 1..100
sort String[] optional

Order of returned items.

Default value: -createdAt
fields String[] optional

Fields to be returned.
singleFieldValue String[fieldName] optional

filter by element value.

Success 200

Name Type Description
users User[]

List of users.

Retrieve current user

Back to top

GET /users/me

Success 200

Name Type Description
user User

User's data.

Update user

Back to top

PUT /users/:id

Success 200

Name Type Description
user Object

User's data.

Update password

Back to top

PUT /users/:id/password

Headers

Name Type Description
Authorization String

Basic authorization with email and password.

Success 201

Name Type Description
user User

User's data.

Reset other users password

Back to top

PUT /users/:id/passwordReset

Success 201

Name Type Description
user Object

User's data.

ga-backend's People

Contributors

marco-bertelli 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.