Application service spec cleanup; Security definitions; r0 prep #1555

turt2live · 2018-08-24T17:42:18Z

Rendered: see 'docs' status check

This may be best to review commit by commit.

This is a PR for the few small tasks that need to be completed before an r0 can be cut:

Support the changelog framework
Support the version strings (currently set to unstable)
Tidy up empty sections of the RST
Add security definitions to the hs->as endpoints

Blocked on:

ara4n · 2018-08-27T23:28:04Z

api/application-service/protocols.yaml

@@ -254,6 +191,8 @@ paths:
        Retreive an array of third party network locations from a Matrix room


ara4n · 2018-08-27T23:28:10Z

api/application-service/protocols.yaml

@@ -298,6 +237,8 @@ paths:
      description: |-
        Retreive an array of third party users from a Matrix User ID.


ara4n · 2018-08-27T23:40:15Z

lgtm (modulo feedback in dependent PRs being solved)

This commit has approval under matrix-org#1555 although is being included in this branch/PR so the build passes, permitting a merge.

This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.

Half-Shot

A few things I'm unsure about, but it's mostly fine.

changelogs/application_service/pyproject.toml

api/application-service/definitions/security.yaml

specification/application_service_api.rst

Half-Shot · 2018-08-30T15:25:10Z

specification/application_service_api.rst

@@ -377,8 +392,6 @@ additional parameters on the ``/publicRooms`` client-server endpoint.
 Event fields
 ~~~~~~~~~~~~

-.. TODO-TravisR: Fix this section to be a general "3rd party networks" section
-
 We recommend that any events that originated from a remote network should
 include an ``external_url`` field in their content to provide a way for Matrix
 clients to link into the 'native' client from which the event originated.


Do we want to mention that client's using these should warn about them. From all the other issues raised in the spec, it looks like we are going for cautious?

Oh, and do we have a suggested format?

Would be good to clarify this section, yea. Will do that in a dedicated PR.

Edit: #1624

Half-Shot · 2018-08-30T15:26:19Z

specification/application_service_api.rst

 Application Services
 --------------------
 Application services are passive and can only observe events from a given
-homeserver (HS). They can inject events into rooms they are participating in.


"from a given homeserver (HS)" I'm worried this might confuse people to believe appservices only work against events originating from one homeserver?

sounds like we just need to remove "given"?

Half-Shot

Just the external_uri and then you can merge :)

turt2live · 2018-08-30T17:08:07Z

(reminded out of band that this is not an r0, just the prep for it - an r0 is a whole thing)

turt2live added the blocked Something needs to be done before action can be taken on this PR/issue. label Aug 24, 2018

ara4n reviewed Aug 27, 2018

View reviewed changes

turt2live added 4 commits August 27, 2018 18:04

Prepare the appservice spec for an r0 release

fa96d86

This puts the scaffolding in place for an r0 release to happen, such as the changelog and version variables.

Add security definitions to hs->as endpoints

f01cfa2

Misc. cleanup of the appservice spec

07153c2

Include the "other versions" section of the changelog

6f80db5

turt2live force-pushed the travis/as/cleanup branch from 63d67ff to 6f80db5 Compare August 28, 2018 00:04

turt2live requested a review from a team August 28, 2018 00:05

turt2live removed the blocked Something needs to be done before action can be taken on this PR/issue. label Aug 28, 2018

turt2live mentioned this pull request Aug 29, 2018

r0 for the Application Services API #1333

Closed

11 tasks

turt2live added 2 commits August 29, 2018 21:28

Merge remote matrix-org/master

a5c3924

Don't define a variable for the appservice major version

b209292

Half-Shot requested changes Aug 30, 2018

View reviewed changes

turt2live removed the request for review from a team August 30, 2018 16:16

Don't accidentally limit application services to one homeserver

05b0172

turt2live requested a review from Half-Shot August 30, 2018 16:23

Half-Shot approved these changes Aug 30, 2018

View reviewed changes

turt2live merged commit 0f2e01f into matrix-org:master Aug 30, 2018

turt2live deleted the travis/as/cleanup branch August 30, 2018 17:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Application service spec cleanup; Security definitions; r0 prep #1555

Application service spec cleanup; Security definitions; r0 prep #1555

turt2live commented Aug 24, 2018 •

edited

Loading

ara4n Aug 27, 2018

ara4n Aug 27, 2018

ara4n commented Aug 27, 2018

Half-Shot left a comment

Half-Shot Aug 30, 2018

Half-Shot Aug 30, 2018

turt2live Aug 30, 2018 •

edited

Loading

Half-Shot Aug 30, 2018

turt2live Aug 30, 2018

Half-Shot left a comment

turt2live commented Aug 30, 2018

		@@ -254,6 +191,8 @@ paths:
		Retreive an array of third party network locations from a Matrix room

		@@ -298,6 +237,8 @@ paths:
		description: \|-
		Retreive an array of third party users from a Matrix User ID.

Application service spec cleanup; Security definitions; r0 prep #1555

Application service spec cleanup; Security definitions; r0 prep #1555

Conversation

turt2live commented Aug 24, 2018 • edited Loading

ara4n Aug 27, 2018

Choose a reason for hiding this comment

ara4n Aug 27, 2018

Choose a reason for hiding this comment

ara4n commented Aug 27, 2018

Half-Shot left a comment

Choose a reason for hiding this comment

Half-Shot Aug 30, 2018

Choose a reason for hiding this comment

Half-Shot Aug 30, 2018

Choose a reason for hiding this comment

turt2live Aug 30, 2018 • edited Loading

Choose a reason for hiding this comment

Half-Shot Aug 30, 2018

Choose a reason for hiding this comment

turt2live Aug 30, 2018

Choose a reason for hiding this comment

Half-Shot left a comment

Choose a reason for hiding this comment

turt2live commented Aug 30, 2018

turt2live commented Aug 24, 2018 •

edited

Loading

turt2live Aug 30, 2018 •

edited

Loading