Problem Details (RFC 7807) format in Rest API - Time & Space Complexity

Time Complexity: Problem Details (RFC 7807) format

O(n)

Understanding Time Complexity

When using the Problem Details format in REST APIs, it's important to understand how the time to create and send error responses grows as the number of error details increases.

We want to know how the processing time changes when more problem details are included.

Scenario Under Consideration

Analyze the time complexity of the following code snippet.

// Pseudocode for building a Problem Details response
function createProblemDetails(errors) {
  let problem = {
    type: "https://example.com/probs/out-of-credit",
    title: "You do not have enough credit.",
    status: 403,
    detail: "Your current balance is 30, but that costs 50.",
    instance: "/account/12345/transactions/abc",
    errors: {}
  };

  for (let err of errors) {
    problem.errors[err.field] = err.message;
  }

  return problem;
}

This code builds a Problem Details JSON object including multiple error messages keyed by field names.

Identify Repeating Operations

Identify the loops, recursion, array traversals that repeat.

• Primary operation: Looping over the list of error objects to add each error to the response.
• How many times: Once for each error in the input list.

How Execution Grows With Input

As the number of errors increases, the time to build the response grows proportionally.

Input Size (n)	Approx. Operations
10	10 additions to the errors object
100	100 additions to the errors object
1000	1000 additions to the errors object

Pattern observation: The work grows directly with the number of errors; doubling errors doubles the work.

Final Time Complexity

Time Complexity: O(n)

This means the time to build the Problem Details response grows linearly with the number of error details included.

Common Mistake

[X] Wrong: "Adding more error details won't affect response time much because it's just a small object."

[OK] Correct: Each error detail requires an operation to add it to the response, so more errors mean more work and longer processing time.

Interview Connect

Understanding how error response building scales helps you design APIs that handle errors efficiently and predict performance as input grows.

Self-Check

"What if the errors were nested objects instead of simple messages? How would that affect the time complexity?"

Practice

1. What is the main purpose of the Problem Details (RFC 7807) format in REST APIs?

easy

A. To speed up API response times

B. To standardize error responses so clients can understand errors better

C. To encrypt API responses for security

D. To format successful data responses uniformly

Solution

1. Step 1: Understand the role of Problem Details format

   The format is designed to provide a consistent way to report errors in APIs.

2. Step 2: Identify the main benefit

   It helps clients understand and handle errors better by standardizing error responses.

3. Final Answer:

   To standardize error responses so clients can understand errors better -> Option B

4. Quick Check:

   Purpose = Standardize error responses [OK]

Hint: Remember: Problem Details = standardized error info [OK]

Common Mistakes:

• Confusing error format with data encryption
• Thinking it speeds up API responses
• Assuming it formats successful responses

2. Which of the following is a REQUIRED field in the Problem Details JSON object according to RFC 7807?

easy

A. type

B. status

C. detail

D. instance

Solution

1. Step 1: Recall required fields in RFC 7807

   The RFC requires the "type" field to identify the error type URI.

2. Step 2: Check other fields

   Fields like "status", "detail", and "instance" are optional but recommended.

3. Final Answer:

   type -> Option A

4. Quick Check:

   Required field = type [OK]

Hint: Only 'type' is mandatory in Problem Details [OK]

Common Mistakes:

• Assuming 'status' is required
• Confusing 'detail' as mandatory
• Thinking 'instance' is always needed

3. Given this Problem Details JSON response:

{"type": "https://example.com/probs/out-of-credit", "title": "You do not have enough credit.", "status": 403, "detail": "Your current balance is 30, but that costs 50.", "instance": "/account/12345/msgs/abc"}

What is the HTTP status code indicated?

medium

A. 403

B. 404

C. 200

D. 500

Solution

1. Step 1: Locate the status field in JSON

   The JSON has "status": 403, which indicates the HTTP status code.

2. Step 2: Understand the meaning of 403

   403 means Forbidden, matching the error about insufficient credit.

3. Final Answer:

   403 -> Option A

4. Quick Check:

   Status code = 403 [OK]

Hint: Look for 'status' field for HTTP code [OK]

Common Mistakes:

• Confusing status with 'detail' content
• Picking 200 as success code
• Ignoring the numeric status field

4. You receive this Problem Details JSON:

{"title": "Invalid input", "status": 400, "detail": "Missing required field 'name'"}

What is missing that violates RFC 7807 requirements?

medium

A. The 'title' field should be a URL

B. The 'status' field should be a string

C. The 'detail' field should be omitted

D. The 'type' field is missing

Solution

1. Step 1: Check required fields in the JSON

   The 'type' field is required by RFC 7807 but is missing here.

2. Step 2: Validate other fields

   'status' is correctly a number, 'detail' and 'title' are valid types.

3. Final Answer:

   The 'type' field is missing -> Option D

4. Quick Check:

   Missing required field = type [OK]

Hint: Always include 'type' field in Problem Details [OK]

Common Mistakes:

• Thinking 'status' must be string
• Removing 'detail' field
• Assuming 'title' must be URL

5. You want to create a Problem Details response for a rate limit error. Which JSON object correctly follows RFC 7807 and clearly informs the client about the error?

hard

A. {"type": "rate-limit", "title": "Error", "status": 429, "detail": "Limit reached"}

B. {"title": "Rate limit exceeded", "status": "429", "detail": "Too many requests", "instance": "/api/v1/resource"}

C. {"type": "https://example.com/probs/rate-limit", "title": "Rate limit exceeded", "status": 429, "detail": "You have sent too many requests in a short time.", "instance": "/api/v1/resource"}

D. {"type": "https://example.com/probs/rate-limit", "title": "Rate limit exceeded", "status": 200, "detail": "Too many requests"}

Solution

1. Step 1: Check required fields and correct types

   {"type": "https://example.com/probs/rate-limit", "title": "Rate limit exceeded", "status": 429, "detail": "You have sent too many requests in a short time.", "instance": "/api/v1/resource"} includes 'type' as a URI, 'title', numeric 'status' 429, 'detail', and 'instance' fields correctly.

2. Step 2: Validate status code and clarity

   Status 429 means Too Many Requests, matching the error. Other options have missing or wrong fields or wrong status codes.

3. Final Answer:

   {"type": "https://example.com/probs/rate-limit", "title": "Rate limit exceeded", "status": 429, "detail": "You have sent too many requests in a short time.", "instance": "/api/v1/resource"} -> Option C

4. Quick Check:

   Correct fields and status = {"type": "https://example.com/probs/rate-limit", "title": "Rate limit exceeded", "status": 429, "detail": "You have sent too many requests in a short time.", "instance": "/api/v1/resource"} [OK]

Hint: Use URI in 'type' and correct numeric 'status' [OK]

Common Mistakes:

• Using string instead of number for status
• Missing 'type' or using non-URI string
• Wrong HTTP status code for error