#311 Initial openapi changes (DO NOT MERGE!) #314
Conversation
|
|
Summary of ChangesHello @marcel-ouska2, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly expands the OpenAPI specification by introducing a suite of new endpoints and enhancing existing ones. The changes aim to provide more granular control and visibility over decision instances, process definitions, jobs, and incidents, along with improved capabilities for managing process instance variables. The updates also enrich the data models with additional descriptive and state-related fields, facilitating more comprehensive data retrieval and management. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a substantial set of changes to the OpenAPI specification, significantly expanding the API's capabilities. New endpoints have been added for decision instances, process definition statistics, and more detailed job management, which are all valuable additions. The existing endpoints have also been improved with more robust filtering, sorting, and pagination options. Overall, the changes are well-structured and improve the consistency and usability of the API. I've identified a couple of minor inconsistencies that should be addressed to further enhance the API design.
| in: query | ||
| schema: | ||
| type: string | ||
| enum: [createdAt, key, errorType] |
There was a problem hiding this comment.
The sortBy parameter for GET /incidents includes errorType as a possible value. However, the Incident schema does not contain an errorType field. Sorting by a non-existent field will lead to errors. Please remove errorType from the enum.
enum: [createdAt, key]
openapi/api.yaml
Outdated
| /jobs/{key}/retry: | ||
| post: | ||
| operationId: retryJob | ||
| summary: Retry a failed job | ||
| tags: | ||
| - job | ||
| parameters: | ||
| - name: key | ||
| in: path | ||
| required: true | ||
| schema: | ||
| type: integer | ||
| format: int64 | ||
| example: 4503599627370540 |
There was a problem hiding this comment.
For consistency with other job-related endpoints like GET /jobs/{jobKey} and POST /jobs/{jobKey}/assign, the path parameter for retrying a job should be jobKey instead of key. This improves the predictability and maintainability of the API.
/jobs/{jobKey}/retry:
post:
operationId: retryJob
summary: Retry a failed job
tags:
- job
parameters:
- name: jobKey
in: path
required: true
schema:
type: integer
format: int64
example: 4503599627370540
- synchronize with open-api-rework branch
No description provided.