Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add an admin endpoint for the Digital Planning Application format #2322

Merged

Conversation

jessicamcinchak
Copy link
Member

@jessicamcinchak jessicamcinchak commented Oct 17, 2023

Connecting all the dots finally from schemas definitions ➡️ planx-core passport mapping ➡️ this admin endpoint !

Testing:

Next steps:

  • The new schema borrows from BOPS, which means it might be subject to some of the same timeout errors we've been seeing this past week - let's keep testing this (it'll just be in admin endpoint form, so lower stakes)
  • Once merged to production/staging, let's ensure all recently submitted LDC apps validate successfully! If they don't, what have we missed → fix schema or passport mapping?
  • Properly add example responses to Swagger (needs to happen across formats!)

@github-actions
Copy link

github-actions bot commented Oct 18, 2023

Removed vultr server and associated DNS entries

@jessicamcinchak jessicamcinchak marked this pull request as ready for review October 18, 2023 12:51
@jessicamcinchak jessicamcinchak requested a review from a team October 18, 2023 12:52
Copy link
Contributor

@DafyddLlyr DafyddLlyr left a comment

Choose a reason for hiding this comment

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

Brill! Endpoints work as expected 👌

Properly add example responses to Swagger (needs to happen across formats!)

Yeah I've been wondering about this also! Technically this endpoint's Swagger doc will be a translation of the 18,000 line Digital Planning Schema 👀

Using $ref we could point to an external Swagger doc - https://swagger.io/docs/specification/using-ref/

Maybe we also build and publish a Swagger spec from the JSON schema using something like https://www.npmjs.com/package/@openapi-contrib/json-schema-to-openapi-schema

Or maybe we don't describe our return type explicitly and in the docs write a description which just links to the repo / schema?

@jessicamcinchak jessicamcinchak merged commit 93cf90e into main Oct 19, 2023
10 checks passed
@jessicamcinchak jessicamcinchak deleted the jess/admin-endpoint-digital-planning-application branch October 19, 2023 07:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants