feat(specs): create ingestion specs #1100
Conversation
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
millotp
force-pushed
the
feat/ingestion-client
branch
from
98e6ec5 to
fbec6ec
Compare
| type: object | ||
| additionalProperties: false | ||
| properties: | ||
| runID: |
There was a problem hiding this comment.
we could use a ref from specs/ingestion/common/parameters.yml same for events
There was a problem hiding this comment.
the parameters in parameters.yml are used for path or query params, not sure they would fit in this object
| # lastCursorValue: | ||
| # type: integer | ||
| # format: int64 |
There was a problem hiding this comment.
is there an issue with that field?
There was a problem hiding this comment.
It's not yet used in our API. It will always be null.
It will be used in the future, for tools that need many run to overview all the data of a Source.
There was a problem hiding this comment.
plus one with @Fluf22, there is no point in exposing it right now
There was a problem hiding this comment.
oki we can remove it then if we don't mind now
millotp
force-pushed
the
feat/ingestion-client
branch
from
5845069 to
e5b5230
Compare
| $ref: './common.yml#/createdAt' | ||
| required: | ||
| - authenticationID | ||
| - name |
There was a problem hiding this comment.
this API is so different than the others :( we should maybe focus on making it more consistent
There was a problem hiding this comment.
it's already better now !
| /1/runs: | ||
| $ref: 'paths/runs/runs.yml' |
There was a problem hiding this comment.
you can add the run/task/{taskID} if you want
|
I'll remove sources in another PR :) |
algolia/api-clients-automation#1100 Co-authored-by: Pierre Millot <[email protected]>
algolia/api-clients-automation#1100 Co-authored-by: Pierre Millot <[email protected]>
🧭 What and Why
🎟 JIRA Ticket: DI-382
Create the openapi specification for the Ingestion API (repository, RFC).
This first PR is missing the pagination because it's not clear how it will be handled (body or query params).
It's also missing a lot of
descriptionfields, but we can definitely improve on the doc in the future.