| Commit message (Expand) | Author | Age |
|---|
| * | docs: bump the copyright year in the docs•••It's 2019. It's almost 2020, in fact!
Signed-off-by: Daniel Axtens <dja@axtens.net>
Reviewed-by: Stephen Finucane <stephen@that.guru>
| Daniel Axtens | 2019-10-18 |
| * | docs: document snowpatch as an API client•••Snowpatch is one of the few publically visible API clients.
Document it in the clients list.
Signed-off-by: Daniel Axtens <dja@axtens.net>
Reviewed-by: Stephen Finucane <stephen@that.guru>
| Daniel Axtens | 2019-10-18 |
| * | REST: Allow creating, updating, deleting of bundles•••Allow users to create a new bundle, change the name, public flag and
patches of an existing bundle, and delete an existing bundle.
Some small nits with existing tests are resolved.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes: #316
| Stephen Finucane | 2019-10-17 |
| * | Use secrets and fall back to random.SystemRandom for keys•••The random module uses the Mersenne Twister pseudorandom number
generator and is not a cryptographically secure random number
generator[0]. The secrets[1] module is intended for generating
cryptographically strong random numbers, so recommend using that to
generate the secret key. It's new in Python 3, so if it's unavailable
fall back to using the ``os.urandom()`` backed implementation of random.
NOTE(stephenfin): Modified to include change to 'config.yaml'. Also
renamed reno to just stick with hyphens for filenames.
[0] https://docs.python.org/3/library/random.html
[1] https://docs.python.org/3/library/secrets.html
Signed-off-by: Jeremy Cline <jcline@redhat.com>
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Jeremy Cline | 2019-10-17 |
| * | docs: Rename and make 'generate_schema' executable•••A small Python 3 issue is resolved.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-10-05 |
| * | docs: Add documentation for pre-commit•••Explain what it is and why you should use it.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-09-27 |
| * | Update sphinxcontrib-openapi from 0.4.0 to 0.5.0 | pyup-bot | 2019-09-09 |
| * | docs: Use '>=' in OpenAPI schema template•••This is consistent with how we're doing checks for v1.2 and reads a
little better, IMO.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-09-09 |
| * | Drop support for Python 3.4, add Python 3.7•••It's no longer supported upstream and the *second* last Ubuntu LTS
release provides something newer. Time to move on.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-09-08 |
| * | models: Add commit_url_format to Project•••Add a new field to Project, commit_url_format, which specifies a
format string that can be used to generate a link to a particular
commit for a project.
This is used in the display of a patch, to render the patch's commit
as a clickable link back to the commit on the SCM website.
Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
Signed-off-by: Daniel Axtens <dja@axtens.net>
| Michael Ellerman | 2019-08-30 |
| * | docs: Add API v1.2•••Add API v1.2, including the new fields for list archive URLs.
Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Signed-off-by: Daniel Axtens <dja@axtens.net>
| Andrew Donnellan | 2019-08-22 |
| * | Add 'dumparchive' management command•••Introduces a new management command which can export all patches in a
project as one mbox file. Export of multiple projects is supported.
Additionally allows to compress the output.
Signed-off-by: Mete Polat <metepolat2000@gmail.com>
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Mete Polat | 2019-07-19 |
| * | docs: Rework configuration document•••- Remove some newlines between terms and definitions that were causing
the latter to be rendered as blockquotes instead
- Order list of settings alphabetically
- Update URLs to use latest version of Django we support
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-07-06 |
| * | about: Display admin contact details•••Display the list of admins on the about page. Add an ADMINS_HIDE option if
you don't want the details displayed publicly.
Closes: #282 ("Display contact details for patchwork instance admins")
Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Andrew Donnellan | 2019-07-05 |
| * | Remove pwclient•••Let's start managing this via a separate project, which will allow the
client to evolve separately from the server. No redirect is added for
the old '/pwclient' URL as it seems wiser to return a HTTP 404 error
code.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-06-17 |
| * | docs: Document backport criteria•••Explain why we don't want to be in the business of backport certain
patches, in the long run. It took me a while to put this into words but
I was helped by a similar discussion ongoing in the OpenStack community
at the moment [1].
[1] http://lists.openstack.org/pipermail/openstack-discuss/2019-May/006220.html
Signed-off-by: Stephen Finucane <stephen@that.guru>
Acked-by: Daniel Axtens <dja@axtens.net>
| Stephen Finucane | 2019-05-24 |
| * | docs: Mention Postgres for Docker development install•••Might as well since it's there, and it gives some clue to anyone trying
to use Docker on non-x86. I figured it was best to leave this out of
the README since it's incredibly niche.
Signed-off-by: Russell Currey <ruscur@russell.cc>
Reviewed-by: Andrew Donnellan <andrew.donnellan@au1.ibm.com>
Signed-off-by: Daniel Axtens <dja@axtens.net>
| Russell Currey | 2019-05-03 |
| * | REST: A check must specify a state•••The Ozlabs crew noticed that a check without a state caused a
KeyError in data['state']. Mark state as mandatory, check for
it, and add a test.
Reported-by: Russell Currey <ruscur@russell.cc>
Reported-by: Jeremy Kerr <jk@ozlabs.org>
Signed-off-by: Daniel Axtens <dja@axtens.net>
| Daniel Axtens | 2019-04-30 |
| * | Update jinja2 from 2.10 to 2.10.1 | pyup-bot | 2019-04-07 |
| * | Update sphinx_rtd_theme from 0.4.2 to 0.4.3 | pyup-bot | 2019-03-12 |
| * | docs: Fix user's profile url•••Signed-off-by: Ali Alnubani <alialnu@mellanox.com>
Reviewed-by: Stephen Finucane <stephen@that.guru>
| Ali Alnubani | 2019-02-25 |
| * | docs: Integrate API schema into docs•••This takes advantage of the sphinxcontrib-openapi Sphinx extension,
which allows us to embed the REST API documentation into our docs quite
nicely.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-01-29 |
| * | docs: Move REST API guide to subfolder•••We're going to dramatically expand these docs, so let's set up room to
do so.
This shouldn't break any links as we're using 'htmldir' output on
ReadTheDocs.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-01-29 |
| * | docs: Remove crud from conf.py•••Most of this was removed in a previous release but there is yet more to
go. These values are all (a) defaults or (b) never triggered. Remove
them.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2019-01-29 |
| * | docs: Detail JSON PATCH requests•••It turns out it is possible to make PATCH requests with JSON bodies
rather than form-encoded data - you just need to include a Content-Type
header. Document this.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-25 |
| * | docs: Reformat schemas•••Tested using 'yamllint'.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-24 |
| * | docs: Add parameter descriptions, types•••Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-24 |
| * | docs: Move 'parameter.schema.description' to 'parameter'•••As noted in a bug against the spec [1], there is some duplication here.
Go with the more obvious path until that confusion is cleared up.
[1] https://github.com/OAI/OpenAPI-Specification/issues/1788
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-24 |
| * | Pin jinja2 to latest version 2.10 | pyup-bot | 2018-12-22 |
| * | docs: Remove old Swagger 2.0 spec•••This was incomplete and wrong in many places. It's since been replaced
by the OpenAPI 3.0.0 specs, so we have happily remove this now.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Store versioned OpenAPI schemas•••Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Make API document versioned•••OpenAPI doesn't appear to support versioning natively, suggesting
instead that separate documents are kept. Rather than doing this
manually, let's use a templating tool - Jinja2, in this case - to
generate these document for us from a single master document.
Note that while we can now auto-generate these whenever we need them
(and we tend to avoid storing auto-generated assets in VCS), these
change so rarely that it's easier to just store them. This also means we
can reference the schemas themselves online. We do this in a following
change.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/events' resource•••This is the final resource to document and also the most complicated, on
account of the polymorphism of the responses. However, with this done,
our first pass at an OpenAPI 3.0 schema is completed.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/patches/{patch_id}/checks' resource•••Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/patch/{id}/comments' resource•••Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/covers/{id}/comments' resource•••Our first nested resource. Nothing too weird here though, save for the
raising of a HTTP 404 on a list resource (due to a missing patch).
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/series' resource•••Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/patches' resource•••The big one (TM). Nothing too odd here though.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/covers' resource•••Again, we're adding embedded serializers before the main resource but
that will come.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/bundles' resource•••This one's a little unusual too, in that we provide the embedded
serializer for resources we haven't defined the end resource for. That's
necessary in general, due to recursive references in the API
(series-patch, patch-series etc.) so might as well embrace it early.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/projects' resource•••This one's pretty straightforward.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/people' resource•••This introduces our first use of embedded serializers, which are
separate models from the main ones. Other than that, this is pretty
standard.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Document the '/users' resource•••This introduces our first use of parameters, both in the path and the
query. The latter are extracted out as they'll be used by later changes.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Start documenting API using OpenAPI•••When the REST API was first added, we attempted to document it using
OpenAPI 2.0 (formerly Swagger). This was mostly never completed because
(a) it was really tedious and (b) no one was that bothered. However, as
we expand the range of clients for the REST API, having a well
documented API becomes more and more of an asset.
Start doing this by adding a brand new schema, this time using OpenAPI.
This will entirely replace the older schema and, as such, is namespaced
separately. We start by documenting '/' (i.e. the index) page and will
add additional resources as we go.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-12-22 |
| * | docs: Fix design doc•••These items weren't really headers and shouldn't have been rendered as
such.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-10-30 |
| * | docs: Add documentation for django-dbbackup•••This replaces the older manual backup steps. The section on
'django-debug-toolbar' is updated to match the new 'django-dbbackup'
section.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-10-10 |
| * | doc: Cleanup development installation guide•••Use literals where possible, don't leave a space between a term and
definition, and note that Python 3.4, not 3.3, is now the minimum
supported version of Python 3.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-10-10 |
| * | docs: Add 'unreleased' to release notes index page•••It's already on the main index page.
Signed-off-by: Stephen Finucane <stephen@that.guru>
| Stephen Finucane | 2018-10-06 |
| * | Update sphinx_rtd_theme from 0.3.0 to 0.4.2 | pyup-bot | 2018-10-06 |
| * | docs: Note new requirement to include a SPDX line•••Add some wording around the requirement to include this line instead of
the license header. Also note the requirement that all code be licensed
using the 'GPL-2.0-or-later' license and add a CONTRIBUTING document,
which GitHub likes.
Signed-off-by: Stephen Finucane <stephen@that.guru>
Reviewed-by: Veronika Kabatova <vkabatov@redhat.com>
| Stephen Finucane | 2018-09-19 |