doc-detective-common 3.4.0 → 3.4.1-dev.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -2503,6 +2503,14 @@
2503
2503
  }
2504
2504
  ],
2505
2505
  "default": {}
2506
+ },
2507
+ "required": {
2508
+ "type": "array",
2509
+ "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
2510
+ "items": {
2511
+ "type": "string"
2512
+ },
2513
+ "default": []
2506
2514
  }
2507
2515
  },
2508
2516
  "title": "Response"
@@ -2894,6 +2902,14 @@
2894
2902
  }
2895
2903
  ],
2896
2904
  "default": {}
2905
+ },
2906
+ "required": {
2907
+ "type": "array",
2908
+ "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
2909
+ "items": {
2910
+ "type": "string"
2911
+ },
2912
+ "default": []
2897
2913
  }
2898
2914
  },
2899
2915
  "title": "Response"
@@ -3075,6 +3091,52 @@
3075
3091
  "request": {
3076
3092
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
3077
3093
  }
3094
+ },
3095
+ {
3096
+ "url": "https://api.example.com/users/123",
3097
+ "response": {
3098
+ "required": [
3099
+ "id",
3100
+ "email",
3101
+ "createdAt"
3102
+ ]
3103
+ }
3104
+ },
3105
+ {
3106
+ "url": "https://api.example.com/users/123",
3107
+ "response": {
3108
+ "required": [
3109
+ "user.profile.name",
3110
+ "user.profile.avatar",
3111
+ "user.settings.notifications"
3112
+ ]
3113
+ }
3114
+ },
3115
+ {
3116
+ "url": "https://api.example.com/orders",
3117
+ "response": {
3118
+ "required": [
3119
+ "orders[0].id",
3120
+ "orders[0].total",
3121
+ "orders[0].items[0].productId"
3122
+ ]
3123
+ }
3124
+ },
3125
+ {
3126
+ "url": "https://api.example.com/users",
3127
+ "response": {
3128
+ "required": [
3129
+ "sessionToken",
3130
+ "expiresAt",
3131
+ "user.id"
3132
+ ],
3133
+ "body": {
3134
+ "status": "success",
3135
+ "user": {
3136
+ "role": "admin"
3137
+ }
3138
+ }
3139
+ }
3078
3140
  }
3079
3141
  ]
3080
3142
  }
@@ -8265,6 +8327,14 @@
8265
8327
  }
8266
8328
  ],
8267
8329
  "default": {}
8330
+ },
8331
+ "required": {
8332
+ "type": "array",
8333
+ "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
8334
+ "items": {
8335
+ "type": "string"
8336
+ },
8337
+ "default": []
8268
8338
  }
8269
8339
  },
8270
8340
  "title": "Response"
@@ -8656,6 +8726,14 @@
8656
8726
  }
8657
8727
  ],
8658
8728
  "default": {}
8729
+ },
8730
+ "required": {
8731
+ "type": "array",
8732
+ "description": "Array of field paths that must exist in the response body. Uses dot notation for nested fields (e.g., 'user.name') and bracket notation for array indices (e.g., 'items[0].id'). Fields must be present but may have any value including null.",
8733
+ "items": {
8734
+ "type": "string"
8735
+ },
8736
+ "default": []
8659
8737
  }
8660
8738
  },
8661
8739
  "title": "Response"
@@ -8837,6 +8915,52 @@
8837
8915
  "request": {
8838
8916
  "headers": "Content-Type: application/json\\nAuthorization: Bearer token"
8839
8917
  }
8918
+ },
8919
+ {
8920
+ "url": "https://api.example.com/users/123",
8921
+ "response": {
8922
+ "required": [
8923
+ "id",
8924
+ "email",
8925
+ "createdAt"
8926
+ ]
8927
+ }
8928
+ },
8929
+ {
8930
+ "url": "https://api.example.com/users/123",
8931
+ "response": {
8932
+ "required": [
8933
+ "user.profile.name",
8934
+ "user.profile.avatar",
8935
+ "user.settings.notifications"
8936
+ ]
8937
+ }
8938
+ },
8939
+ {
8940
+ "url": "https://api.example.com/orders",
8941
+ "response": {
8942
+ "required": [
8943
+ "orders[0].id",
8944
+ "orders[0].total",
8945
+ "orders[0].items[0].productId"
8946
+ ]
8947
+ }
8948
+ },
8949
+ {
8950
+ "url": "https://api.example.com/users",
8951
+ "response": {
8952
+ "required": [
8953
+ "sessionToken",
8954
+ "expiresAt",
8955
+ "user.id"
8956
+ ],
8957
+ "body": {
8958
+ "status": "success",
8959
+ "user": {
8960
+ "role": "admin"
8961
+ }
8962
+ }
8963
+ }
8840
8964
  }
8841
8965
  ]
8842
8966
  }