Skip to content

Gundeck internal API swagger#4247

Merged
fisx merged 33 commits intodevelopfrom
gundeck-internal-swagger
Oct 1, 2024
Merged

Gundeck internal API swagger#4247
fisx merged 33 commits intodevelopfrom
gundeck-internal-swagger

Conversation

@pcapriotti
Copy link
Contributor

@pcapriotti pcapriotti commented Sep 18, 2024

https://wearezeta.atlassian.net/browse/WPB-11177

make cr and direct your browser to http://localhost:8080/api-internal/swagger-ui/gundeck.

page

also
loc
8-)) (this is before i added golden test stuff to wire-api)

Checklist

  • Make sure all data types touched here are covered in golden tests
  • To get the correct jsons, run the adjusted golden tests on develop
  • Add a new entry in an appropriate subdirectory of changelog.d
  • Read and follow the PR guidelines
  • Figure out if any config files have to be adjusted because of the new examplePort passed to internalEndpointsSwaggerDocsAPI.

@pcapriotti pcapriotti changed the base branch from develop to WPB-1228-servantify-gundeck-internal-api September 18, 2024 09:49
@zebot zebot added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Sep 18, 2024
Base automatically changed from WPB-1228-servantify-gundeck-internal-api to develop September 18, 2024 13:23
@echoes-hq echoes-hq bot added the echoes: technical-roadmap/technical-debt More specific category, to highlight Technical Debt being tackled. label Sep 18, 2024
@fisx fisx force-pushed the gundeck-internal-swagger branch from 5094de7 to 8a1446a Compare September 18, 2024 15:26
@fisx fisx force-pushed the gundeck-internal-swagger branch from 8a1446a to 768a61a Compare September 26, 2024 15:30
@fisx fisx force-pushed the gundeck-internal-swagger branch from c7d3973 to 188e799 Compare September 27, 2024 15:15
@fisx fisx force-pushed the gundeck-internal-swagger branch from 188e799 to 63c1fd5 Compare September 27, 2024 15:17
@fisx fisx force-pushed the gundeck-internal-swagger branch from 8580e4d to d59106e Compare September 30, 2024 12:47
Some golden tests were missing at a time when we changed serialization
from aeson to schema-profunctor.  In order to make sure this didn't
break anything, you can take the changes in this commit, copy them
into a working-copy based on develop (ideally right this PR), and run
golden tests there.

The only changes are Nothing-fields that schema-profunctor translates
to `"k": null`, whereas aeson (or "Data.Json.Util"?) omits the field
altogether.
@fisx fisx marked this pull request as ready for review September 30, 2024 14:10
@fisx
Copy link
Contributor

fisx commented Sep 30, 2024

in Presence:

        diff:
        [
            {
                "op": "add",
                "path": "/native_aps/sound",
                "value": null
            }
        ]

in Push:

        diff:
        [
            {
                "op": "add",
                "path": "/native_aps/sound",
                "value": null
            }
        ]

@fisx fisx removed the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Sep 30, 2024
@fisx
Copy link
Contributor

fisx commented Sep 30, 2024

i paused this. give it the ok-to-test label again if you think concourse is up to it.

Copy link
Contributor

@fisx fisx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this can ship, but I'd prefer to have a nod from you @pcapriotti?

@fisx fisx added the ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist label Sep 30, 2024
@fisx
Copy link
Contributor

fisx commented Sep 30, 2024

i paused this. give it the ok-to-test label again if you think concourse is up to it.

unpauseed.

@fisx
Copy link
Contributor

fisx commented Oct 1, 2024

i was wrong about the discrepancy with develop (5c76642): the explicit null values were on develop, not our branch, and schema-profunctor omits null values by default.

fixed here: 2b63078

should be ready to be given a last glance now.

Copy link
Contributor Author

@pcapriotti pcapriotti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

echoes: technical-roadmap/technical-debt More specific category, to highlight Technical Debt being tackled. ok-to-test Approved for running tests in CI, overrides not-ok-to-test if both labels exist

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants