oparl / dev-website Goto Github PK

There's several places where default constraints are set in code
to choose which version of the spec is used to generate the required
content. This should be consolidated into a configuration variable
to simplify maintenance.

From the Laravel 5.2 upgrade guide:

When running database seeds, all Eloquent models are now
unguarded by default. Previously a call to Model::unguard()
was required. You can call Model::reguard() at the top of your
DatabaseSeeder class if you would like models to be guarded during seeding.

the format=html-parameter is supposed to only be appended to
the web links of the entities.

When a limit is set to the endpoint api, the next metadata do not pass this limit.

Reproduce:

1. open https://dev.oparl.org/api/endpoints?limit=1&page=2
2. check/open meta.next
3. content of next url is empty

Expected behaviour:
pass limit to meta.next value

Auf https://oparl.org/spezifikation/ zeigt der Link „[Entwurf der Spezifikation kann] online gelesen werden“ nur wieder auf https://oparl.org/spezifikation/ statt auf eine online lesbare Version.
Die Downloadlinks für alle Dateiformate zeigen auf nicht mehr vorhandene Dateien – vermutlich wurde das Schema des Dateinamens geändert?

Kann leider selbst keinen Fix anbieten, ich blicke da nicht durch. Hoffe dieser Hinweis hilft. Wenn nicht einfach schließen :)

It would be helpful to have a little bit more information such as: How is it used? How does it work?

Write a spec content transformation that automatically links
oparl:... (e.g. oparl:Body) text to the corresponding sub-chapter
of the Schema.

The current state of the downloads functionality is confusing and doesn't even display all available options. There are two completely separate places where downloads of the specification can be obtained - in a modal on the live view and on the downloads page - and they don't actually scale to providing different versions of the specification. This should be resolved.

Dependabot couldn't resolve your project's dependencies as it couldn't access composer.

You can provide additional git credentials in your Dependabot dashboard by clicking into the account menu (in the top right) and selecting 'Config variables'. If you use a custom token for the host github.com make sure it has read access to this repo, too.

View the update logs.

While the endpoint updates are already validated when the update happens
it would probably be a nice-to-have feature to get these fancy
green badges on commits to resources/endpoints.yml.

Hints on how to implement that can be found at https://developer.github.com/v3/checks/.

The specification view should provide a facility to switch between specification versions to allow checking when a specific change was introduced. The version switcher should at least provide the following options:

• The latest released version
• The current development version

By default, the latest release should be loaded.

A stretch goal of this issue would be to provide access all released versions.

Provide a swagger.json for the api endpoints. This may even be automatable
by using the json schema of the oparl specification for the /api/oparl-namespace
For all other ones, some form of code/comment-based auto-documentation shall
be implemented to reduce the required documentation effort to a minimum.

https://oparl.org/presse-berichte/ references/includes pictures from wordpress.com via unencrypted HTTP although wordpress.com offers HTTPS.

This is clearly not how meetings work.

Should be located at /api/oparl/ and behave in the same "deliver html
over web, json over non-web"-way as the OParl API itself.

[] Upgrade to Laravel 5.5
[] Upgrade to Laravel 5.6

https://dev.oparl.org/api/v1/body?where=system_1&format=html

Schema url is:
https://schema.oparl.org/1.0/Legislativeterm

and should be:
https://schema.oparl.org/1.0/LegislativeTerm

config/oparl.php already has a schema section which is used for
schema asset updating. The same constraint set should also be used
to generate the routes and perform the asset retrieval for
schema.oparl.org

Any generated URL in the demoserver data should end with .invalid as TLD
to ensure that we do not accidentally spread actually existing email addresses
or link to sites we do not want to link to with the demo data.

Illuminate\Support\Collection::lists has been depracted in favor
of pluck. This issue is to make sure we check the code for any
remaining lists calls before we eventually upgrade to Laravel 5.3

Gulp currently utilizes laravel-elixir which is kind of a giant overkill
for what this project actually requires in terms of asset management.

To make assets more maintainable the gulpfile should be converted to not
use elixir anymore. Additionally, this will most likely fix some hard-to-track
deployment issues.

Listing the available endpoints is only actually useful if these
endpoints are reachable. Over time, the endpoint database might accrue
entries that don't work anymore.

This however is easily solvable by regularily pinging the known endpoints
to check whether they still exist and delete them from the database
if not.

This same job queue may additionally be used to (partially) refresh validation
data in the future.

Vgl. http://oparl-dev.labs.meanderingsoul.com/api/v1/organization?where=body%3A2

if the system recognizes, that two individuals requested a validation of the same endpoint, it should just do the validation once and send all those who requested a validation of that endpoint the result.

please be aware that the currently running validation should not be taken into account for this pooling-operation. it could be, that a person requests a validation because of a bug that he fixed. in case the current validation has been started before the bugfix on the endpoint has been deployed, the tester may receive misleading results. we should avoid this.

These OParl filter query parameters are not yet implemented:

• created_since
• created_until
• modified_since
• modified_until

We should find a way to integrate liboparl into the dev-website stack.
This includes providing downloads of latest/stable versions in various
formats (x64-linux compiled tarball, source archives, deb package, etc.)

Integrate OParl/validator into the website. This is depends on #29,
because we can't run the validator without liboparl present.

The validation flow on the website should be as follows:

1. A user enters an endpoint url to be validated and an email
   address at which they want to be notified once validation
   completes.
2. The information is enqueued and eventually processed by
   a validation job
3. The results of the validation are stored for further processing
   and formatted into a neat email for the customer.

web is one of the default attributes of the OParl entities
but not yet implemented in any of this server's entity models.

According to the Laravel 5.2 upgrade guide, timestamps need to be
nullable to remain usable in MySQL >= 5.7.

MySQL Dates

Starting with MySQL 5.7, 0000-00-00 00:00:00 is no longer
considered a valid date, since strict mode is enabled by default.
All timestamp columns should receive a valid default value when
you insert records into your database. You may use the useCurrent
method in your migrations to default the timestamp columns to the
current timestamps, or you may make the timestamps nullable to allow null values:

$table->timestamp('foo')->nullable();

$table->timestamp('foo')->useCurrent();

$table->nullableTimestamps();

Thus, we need to make sure that all timestamps are migrated to
be compatible again.

The downloads for master / OParl 1.1 are not currently updated automatically.

The live version updates are displayed (i.e. the web hook is executed) but the html does not appear to be properly updated. This is especially true for the schema section and might actually be a bug in the https://github.com/OParl/spec Makefile

I'm not sure if it's a bug.

in the OParl api, the id for Landkreis Märkisch-Oderland is an http link.
when I open the system, the id starts with https.

https://dev.oparl.org/api/endpoints

https://ratsinfo-online.net/landkreis-mol-bi/oparl/1.0/system.asp

E.g. https://schema.oparl.org/1.0/Consultation shows the schema for Paper