Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pipeline-manager: api: documentation, comments and refactor #1315

Merged
merged 5 commits into from
Jan 24, 2024
Merged

Conversation

snkas
Copy link
Contributor

@snkas snkas commented Jan 23, 2024

The testing part of this PR is postponed to a later PR, instead the general documentation, comment and refactor improvements are done for service, connector and program.

Overview:

  • Update service API comments and documentation
  • Update connector API comments and documentation
  • Update program API comments and documentation
  • Add update_connector_by_name and use it in its PATCH endpoint
  • Add update_program_by_name and use it in its PATCH endpoint
  • Regenerate OpenAPI JSON and Python bindings

EDIT: below the original text:

The primary goal is to have a basic API test that does a mix of GET, PUT, PATCH, POST and DELETE among the endpoints all the object types share. This is both to check for consistency in terms of response codes as well as behavior across the object types. It supplements the other API tests already in integration_test

There will be a separate PR for pipelines after this one. This PR encompasses service, connector and program.

Overview:

  • Update service API comments and annotation
  • Update connector API comments and annotation
  • Add update_connector_by_name and use it in its PATCH endpoint
  • Update program API comments and annotation
  • Add update_program_by_name and use it in its PATCH endpoint
  • Regenerate OpenAPI JSON and Python bindings
  • Basic API test

Is this a user-visible change (yes/no): no

@snkas snkas changed the title pipeline-manager: api: basic api test pipeline-manager: api: annotation, comment and refactor Jan 24, 2024
@snkas snkas changed the title pipeline-manager: api: annotation, comment and refactor pipeline-manager: api: documentation, comments and refactor Jan 24, 2024
Signed-off-by: Simon Kassing <simon.kassing@feldera.com>
Signed-off-by: Simon Kassing <simon.kassing@feldera.com>
Signed-off-by: Simon Kassing <simon.kassing@feldera.com>
Signed-off-by: Simon Kassing <simon.kassing@feldera.com>
Signed-off-by: Simon Kassing <simon.kassing@feldera.com>
@snkas snkas merged commit 3aa7eae into main Jan 24, 2024
5 checks passed
@snkas snkas deleted the basic-api-test branch January 24, 2024 16:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants