Yeah. Github API makes sense.

Actually - I think we don't even have to move it,
 I just looked it up as I have not realised that the Docs are indexed and
linked nicely already.

hhttps://
github.com/apache/airflow-client-python/blob/master/airflow_client/README.md
- so I think we just need to update the link in our documentation to point
directly there :)

Currently the "Documentation" link goes to the whole "repo" which is
misleading, because you might not realise that you have this nicely
viewable Github Docs. I will update the link now to point to that README
instead.

And removing them from the package later I guess.

J

On Thu, Jul 28, 2022 at 7:01 PM Sumit Maheshwari <sumeet.ma...@gmail.com>
wrote:

> Thanks Jarek,
>
> Yeah, I don't think that any of the existing issues got fixed in this
> release. To fix these issues we prolly need to make changes to the main
> Airflow code base only, prolly only in the v1.yaml
> <https://github.com/apache/airflow/blob/main/airflow/api_connexion/openapi/v1.yaml>
> file.
>
> Regarding the docs, I think we just need to move it up within the same
> client repo (like Ash said), cause generally there would be too many
> changes happening in those docs with every release, and if we start keeping
> such docs from all clients (for now python and go only) then it would
> result in big commits which are auto-populated.
>
> Also, if I'm correct some other popular clients (for example Kubernetes)
> follow the same, i.e. Github-based API documentation.
>
>
>
> On Thu, Jul 28, 2022 at 6:31 PM Jarek Potiuk <ja...@potiuk.com> wrote:
>
>> +1 (binding) I checked sources/signatures/checksums and runs the API
>> calls using the
>> https://github.com/apache/airflow-client-python/blob/master/dev/test_python_client.py
>> against running Airflow 2.3.3 installation.
>>
>> However, when using the test client script, I have found that we still
>> have the issue https://github.com/apache/airflow-client-python/issues/21
>> .
>> This is not a regression so it does not block the release - but it
>> basically makes it impossible to do DAG triggering via the client as dag_id
>> is treated as read-only.
>> I am not sure if we want to do anything with it, just wanted to mention
>> that it is still there.
>>
>> Also following Ash's comment -  we have the "docs" folder containing .md
>> files which does not seem to be very useful as part of the package (not too
>> much at least - it's hard to discover I think - unless I miss something).
>> Should we maybe remove it too and make it part of the documentation
>> https://airflow.apache.org/docs/ ? Currently it redirects to the repo,
>> but having the docs on our side would be a nice touch.
>>
>> J.
>>
>>
>>
>> On Thu, Jul 28, 2022 at 2:04 PM Sumit Maheshwari <sumeet.ma...@gmail.com>
>> wrote:
>>
>>> Nit though: we are shipping airflow_client/tests/ in the installed wheel
>>>> which we shouldn't do. (Since it's under airflow_client/ folder we don't
>>>> need to fix it now, but we should fix it before the next release please)
>>>
>>>
>>> Yeah, nice suggestion. We'll change the generator script to move out the
>>> test dir and modify GitHub actions as well accordingly before the next
>>> release.
>>>
>>>
>>> On Thu, Jul 28, 2022 at 5:13 PM Ash Berlin-Taylor <a...@apache.org>
>>> wrote:
>>>
>>>> +1 (binding)
>>>>
>>>> Nit though: we are shipping airflow_client/tests/ in the installed
>>>> wheel which we shouldn't do. (Since it's under airflow_client/ folder we
>>>> don't need to fix it now, but we should fix it before the next release
>>>> please)
>>>>
>>>> -ash
>>>>
>>>> On Thu, Jul 28 2022 at 01:19:53 +05:30:00, Sumit Maheshwari <
>>>> sumeet.ma...@gmail.com> wrote:
>>>>
>>>> Hello everyone,
>>>>
>>>> I have cut the first release candidate for
>>>> the Airflow Python Client 2.3.0. The client consists of APIs corresponding
>>>> to REST APIs available in *Apache Airflow 2.3.3* release. This email
>>>> is calling for a vote on the release, which will last for 72 hours.
>>>> Consider this my (binding) +1.
>>>>
>>>> Airflow Client 2.3.0.rc1 is available at:
>>>> https://dist.apache.org/repos/dist/dev/airflow/clients/python/2.3.0rc1/
>>>>
>>>> Or also available at PyPI:
>>>> https://pypi.org/project/apache-airflow-client/2.3.0rc1/
>>>>
>>>> *airflow-client-2.3.0rc1-source.tar.gz* is a source release that comes
>>>> with INSTALL instructions.
>>>> *airflow-client-2.3.0rc1-bin.tar.gz* is the
>>>> binary Python "sdist" release.
>>>>
>>>> Public keys are available at:
>>>> https://dist.apache.org/repos/dist/release/airflow/KEYS
>>>>
>>>> Only votes from PMC members are binding, but the release manager should
>>>> encourage members of the community to test the release and vote with
>>>> "(non-binding)".
>>>>
>>>> *Changelog*:
>>>>
>>>>
>>>> *Major changes:*None
>>>>
>>>>
>>>> *Major fixes:*None
>>>>
>>>> *New API supported:*
>>>> PATCH /dags | Update DAGs
>>>> GET
>>>> /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/{map_index} |
>>>> Get a mapped task instance
>>>> GET
>>>> /dags/{dag_id}/dagRuns/{dag_run_id}/taskInstances/{task_id}/listMapped |
>>>> List mapped task instances
>>>>
>>>>
>>>> Thanks,
>>>> Sumit Maheshwari
>>>> PMC Apache Airflow
>>>>
>>>>

Reply via email to