feat: API specs update for version latest - #103
Conversation
Greptile SummaryThis PR refreshes the three latest OpenAPI projections by removing obsolete operation metadata, adding effective method-level platform availability, adjusting platform exposure, and extending the console specification with domain-pricing and usage-related contracts.
Confidence Score: 4/5The PR appears safe to merge, with non-blocking corrections recommended for the new domain-pricing schema. The API projections remain structurally coherent and their new references resolve, but the console pricing contract does not machine-encode two documented input limits and includes an example whose value conflicts with its declared array type. Files Needing Attention: specs/latest/open-api3-latest-console.json Important Files Changed
Prompt To Fix All With AI### Issue 1
specs/latest/open-api3-latest-console.json:29832-29837
**Domain Limit Not Enforced**
The description limits requests to 50 domains, but the array schema has no `maxItems: 50`. Schema-driven clients and validators therefore accept requests that the endpoint contract says are invalid. Add the limit so the machine-readable schema matches the documented API.
### Issue 2
specs/latest/open-api3-latest-console.json:29844-29847
**Minimum Period Not Enforced**
The description requires `periodYears` to be at least 1, but the schema has no `minimum`. This leaves zero and negative values valid according to the machine-readable contract. Add `minimum: 1` so generated validation and documentation reflect the actual requirement.
### Issue 3
specs/latest/open-api3-latest-console.json:140429-140432
**Prices Example Has Wrong Type**
The new example assigns an empty string to `prices`, although `prices` is a required array of `domainPrice` objects. This creates a type-invalid example for generated documentation and other tooling that consumes schema examples.
```suggestion
"example": {
"total": 5,
"prices": []
}
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Reviews (1): Last reviewed commit: "chore: update latest API specs for effec..." | Re-trigger Greptile |
| "schema": { | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, |
There was a problem hiding this comment.
The description limits requests to 50 domains, but the array schema has no maxItems: 50. Schema-driven clients and validators therefore accept requests that the endpoint contract says are invalid. Add the limit so the machine-readable schema matches the documented API.
Prompt To Fix With AI
This is a comment left during a code review.
Path: specs/latest/open-api3-latest-console.json
Line: 29832-29837
Comment:
**Domain Limit Not Enforced**
The description limits requests to 50 domains, but the array schema has no `maxItems: 50`. Schema-driven clients and validators therefore accept requests that the endpoint contract says are invalid. Add the limit so the machine-readable schema matches the documented API.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.| "schema": { | ||
| "type": "integer", | ||
| "format": "uint32", | ||
| "default": 1 |
There was a problem hiding this comment.
The description requires periodYears to be at least 1, but the schema has no minimum. This leaves zero and negative values valid according to the machine-readable contract. Add minimum: 1 so generated validation and documentation reflect the actual requirement.
Prompt To Fix With AI
This is a comment left during a code review.
Path: specs/latest/open-api3-latest-console.json
Line: 29844-29847
Comment:
**Minimum Period Not Enforced**
The description requires `periodYears` to be at least 1, but the schema has no `minimum`. This leaves zero and negative values valid according to the machine-readable contract. Add `minimum: 1` so generated validation and documentation reflect the actual requirement.
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.| "example": { | ||
| "total": 5, | ||
| "prices": "" | ||
| } |
There was a problem hiding this comment.
The new example assigns an empty string to prices, although prices is a required array of domainPrice objects. This creates a type-invalid example for generated documentation and other tooling that consumes schema examples.
| "example": { | |
| "total": 5, | |
| "prices": "" | |
| } | |
| "example": { | |
| "total": 5, | |
| "prices": [] | |
| } |
Prompt To Fix With AI
This is a comment left during a code review.
Path: specs/latest/open-api3-latest-console.json
Line: 140429-140432
Comment:
**Prices Example Has Wrong Type**
The new example assigns an empty string to `prices`, although `prices` is a required array of `domainPrice` objects. This creates a type-invalid example for generated documentation and other tooling that consumes schema examples.
```suggestion
"example": {
"total": 5,
"prices": []
}
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
This PR contains API specification updates for version latest.