[DRAFT] Create API contracts

[vikhyat187]

Contracts

Data model #96

Routes

Create a feature flag:

POST {{base_url}}/feature-flags/

• Params None
• Query None
• Body

  {
  'id': string,
  'name': string,
  'description': string,
  'createdBy': string,
  'createdAt': number
  }

• Headers None
• Cookie (rds-session: )
• Success Response: Code: 200 Content:

  { "message" : "feature flag created successfully"}

Get feature flag

GET {{base_url}}/feature-flags/:flagId

• Params flagId - string
• Query None
• Body None
• Headers Content-Type: application/json
• Cookie rds-session:
• Success Response: Code: 200 Content:

  {
  "message": "feature flag returned successfully",
  "data": {
  "flagId": "String",
  "flagName": "test"
  }
  }

  Get all feature flags

  GET {{base_url}}/feature-flags/

• Params None
• Query None
• Body None
• Headers Content-Type: application/json
• Cookie None
• Success Response: Code: 200 Content:

  {
  "message": "feature flags returned successfully",
  "data": [
  {
    "flagId": "String",
    "flagName": "test"
  },
  {
    "flagId": "String",
    "flagName": "test"
  }
  ]
  }

Edit feature flag

PUT {{base_url}}/feature-flags/?flagId=flagId

• Params None
• Query flagId - string
• Body None
• Headers Content-Type: application/json
• Cookie rds-session:
• Success Response: Code: 200 Content:

  {
  "message": "feature flag updated successfully"
  }

Delete feature flag (should we soft delete(add a deletedAt column or remove the entry from db)

DELETE {{base_url}}/feature-flags/?flagId=flagId

• Params None
• Query flagId - String
• Body None
• Headers Content-Type: application/json
• Cookie None
• Success Response: Code: 200 Content:

  {
  "message": "feature flag deleted successfully"
  }

Check if the feature flag is enabled for user Id: (will update as per data model)

Given a user fetch all features enabled. (Need to update on deciding the approach for model)

Enable feature flag for User Id: (this will decide after finalising data model)

[gauravv-dev]

Some thoughts

• Don't think we need "message" in the response payload for success. If we want to keep it just an "ok" would be sufficient. In case of errors, it is definitely important and should be concise and helpful for the client combined with appropriate error messages.
• Created HTTP code is 201.
• Instead of documenting the contracts here I would strongly suggest using Open API specification. There's good tooling around it so you could do a lot with that.

[vikhyat187]

Don't think we need "message" in the response payload for success. If we want to keep it just an "ok" would be sufficient. In case of errors, it is definitely important and should be concise and helpful for the client combined with appropriate error messages. Created HTTP code is 201.

Noted, will use that

Instead of documenting the contracts here I would strongly suggest using Open API specification. There's good tooling around it so you could do a lot with that.

will try this out